Skip to content

Commit 1608aa8

Browse files
committed
Dev: Add mhkit-python install to installation instructions
1 parent e4d3c56 commit 1608aa8

1 file changed

Lines changed: 42 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,21 +52,57 @@ conda create -n mhkit-matlab-dev python=311.
5252
conda activate mhkit-matlab-dev
5353
```
5454

55-
3. **Install Python dependencies**:
55+
3. Install MHKiT-Python:
5656

57-
Install mhkit-python-utils from source
57+
Note: Developers should be careful to install the correct version of MHKiT-Python. The context of
58+
correct version depends on the specific task you are working on. For development against the release
59+
version of MHKiT-MATLAB, install the latest stable release of MHKiT-Python from conda-forge:
60+
61+
```bash
62+
conda install -c conda-forge mhkit
63+
```
64+
65+
To install the latest development version of MHKiT-Python from source, clone the MHKiT-Python
66+
repository:
67+
68+
```bash
69+
git clone https://github.com/MHKiT-Software/MHKiT-Python.git
70+
```
71+
72+
Optional, checkout the develop branch:
73+
74+
```bash
75+
git checkout develop
76+
```
77+
78+
Install MHKiT-Python in from source:
79+
80+
```bash
81+
pip install -e .
82+
```
83+
84+
Verify MHKiT-Python installation:
85+
86+
```bash
87+
python -c "import mhkit; print(mhkit.__version__)"
88+
```
89+
90+
4. Install mhkit-python-utils from source
91+
92+
Note: mhkit-python-utils is a required dependency for MHKiT-MATLAB. This python code handles any
93+
MATLAB-Python interoperability functionality specific for MHKiT-MATLAB.
5894

5995
```bash
6096
pip install -e .
6197
```
6298

63-
4. Determine the path to the Python executable in your conda environment:
99+
5. Determine the path to the Python executable in your conda environment:
64100

65101
```bash
66102
python -c "import sys; print(sys.executable)"
67103
```
68104

69-
4. Add the mhkit conda environment to MATLAB:
105+
6. Add the mhkit conda environment to MATLAB:
70106

71107
In the MATLAB command window, run:
72108

@@ -76,13 +112,13 @@ pyenv(Version="<python executable location from above>")
76112

77113
Restart MATLAB
78114

79-
5. **Add to MHKiT-MATLAB mhkit and examples folder to the MATLAB path**:
115+
7. **Add to MHKiT-MATLAB mhkit and examples folder to the MATLAB path**:
80116

81117
```matlab
82118
addpath(genpath('path/to/MHKiT-MATLAB/mhkit'))
83119
```
84120

85-
If you encounter issues with Python integration, please sumbit an issue.
121+
If you encounter issues with Python integration, please [submit an issue](https://github.com/MHKiT-Software/MHKiT-MATLAB/issues/new).
86122

87123
## Development Workflow
88124

0 commit comments

Comments
 (0)