Welcome

This is the software documentation for EIC Comprehensive Chromodynamics Experiment (ECCE) simulation and reconstruction software framework.

This software runs on all types of accounts for BNL SDCC/RCAF comtputing center. For off-BNL scientific computing and mobile users, a container are prepared to ensure binary consistent result. With distribution over the OpenScienceGrid CVMFS, this containerized software is supported to run in major scientific computing centers such as CERN, JLab iFarm clusters (see example), and OpenScienceGrid clusters.

Get started

Please checkout the day-1 checklist and our Mar-2021 simulation workshop. We also have slides with some information on office hours, setting up environments and different ways to interface with the ECCE builds such as from RCF or using virtual machines located here.

Tutorial

For tutorials, please start with the tutorial landing page

Documentation

• Using ECCE software
  • Default simulation and reconstruction macros
  • Tutorial for building user analysis for analysis module
  • For code reference, please visit the source code reference via Doxygen.
• ECCE plotting style with example in ROOT c++ macro and Python numpy array
• Useful tricks
  • Cheatsheet of using git

Further documentation is under construction.