Contributing

Contributing code

We use uv to manage our development environment.

Setup your development environment by running:

uv lock

Install pre-commit hook

uv run pre-commit install

Start a IPython/Jupyter session by running:

uv run --with ipython ipython
# or
uv run --with jupyter jupyter lab

To run the tests, use:

uv run task test

To build the documentation, use:

# Build doc with cache
uv run task doc-build
# Fresh build
uv run task doc-clean-build

To serve the documentation, use:

uv run task doc-serve

This will start a local server at http://localhost:8000.