Software overview
=================

Full Simulation
---------------

The software is currently being developed. Here is only the software short description with links. Please read the full desctiption next.

The main repository for ATHENA software `is here <https://eicweb.phy.anl.gov/EIC>`_

DD4Hep
^^^^^^

DD4hep is a software framework for providing a complete solution for full detector description (geometry, materials, visualization, readout, alignment, calibration, etc.) 
for the full experiment life cycle (detector concept development, detector optimization, construction, operation). 
It offers a consistent description through a single source of detector information for simulation, reconstruction, analysis, etc. 

- `DD4Hep main repository <https://github.com/AIDASoft/DD4hep>`_
- `EIC detector implementations <https://eicweb.phy.anl.gov/EIC/detectors>`_

Juggler
^^^^^^^

Gaudi based digitization and reconstruction framework. Currently it supports ACTS based tracking, calorimetry reconstruction, some PID like RICH

- `Project Juggler <https://eicweb.phy.anl.gov/EIC/juggler>`_
- `EICD <https://eicweb.phy.anl.gov/EIC/eicd>`_ - EIC event data model implemented in PODIO



Validation
----------

On any commit to detector or reconstruction repository a bunch of validation benchmarks are being automatically run. Current benchmarks repository

- `Detector benchmarks <https://eicweb.phy.anl.gov/EIC/benchmarks/detector_benchmarks>`_ - Detector benchmarks are meant to test for regressions in individual detector subsystems without a complex reconstruction
- `Reconstruction benchmarks <https://eicweb.phy.anl.gov/EIC/benchmarks/reconstruction_benchmarks>`_ - Reconstruction specific benchmarks (calorimetry, tracking, PID)
- `Physics benchmarks <https://eicweb.phy.anl.gov/EIC/benchmarks/physics_benchmarks>`_ - Check physical processes such as DIS, DVCS, etc.
- `Cost estimation <https://eicweb.phy.anl.gov/EIC/benchmarks/cost_analysis>`_ - (in develoment) A weighted evaluation of the detector performance versus estimated cost.


Infrastructure
--------------

- `Main repository <https://eicweb.phy.anl.gov/EIC/>`_
- Rucio
- Farms

`The resources page on the EICUG WG site <https://eic.github.io/resources/overview.html#datastorage>`_

Fast simulation
---------------

Delphes
^^^^^^^

DELPHES provides the simulation of a multipurpose detector for phenomenological studies. 
The simulation includes a track propagation system embedded in a magnetic field, electromagnetic and hadron calorimeters, and PID. 
Physics objects that can be used for data analysis are then reconstructed from the simulated detector response. 
These include tracks and calorimeter deposits and high level objects such as isolated electrons, jets, taus, and missing energy. 
With features such as the particle-flow reconstruction, pile-up simulation and mitigation. 

Contacts: Stephen Sekula, Miguel Arratia

Support line: `ATHENA Slack <https://join.slack.com/t/eicip6/shared_invite/zt-nsocbr8y-~lrhqi8We6FjV1CmnmVVTQ>`_

- `Delphes web site <https://github.com/delphes/delphes>`_
- `EIC Reference Detector Delphes implementation <https://delphes-eic.readthedocs.io/en/latest/>`_


EicSmear
^^^^^^^^

Eic-smear is a Monte Carlo analysis package originally developed by the BNL EIC task force. It contains classes and routines for building 
events in a C++ object and writing them to a ROOT file in a tree data structure, performing fast detector smearing on those Monte Carlo events. 
The smearing portion of the code provides a collection of classes and routines that allow simple parameterizations of detector performance, provided via a ROOT script, 
to be applied to any of the above Monte Carlo events. Detector acceptance can also be defined.

Contacts: Alexander Kiselev ayk@bnl.gov, Kolja Kauder kkauder@bnl.gov

- `EIC-Smear main package <https://github.com/eic/eic-smear>`_
- `EIC detector parametrizations <https://github.com/eic/eicsmeardetectors>`_


Legacy full simulation
----------------------

ESCalate
^^^^^^^^

Contacts: Dmitry Romanov, Yulia Furletova (g4e)

- `escalate.readthedocs.io <https://escalate.readthedocs.io/en/latest/>`_
- `g4e.readthedocs.io <https://escalate.readthedocs.io/en/latest/>`_


Fun4All
^^^^^^^

Contacts:  Kolja Kauder (for ATHENA), Chris Pinkenburg and Jin Huang (developers)

- Fun4All general Tutorials 	https://github.com/eic/fun4all_tutorials
- Fun4All EIC specific Tutorials 	https://github.com/eic/fun4all_eic_tutorials
- Fun4All Build your own GEANT4 Detector 	https://github.com/eic/fun4all_g4exampledetector