Installation¶
The following section includes installation instructions for MHKiT-Python and MHKiT-MATLAB.
MHKiT-Python¶
MHKiT-Python requires Python (3.6 or 3.7) and has several Python package dependencies. It is recommended to use the Anaconda Python Distribution to install Python since it includes most of MHKiT-Python’s package dependencies. Refer to the Python website for information on using Python.
Note
The installation of Anaconda3 no longer adds python to the Windows Environment Variables by default. During installation, there is a checkbox in the advanced options of the installation to add it to the system path. The installation wizard advises against doing so in case a user has multiple python installations. Either check this box or setup your environmental variables so that python is accessible through your system path.
Click here for more information.
Requirements¶
MHKiT-Python requires Python (3.6 or 3.7) and has the following Python packages dependencies:
Pandas: used for data storage and analysis
NumPy: used for data storage and analysis
SciPy: used for numerical methods, statistics, and signal processing
Matplotlib: used to produce figures
Requests: used to get data from websites
Pecos v0.1.8: used for quality control analysis
It is recommended to use the Anaconda Python Distribution because it includes all of the MHKiT-Python package dependencies except Pecos.
Option 1: PIP Install from Python¶
This option is recommended for MHKiT-Python users. To install MHKiT-Python using pip:
pip install mhkit
Using this option to install MHKiT-Python will automatically install Pecos.
Option 2: Clone Repository from GitHub¶
This option is recommended for MHKiT-Python developers. To install MHKiT-Python using git:
git clone https://github.com/MHKiT-Software/MHKiT-Python
cd mhkit-python
pip install -e .
Using this option to install MHKiT-Python will require following the Pecos installation instructions to install the Pecos package dependency.
Note
If you plan to contribute to the MHKiT-Python open-source software, please fork the MHKiT-Python repository into your GitHub user account. To include your additions to the MHKiT-Python code, please submit a pull request in the MHKiT-Python master branch. Once reviewed by the MHKiT-Python development team, pull requests will be merged into MHKiT-Python and included in future releases of MHKiT-Python.
Test MHKiT-Python installation¶
To test that MHKiT-Python is installed correctly, open a Python console and run:
import mhkit
If MHKiT-Python is installed properly, Python proceeds to the next line and no other output is printed to the screen. If MHKiT-Python is not installed properly, the user will see the following error:
ImportError: No module named mhkit
To test a simple function using MHKiT-Python, the user can compute the equivalent diameter (ED) and projected capture area (AP) of a circular turbine by running the following code:
[ED, AP] = mhkit.river.device.circular(30)
The results should be:
ED = 30
AP = 11309.7
MHKiT-MATLAB¶
MHKiT-MATLAB requires MATLAB 2019b or later and relies on three components which need to be installed separately.
First, MHKiT-MATLAB consists of MATLAB code which runs the MHKiT-Python functions. Therefore, the installation of both packages is necessary. See the MHKit-Python installation instructions above.
Second, the mhkit.mltbx, which contains the MHKiT-Matlab functions, needs to be downloaded and installed. Instructions for installation and setting up the Matlab/Python environment are below.
Lastly, MHKiT-MATLAB utilizes a helper package called mhkit_python_utils. Installation instructions are below.
MHKiT-MATLAB Installation¶
Clone or download the MHKiT-MATLAB repo from https://github.com/MHKiT-Software/MHKiT-MATLAB. In MATLAB, navigate to the folder where you downloaded or cloned the repo which contains mhkit.mltbx, double-click mhkit.mltbx, and the toolbox will install automatically.
If you would like to contribute to MHKiT-MATLAB, you can fork the MHKiT-MATLAB repository from https://github.com/MHKiT-Software/MHKiT-MATLAB and submit a pull request for review.
Set up the MATLAB Environment¶
Open MATLAB and in the terminal type:
pyversion
You should see something similar to the following:
version: '3.7'
executable: '/Library/Frameworks/Python.framework/Versions/3.7/bin/python3'
library: '/Library/Frameworks/Python.framework/Versions/3.7/lib/libpython3.7m.dylib'
home: '/Library/Frameworks/Python.framework/Versions/3.7'
isloaded: 1
If the resulting Python version is 3.6 or 3.7, skip to the Test the Installation section. If the resulting Python version is not 3.6, or 3.7 open a Window or Mac terminal window and type:
python3 -c "import sys; print(sys.executable)"
If the resulting path to the python executable (path_to_exe) indicates Python 3.6, or 3.7, copy the path and in the MATLAB terminal run:
pyversion('<path_to_exe>')
Note: Mac computers come with Python 2.7 pre-installed. MHKiT does not work with Python 2.7. A second version of Python (3.6, or 3.7) will need to be installed on your machine. DO NOT DELETE Python 2.7. Use the above steps to make sure MATLAB is running the proper version of Python.
mhkit_python_utils package¶
mhkit_python_utils is a helper package for running MHKiT-MATLAB. From within your cloned or downloaded MHKiT-Matlab folder run setup.py on your machine by running:
pip3 install -e .
Test MHKiT-MATLAB Installation¶
To test that your install of MHKiT worked correctly, run the following in your MATLAB terminal:
[x,y]=circular(30)
The results should be:
x = 30
y = 1.1310e+04