GNNs for Charged Particle Tracking

This repository holds the main python package for the GNN Tracking project. See the readme of the organization for an overview of the task.

🔥 Installation

Install mamba or micromamba (installation instructions). Conda works as well, but will be slow to solve the environment, so it's not recommended.
Set up your environment with one of the environment/*.yml files (see the readme in that folder)
Run pip3 install -e '.[testing,dev]' from this directory.
Run pytest from this directory to check if everything worked
For development: Install pre-commit hooks: pre-commit install (from this directory)

A good place to get started are the demo notebooks.

If you open a PR and pre-commit fails for formatting, commentpre-commit.ci autofix to trigger a fixup commit from pre-commit.

A good place to start are the issues marked with 'good first issue'. It is always best to have the issue assigned to you before starting to work on it. You can also reach us per mail.

Core developers (emoji key):