Installation
The following instructions will allow you to install PyIRI.
Prerequisites
PyIRI uses the Python modules included in the list below. This module officially supports Python 3.9+.
fortranformat
matplotlib
numpy
Installation Options
1. Clone the git repository
git clone https://github.com/victoriyaforsythe/PyIRI.git
Install PyIRI: Change directories into the repository folder and build the project. There are a few ways you can do this:
Install on the system (root privileges required):
sudo pip install .
Install at the user level:
pip install --user .
Install with the intent to change the code:
pip install --user -e .
Optional Requirements
To run the test suite and build the documentation locally, you also need the following Python packages.
Attention
This module has the following additional requirements:
coveralls<3.3 flake8 flake8-docstrings hacking>=1.0
These can be installed as follows:
python -m pip install PyIRI[test]
Attention
This module has the following additional requirements:
extras-require ipython m2r2 numpydoc sphinx sphinx-rtd-theme>=1.2.2
These can be installed as follows:
python -m pip install PyIRI[doc]