CONTRIBUTING.md

How to develop

This project uses pdm since version 0.7.0. There are nice tutorials available on how to use pdm.

Installing this in dev mode

1. Install pdm in one of the following ways

# requires at least python 3.7
pip install pdm
conda install pdm
mamba install pdm
micromamba install pdm

2. Create a new virtual environment, choose to use it (it's called 'in-project') and install all dependencies

pdm venv create
pdm use --venv in-project
pdm install

Entering the dev shell

1. Activate the virtual environment:

eval $(pdm venv activate in-project)

or alternatively enter a new sub-shell with the right venv

pdm run $SHELL