For contributors

All contributions are welcome, feel free to create a pull request on GitHub. Please note that we are using black as a format-checker and mypy as a static type-checker to pre-check any pushes to a pull-request. If your code is not in line black/mypy, no unit tests will be run.

Documentation

We use sphinx & ReadTheDocs for documenting.

Test your changes locally:

• Install the documentation dependencies (setup.cfg: docs).

• Local build: from the docs directory execute make html (on Windows: .\make.bat html).

Testing

We use pytest for testing.