Python 3.7 or 3.8 64-bit. (Note: Python 2.7 and Python 3.9 are not supported.)
Additional requirements are listed in requirements.txt and can be installed with the following command:
pip install -r requirements.txt
We also recommend, but do not require, installing RSVsim in a virtual environment. For more information, see documentation for e.g. Anaconda.
Clone a copy of the repository. If you intend to make changes to the code, we recommend that you fork it first.
(Optional) Create and activate a virtual environment.
Navigate to the root of the repository and install the RSVsim Python package using one of the following options:
For normal installation (recommended):
pip install -e .
To install RSVsim and optional dependencies (be aware this may fail since it relies on nonstandard packages):
pip install -e .[full]
The module should then be importable via
import rsvsim as rsv.