Skip to content

Commit 600c980

Browse files
committed
Docs: Clarify pip module install
1 parent dbc8933 commit 600c980

1 file changed

Lines changed: 19 additions & 3 deletions

File tree

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,9 +168,25 @@ To install a single MHKiT module, e.g. the wave module, and its dependencies, us
168168
pip install mhkit["wave"]
169169
```
170170

171-
Note that `pip install mhkit` does not install any MHKiT dependencies, so users must specify which
172-
module(s) they want to install with the optional dependencies installation syntax, `pip install
173-
mhkit "[<module>]"` or multiple modules with `pip install mhkit "[<module>,<module>]"`.
171+
To install all MHKiT modules use:
172+
173+
```bash
174+
pip install mhkit["all"]
175+
```
176+
177+
Note: `pip install mhkit` does not install any MHKiT dependencies and will not work without installing dependencies separately.
178+
179+
To install specific modules users must specify which module(s) they want to install with the optional dependencies installation syntax:
180+
181+
```bash
182+
pip install mhkit "[<module>]"
183+
```
184+
185+
Or multiple modules with:
186+
187+
```bash
188+
pip install mhkit "[<module>,<module>]"
189+
```
174190

175191
Supported modules are:
176192

0 commit comments

Comments
 (0)