gnn_tracking
Reconstruct billions of particle trajectories with graph neural networks
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: arxiv.org, zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.0%) to scientific vocabulary
Keywords
Repository
Reconstruct billions of particle trajectories with graph neural networks
Basic Info
- Host: GitHub
- Owner: gnn-tracking
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://gnn-tracking.rtfd.io/
- Size: 24.7 MB
Statistics
- Stars: 49
- Watchers: 4
- Forks: 19
- Open Issues: 33
- Releases: 8
Topics
Metadata Files
README.md
This repository holds the main python package for the GNN Tracking project. See the readme of the organization for an overview of the task. Detailed write-ups of our progress are available in arXiv:2309.16754 and arXiv:2312.03823. More resources are provided in the reading list here.
- 🔋 Batteries included: This repository implements a hole pipeline: from preprocessing to models, to the evaluation of the final performance metrics.
- ⚡ Built around pytorch lightning, our models are easy to train and to restore. By using hooks and callbacks, everything remains modular and maintainable.
- ✅ Tested: Most of the code is guaranteed to run
🔥 Installation
- Install 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/*.ymlfiles (see the readme in that folder) - Run
pip3 install -e '.[testing,dev]'from this directory. - Run
pytestfrom 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.
This package is versioned as 
.
🧰 Development guidelines
If you open a PR and pre-commit fails for formatting, commentpre-commit.ci autofix
to trigger a fixup commit from pre-commit.
To skip the slowest tests with pytest, run pytest --no-slow.
💚 Contributing, contact, citation
You can reach us per mail. You can cite this software with the zenodo DOI. Please also cite our [latest preprint][preprint].
A good place to start contributing 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.
Core developers:
 Gage DeZoort 💻 🤔 |
 Kilian Lieret 💻 ⚠️ |
Thanks also goes to these wonderful people:
 Shubhanshu Saxena 💻 |
 Geo Jolly ⚠️ |
 Jian Park 💻 🤔 |
 Devdoot Chatterjee 💻 🔬 |
|||
Add your contributions
|
||||||
This project follows the all-contributors specification. Contributions of any kind welcome!
Owner
- Name: GNN Tracking
- Login: gnn-tracking
- Kind: organization
- Location: United States of America
- Repositories: 4
- Profile: https://github.com/gnn-tracking
Tracking with Graph Neural Networks
Citation (CITATION.cff)
cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Lieret
given-names: Kilian
orcid: 0000-0003-2792-7511
- family-names: deZoort
given-names: Gage
title: "gnn_tracking: An open-source GNN tracking project"
GitHub Events
Total
- Watch event: 15
- Push event: 10
- Pull request event: 4
- Fork event: 3
Last Year
- Watch event: 15
- Push event: 10
- Pull request event: 4
- Fork event: 3
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 0
- Total pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: 10 months
- Total issue authors: 0
- Total pull request authors: 3
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 0
- Pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: 10 months
- Issue authors: 0
- Pull request authors: 3
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 2
Top Authors
Issue Authors
- klieret (14)
Pull Request Authors
- dependabot[bot] (11)
- klieret (7)
- pre-commit-ci[bot] (6)
- livaage (3)
- aryamanjeendgar (1)