diff --git a/README.md b/README.md index 766a808f9e9d067eac2760eaa4960f1688358ec5..76151c6346d6ad95658031719181a48faa82ebef 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,44 @@ -# Guide To Tracking +# Guide to Tracking Development in Juggler for ATHENA Collaboration ## Overview -Currenlty, track finding and fitting is based around using [ACTS](https://acts.readthedocs.io) with the geometry constructed via [DD4hep](https://dd4hep.web.cern.ch/dd4hep/). +This guide assumes the reader has some basic knowledge of tracking and computing. +Notably, +- How to effectively use `git` and has an [`eicweb`](https://eicweb.phy.anl.gov/EIC) account. +- Some basic shell scripting and python +- How to use ROOT with modern c++ (`RDataframe`s are particularly important) +- Some familiarity with [`juggler`](https://eicweb.phy.anl.gov/EIC/juggler.git) + + +### What this guide is not + +- This is *not* a demonstration of ultimate track reconstruction (nowhere near it). +- This is *not* an analysis tutorial. + +### What this guide is + +- A summary and overview of the basic framework components. +- A resource for algorithm developers. +- A guide to the development workflow driven by CI/CD. + + +## Data Model + +Track finding and fitting is based around using [ACTS](https://acts.readthedocs.io) with the geometry constructed via [DD4hep](https://dd4hep.web.cern.ch/dd4hep/). (To be completed...) + + +## Workflow + +```mermaid +graph TD; + A-->B; + A-->C; + B-->D; + C-->D; +``` + +### Repositories + +