Setting up RidePy
This section explains how to set up RidePy on your machine in various ways.
Prerequisites
Currently, using Python 3.9 is your best option.
In addition, you should probably use a Python environment for keeping things clean. The following commands should work for Linux and macOS. On Windows, things might have to be done marginally different.
We recommend using either Anaconda (which has the added benefit of being able to handle different Python versions):
conda create -n ridepy python=3.9
conda activate ridepy
or simply venv from the Python standard library (assuming you are already on Python 3.9, alternatively you can additionally use pyenv for managing Python versions):
python -m venv <venv directory path of choice>
source <venv directory path of choice>/bin/activate
Finally, it may be necessary that you build the Cython/C++ part from source. If you are on a supported platform (currently only x86-64 Linux) and install RidePy via pip from the PyPI repository, this step can be skipped. Otherwise, you will need a C++ build environment and the Boost C++ libraries.
On Debian-based Linux distributions such as Debian, Debian, and Linux Mint, both of these can be installed as follows:
sudo apt update && sudo apt -y install build-essential libboost-all-dev
Installation
User Installation
Just run
pip install ridepy
and you’re set. If this step fails, you may have to install the C++ build environment and the Boost libraries beforehand as described in the prerequisites.
Alternatively, if you prefer, you can also clone the git repository (for which you need git) and install any version from the repository:
git clone --recurse-submodules https://github.com/PhysicsOfMobility/ridepy.git
cd ridepy
pip install -e .
Note: This will strictly only work if you have the C++ build environment and the Boost libraries installed, see the prerequisites.
Developer Installation
Note that the editable install (-e flag) does only serve its purpose when editing the Python components. For changes to the Cython/C++ components to come into effect, the pip install command has to be executed again to build the Cython/C++.
git clone --recurse-submodules https://github.com/PhysicsOfMobility/ridepy.git
cd ridepy
pip install -e ".[dev,doc]"
pre-commit install
To build the documentation to doc/_build/html, additionally execute the following command:
sphinx-build -j3 -b html doc doc/_build/html
After the build has finished, you can open doc/_build/html/index.html in a your web browser choice to read the documentation.
Testing the installation
To check whether the installation was successful, you may run the automated test suite, which should report no errors:
pytest
In addition, you can also play around with the tutorial notebooks. Click here for documentation on how to run them.
Updating the installation
User installation
New PyPI versions of RidePy (after installation using pip install ridepy) can be fetched using
pip install -U ridepy
If you have installed RidePy manually using from git repository, you need to pull the latest version and pip-install the new version:
git pull
pip install -e .
Developer installation
Pull the latest version and pip-install the new version:
git pull
pip install -e ".[dev,doc]"
pre-commit install
To update the documentation, additionally execute the following command:
sphinx-build -j3 -b html doc doc/_build/html