diff --git a/README.md b/README.md index 23feae4aa9fa2eb71f01662cd8176879781e809e..1d21901efd28b4e51434b2883395642c206a0330 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,36 @@ Notably, ## 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/). +The data model is called [`eicd`](https://eic.phy.anl.gov/eicd) -(To be completed...) +Track finding and fitting is based around using [ACTS](https://acts.readthedocs.io) with the detector geometry constructed via [DD4hep](https://dd4hep.web.cern.ch/dd4hep/). + + + +## Repositories and Workflow + +### Repositories + +The collaboration uses [the EIC group on eicweb](https://eicweb.phy.anl.gov/EIC) which contains the subgroups +[detectors](https://eicweb.phy.anl.gov/EIC/detectors) and +[benchmarks](https://eicweb.phy.anl.gov/EIC/benchmarks). + +The main software components locally developed are: +- [`juggler`](https://eicweb.phy.anl.gov/EIC/juggler) - Event processing framework (i.e. algorithms live) +- [`eicd`](https://eicweb.phy.anl.gov/EIC/eicd) - EIC data model +- [`npdet`](https://eicweb.phy.anl.gov/EIC/npdet) - collection of dd4hep simulation plugins and tools. + + +The key repositories there are: + + +- [detectors/ip6](https://eicweb.phy.anl.gov/EIC/detectors/ip6) - IP6 specifics (forward and backward beamline and detectors). +- [detectors/athena](https://eicweb.phy.anl.gov/EIC/detectors/athena) - ATHENA detector +- [benchmarks](https://eicweb.phy.anl.gov/EIC/benchmarks/detector_benchmarks) +- [benchmarks](https://eicweb.phy.anl.gov/EIC/benchmarks/reconstruction_benchmarks) +- [benchmarks](https://eicweb.phy.anl.gov/EIC/benchmarks/physics_benchmarks) -## Workflow ```mermaid graph TD; @@ -41,6 +65,5 @@ graph TD; juggler-->pb; ``` -### Repositories