Skip to content

Commit 56e86e8

Browse files
authored
Update installation instructions in README.md
1 parent 4931d4d commit 56e86e8

1 file changed

Lines changed: 40 additions & 5 deletions

File tree

README.md

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,54 @@ See the [MHKiT documentation](https://mhkit-software.github.io/MHKiT) for more i
3232

3333
## Installation
3434

35-
MHKiT-Python requires Python (3.10, 3.11, 3.12) along with several Python
36-
package dependencies. MHKiT-Python can be installed using the Conda package manager:
35+
[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.
39+
MHKiT can be installed several ways:
40+
41+
### Option 1: Install from Python
42+
43+
This option is recommended as a fast installation for MHKiT-Python users.
44+
To install MHKiT-Python using ``conda``, in an Anaconda Prompt:
45+
46+
```bash
47+
conda install -c conda-forge mhkit
48+
```
49+
50+
### Option 2: Clone Repository from GitHub
51+
52+
This option is recommended for MHKiT-Python users who want access to example notebooks and developers.
53+
Download and install your preferred version of [git](https://git-scm.com/).
54+
To clone MHKiT-Python:
3755

3856
```bash
39-
conda install -c conda-forge mhkit
57+
git clone https://github.com/MHKiT-Software/MHKiT-Python
58+
cd MHKiT-Python
4059
```
4160

42-
MHKiT can alternatively be installed from PyPi using pip:
61+
To install a local, editable version of MHKiT-Python using [pip](https://pip.pypa.io/en/stable/):
4362

4463
```bash
45-
pip install mhkit
64+
pip install -e .["all"]
4665
```
4766

67+
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.
68+
MHKiT can then be installed into that environment using any of the provided methods.
69+
70+
### Option 3: Module-specific Install from Python
71+
72+
A slim version of MHKiT-Python can be installed to reduce the number of dependencies and potential conflicts with other software.
73+
This installation utilizes pip's optional dependencies installation.
74+
To install a single MHKiT module, e.g. the wave module, and its dependencies, use:
75+
76+
pip install mhkit["wave"]
77+
78+
Note that ``pip install mhkit`` only installs the base MHKiT dependencies and not the entire software.
79+
To install all MHKiT dependencies use:
80+
81+
pip install mhkit["all"]
82+
4883
See [installation instructions](https://mhkit-software.github.io/MHKiT/installation.html) for more information.
4984

5085
## Copyright and license

0 commit comments

Comments
 (0)