Development

Development setup

We use pre-commit to run linters and formatters on the codebase. To enable pre-commit hooks in your development environment, run:

pip install pre-commit
pre-commit install

Running tests

We use pytest for testing.

To run the test suite, execute the following command in the project root directory:

pytest

Building documentation

The documentation is built using Sphinx.

To build the documentation locally, navigate to the doc/ directory and run:

make html

The generated HTML files will be located in the doc/_build/html/ directory.