Warning, /detector_benchmarks/README.md is written in an unsupported language. File is not indexed.
0001 ePIC Detector Benchmarks
0002 ========================
0003
0004 [](https://eicweb.phy.anl.gov/EIC/benchmarks/detector_benchmarks/-/commits/master)
0005
0006 ## Overview
0007
0008 Detector benchmarks are meant to provide a maintained set of performance plots for individual detector subsystems.
0009
0010 ## Documentation
0011
0012 - See [tutorial](https://eic.github.io/tutorial-developing-benchmarks/)
0013 - See [common_bench](https://eicweb.phy.anl.gov/EIC/benchmarks/common_bench/).
0014
0015 ## Adding new benchmarks
0016
0017 To get an idea of what to do look at an existing benchmark in the
0018 [`benchmarks` directory](https://github.com/eic/detector_benchmarks/tree/master/benchmarks).
0019 Currently a good reference for Snakemake instrumentation is available in the `tracking\_performances` benchmark.
0020 It relies on single particle simulations that can be either produced on eicweb or downloaded from official campagins.
0021
0022 ### File organization
0023
0024 For a minimal benchmark you'll need to add
0025 `benchmarks/<benchmark_name_here>/config.yml` and
0026 `benchmarks/<benchmark_name_here>/Snakemake`, plus the analysis script/macro.
0027 The `Snakefile` has to be included in the root `./Snakefile` of the repository.
0028 That common entry point is needed to ensure that common simulation samples can
0029 be defined to be re-used by several benchmarks at a time.
0030 The `config.yml` will require an include from the `./.gitlab-ci.yml`.
0031
0032 ### Pass/Fail tests
0033
0034 - Create a script that returns exit status 0 for success.
0035 - Any non-zero value will be considered failure.
