See the Scikit-HEP Developer introduction for a detailed description of best practices for developing packages.

Setting up a development environment

You can set up a development environment by running:

python3 -m venv .env
source ./.env/bin/activate
pip install -v -e .[all]

Post setup

You should prepare pre-commit, which will help you by checking that commits pass required checks:

pip install pre-commit # or brew install pre-commit on macOS
pre-commit install # Will install a pre-commit hook into the git repo

You can also/alternatively run pre-commit run (changes only) or pre-commit run --all-files to check even without installing the hook.

Use PyTest to run the unit checks:

pytest

You can build the docs using:

From inside your environmentwith the docs extra installed, run:

sphinx-build -M html docs docs/_build