Installation#

If you already have Python, you can install AHRS with:

pip install ahrs

This will download and install the latest stable release of ahrs available in the Python Package Index.

AHRS works with Python 3.6 or later, and depends on NumPy. Intalling with pip will automatically download it if it’s not present in your workspace.

A second, and more recommended, option is to download the latest available version in the git repository and install it manually:

git clone https://github.com/Mayitzin/ahrs.git
cd ahrs/
python setup.py install

This will get you the latest changes of the package, so you can get an updated version.

Building the Documentation#

To build this documentation you first need to have Sphinx and the Pydata Sphinx Theme.

cd docs/
pip install -r requirements.txt

You can then build the documentation by running make html from the docs/ folder to build the HTML documentation in the current folder. Run make to get a list of all available output formats.