README.md

Physics Benchmarks for the EIC

Documentation Links

• eicd - EIC Data Model. (See ReconstructedParticle for most needs)
• juggler reconstruction framework.
• Benchmark repository common code - common_bench
• Guide to tracking
• ROOT's RDataFrame

Adding new benchmarks

See the benchmarks/DVCS directory for a basic example. Note currently the reconstruction is far from perfect.

Pass/Fail tests

• Create a script that returns exit status 0 for success.
• Any non-zero value will be considered failure.
• Script

See common_bench for details.

Running Locally

Local development example

Here we setup to use our local build of the juggler library. First set some environment variables.

export JUGGLER_INSTALL_PREFIX=/usr/local 
export DETECTOR=epic             # athena is the default
export BEAMLINE_CONFIG=ip6       # ip6 is the default

git clone https://eicweb.phy.anl.gov/EIC/benchmarks/physics_benchmarks.git && cd physics_benchmarks
git clone https://eicweb.phy.anl.gov/EIC/benchmarks/common_bench.git setup
source setup/bin/env.sh && ./setup/bin/install_common.sh
source .local/bin/env.sh && build_detector.sh
mkdir_local_data_link sim_output
mkdir -p results config

Repositories and Workflow

Repositories

The collaboration uses the EIC group on eicweb which contains the subgroups detectors and benchmarks.

The main software components locally developed are:

• juggler (documentation) - Event processing framework (i.e. algorithms live)
• eicd (documentation) - EIC data model
• npdet - collection of dd4hep simulation plugins and tools.

The key collaboration/user code repositories are: