Contributing.md

Contributing code

Install the code with development dependencies:

pip install -e '.[dev]'

Format code and sort imports

black .
isort .

lint code

ruff check .

Run tests

pytest

Sync notebooks with jupytext

For easier diffs, you can use jupytext to sync notebooks in the docs/tutorial directory with the percent format.

jupytext --sync docs/tutorial/*.ipynb

This is configured in the .jupytext file in that directory.