Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 997 Bytes

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 997 Bytes

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
pip install pdm # requires at least python 3.7
  1. Create a new virtual environment for the project and install all dependencies
pdm venv create
pdm install --venv in-project

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

Conventions

This project tries to stay compatible with the suggestions from Scikit hep. The used code style is black. Please also obey to the other pre-commit hooks and install them via

pre-commit install