Skip to content

Commit 0f2d577

Browse files
committed
Docs: Leverage sections to separate installation options.
1 parent fd65176 commit 0f2d577

1 file changed

Lines changed: 27 additions & 10 deletions

File tree

README.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,17 @@ See the [MHKiT documentation](https://mhkit-software.github.io/MHKiT) for more i
3333
## Installation
3434

3535
[MHKiT-Python](https://github.com/MHKiT-Software/MHKiT-Python) requires [Python (3.10-3.12)](https://www.python.org/).
36-
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.
3936

40-
MHKiT can be installed several ways:
37+
<details>
38+
39+
<summary>Option 1: Install with Anaconda/Miniconda (Recommended)</summary>
4140

4241
### Option 1: Install With Anaconda/Miniconda
4342

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+
4447
This option is recommended for most MHKiT-Python users.
4548
To install MHKiT-Python using `conda`, in an Anaconda Prompt:
4649

@@ -56,19 +59,19 @@ conda activate mhkit-env
5659
conda install -c conda-forge mhkit
5760
```
5861

59-
Optional: Installing dependencies to run mhkit examples and development dependencies:
60-
61-
```bash
62-
pip install mhkit["examples"]
63-
```
64-
6562
Note: To use the above installed version of MHKiT-Python users must activate the `mhkit-env` environment each time, using `conda activate
6663
mhkit-env` in each new shell/terminal to use MHKiT.
6764
To avoid this, users can install MHKiT into their base conda environment, but this is not
6865
recommended as it may cause dependency conflicts with other software.
6966

7067
Visual Studio Code has [instructions for using Python environments in VS Code](https://code.visualstudio.com/docs/python/environments) that support conda environment discovery.
7168

69+
</details>
70+
71+
<details>
72+
73+
<summary>Option 2: Clone Repository from GitHub</summary>
74+
7275
### Option 2: Clone Repository from GitHub
7376

7477
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"]
143146
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.
144147
MHKiT can then be installed into that environment using any of the provided methods.
145148

149+
</details>
150+
151+
<details>
152+
153+
<summary>Option 3: Module-specific Install from Python</summary>
154+
146155
### Option 3: Module-specific Install from Python
147156

148157
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"]
184193

185194
See [installation instructions](https://mhkit-software.github.io/MHKiT/installation.html) for more information.
186195

196+
</details>
197+
198+
<details>
199+
200+
<summary>Development Installation</summary>
201+
187202
### Development Installation
188203

189204
For developers contributing to MHKiT, there are three development installation strategies after
@@ -226,6 +241,8 @@ pip install -e ".[all,dev]" --no-deps
226241

227242
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.
228243

244+
</details>
245+
229246
## Copyright and license
230247

231248
MHKiT-Python is copyright through the National Laboratory of the Rockies,

0 commit comments

Comments
 (0)