Skip to content

Use Matfree's continuous integration

To install all test-related dependencies, (assuming JAX is installed; if not, run pip install .[cpu]), execute

pip install .[test]
Then, run the tests via
make test

Install all formatting-related dependencies via

pip install .[format]
and format the code via
make format

To lint the code, install the pre-commit hook

pip install .[lint]
pre-commit install
and run the linters via
make lint

Install the documentation-related dependencies as

pip install .[doc]
Preview the documentation via

make doc-preview

and check whether the docs build correctly via

make doc-build