How to contribute?

To contribute to the project, you need to install the package in a virtual environment. This can be done best with uv (see installation instructions here). For this, you first need to get the source code with Git:

git clone https://github.com/ComPWA/tensorwaves
cd tensorwaves

Now it's simply a matter of creating and activating the virtual environment with uv sync. The dependencies for the project are 'pinned' in each commit through the uv.lock file.

uv sync --all-extras
source .venv/bin/activate

Formatting and linting checks are automatically performed when committing changes. This is done with pre-commit. To install the hooks in your local repository, run install pre-commit with uv:

uv tool install pre-commit --with pre-commit-uv --force-reinstall --python=3.13

and pre-commit install once:

pre-commit install --install-hooks

Poe the Poet is used as a task runner. Install it globally (within your home folder) with uv:

uv tool install poethepoet --force-reinstall --python=3.13

You can see which local CI checks it defines by running

poe

For instance, all style checks can be run with

poe style