Code Style

We have a number of linting rules for this repository which are enforced as part of CI testing. The most notable is that we follow black code style. Please run the pre-commit checks before opening a pull request. The simplest way to do this is to install the pre-commit package and run it on the repository:

mamba install pre-commit
pre-commit install

Note

pip or conda can be used instead of mamba if you prefer.

This will ensure that the tests run before every commit. If you want to additionally run the checks manually, you can do so with:

pre-commit run --all-files