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.

🔥 Install & run

1. Set up a conda environment with one of the environment/*.yml files
2. Run pip3 install -e '.[testing]'
3. Run pytest to check if everything worked

A good place to start are the demo notebooks

🧰 Development setup

Install the pre-commit hooks with

pip3 install -e '.[testing,dev]'
pre-commit install

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

💚 Contributing

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.

🖋️ Contact

Write to our mailing list.