You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It is recommended to use the [Anaconda Python Distribution](https://www.anaconda.com/distribution/) (a fully featured Python installer with a GUI)
37
-
or [Miniconda](https://docs.anaconda.com/miniconda/#quick-command-line-install) (a lightweight installer with the `conda` command line utility).
38
-
Both will include most of MHKiT-Python's package dependencies.
39
36
40
-
MHKiT can be installed several ways:
37
+
<details>
38
+
39
+
<summary>Option 1: Install with Anaconda/Miniconda (Recommended)</summary>
41
40
42
41
### Option 1: Install With Anaconda/Miniconda
43
42
43
+
It is recommended to use the [Anaconda Python Distribution](https://www.anaconda.com/distribution/) (a fully featured Python installer with a GUI)
44
+
or [Miniconda](https://docs.anaconda.com/miniconda/#quick-command-line-install) (a lightweight installer with the `conda` command line utility).
45
+
Both will include most of MHKiT-Python's package dependencies.
46
+
44
47
This option is recommended for most MHKiT-Python users.
45
48
To install MHKiT-Python using `conda`, in an Anaconda Prompt:
46
49
@@ -56,19 +59,19 @@ conda activate mhkit-env
56
59
conda install -c conda-forge mhkit
57
60
```
58
61
59
-
Optional: Installing dependencies to run mhkit examples and development dependencies:
60
-
61
-
```bash
62
-
pip install mhkit["examples"]
63
-
```
64
-
65
62
Note: To use the above installed version of MHKiT-Python users must activate the `mhkit-env` environment each time, using `conda activate
66
63
mhkit-env` in each new shell/terminal to use MHKiT.
67
64
To avoid this, users can install MHKiT into their base conda environment, but this is not
68
65
recommended as it may cause dependency conflicts with other software.
69
66
70
67
Visual Studio Code has [instructions for using Python environments in VS Code](https://code.visualstudio.com/docs/python/environments) that support conda environment discovery.
71
68
69
+
</details>
70
+
71
+
<details>
72
+
73
+
<summary>Option 2: Clone Repository from GitHub</summary>
74
+
72
75
### Option 2: Clone Repository from GitHub
73
76
74
77
This option is recommended for MHKiT-Python users who want access to example notebooks and developers.
@@ -143,6 +146,12 @@ pip install -e .["all,dev"]
143
146
An [environment YAML file](https://github.com/MHKiT-Software/MHKiT-Python/blob/main/environment.yml) is also provided that can create the base environment required by MHKiT.
144
147
MHKiT can then be installed into that environment using any of the provided methods.
145
148
149
+
</details>
150
+
151
+
<details>
152
+
153
+
<summary>Option 3: Module-specific Install from Python</summary>
154
+
146
155
### Option 3: Module-specific Install from Python
147
156
148
157
A slim version of MHKiT-Python can be installed to reduce the number of dependencies and potential conflicts with other software.
@@ -184,6 +193,12 @@ pip install mhkit["all"]
184
193
185
194
See [installation instructions](https://mhkit-software.github.io/MHKiT/installation.html) for more information.
186
195
196
+
</details>
197
+
198
+
<details>
199
+
200
+
<summary>Development Installation</summary>
201
+
187
202
### Development Installation
188
203
189
204
For developers contributing to MHKiT, there are three development installation strategies after
The conda-forge option mirrors how users install MHKiT via `conda install -c conda-forge mhkit`, ensuring all dependencies come from the conda-forge channel. The `--no-deps` flag prevents pip from resolving dependencies, relying entirely on the conda-forge packages for dependencies. The conda-forge build and deployment happens in separate repository: [https://github.com/conda-forge/mhkit-feedstock] which is updated with each MHKiT release.
228
243
244
+
</details>
245
+
229
246
## Copyright and license
230
247
231
248
MHKiT-Python is copyright through the National Laboratory of the Rockies,
0 commit comments