Repository navigation
Testing
Tests are located in the tests directory and are run with pytest.
The Jupyter notebooks in the examples directory serve both as examples and as documentation. CI verifies that the notebooks can be executed without errors and that their output is reproducible.
When adding new functionality, it is good practice to add a usage example to one of the notebooks, or at least add a unit test.
With a full development setup:
uv run pytestFor the same warning configuration as used by CI:
uv run pytest -v -W error::RuntimeWarningThe project uses prek to run the repository's pre-commit hooks. Ruff is used for formatting and linting, while Pylint performs additional checks.
Run all hooks on the complete repository:
uv run prek run --all-filesThis will automatically apply formatting and other available fixes. Run it before committing changes.
For normal development, the hooks can also be run only on changed/staged files:
uv run prek runThe CI workflow runs the same checks, so running prek locally is the easiest way to catch formatting and linting problems before pushing.