Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
detector_benchmarks
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
EIC
benchmarks
detector_benchmarks
Commits
07804284
Commit
07804284
authored
8 months ago
by
Dmitry Kalinkin
Browse files
Options
Downloads
Patches
Plain Diff
README.md: update with latest info
parent
2ad03c1d
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+18
-36
18 additions, 36 deletions
README.md
with
18 additions
and
36 deletions
README.md
+
18
−
36
View file @
07804284
E
IC Detector Benchmarks
=======================
eP
IC Detector Benchmarks
=======================
=
[

](https://eicweb.phy.anl.gov/EIC/benchmarks/detector_benchmarks/-/commits/master)
## Overview
Detector benchmarks are meant to test for regressions in individual detector subsystems.
The analysis is meant to avoid a reconstruction step.
So this precludes using
[
juggler
](
https://eicweb.phy.anl.gov/EIC/juggler
)
for processing the events.
Detector benchmarks are meant to provide a maintained set of performance plots for individual detector subsystems.
## Documentation
See
[
common_bench
](
https://eicweb.phy.anl.gov/EIC/benchmarks/common_bench/
)
.
-
See
[
tutorial
](
https://eic.github.io/tutorial-developing-benchmarks/
)
-
See
[
common_bench
](
https://eicweb.phy.anl.gov/EIC/benchmarks/common_bench/
)
.
## Adding new benchmarks
To get an idea of what to do look at an existing benchmark in the
[
`benchmarks` directory
](
https://eicweb.phy.anl.gov/EIC/benchmarks/detector_benchmarks/-/tree/master/benchmarks
)
.
## Running Locally
### Local development example
Here we setup to use our local build of the
`juggler`
library.
Note juggler is not needed for
`detector_benchmarks`
because it is not used but this is the same setup for
`reconstruction_benchmarks`
and
`physics_benchmarks`
.
First set some environment variables.
```
export DETECTOR=epic # epic is the default
```
```
git clone https://eicweb.phy.anl.gov/EIC/benchmarks/detector_benchmarks.git && cd detector_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
mkdir -p config
```
[
`benchmarks` directory
](
https://github.com/eic/detector_benchmarks/tree/master/benchmarks
)
.
Currently a good reference for Snakemake instrumentation is available in the
`tracking\_performances`
benchmark.
It relies on single particle simulations that can be either produced on eicweb or downloaded from official campagins.
### File organization
For a minimal benchmark you'll need to add
`benchmarks/<benchmark_name_here>/config.yml`
and
`benchmarks/<benchmark_name_here>/Snakemake`
, plus the analysis script/macro.
The
`Snakefile`
has to be included in the root
`./Snakefile`
of the repository.
That common entry point is needed to ensure that common simulation samples can
be defined to be re-used by several benchmarks at a time.
The
`config.yml`
will require an include from the
`./.gitlab-ci.yml`
.
### Pass/Fail tests
-
Create a script that returns exit status 0 for success.
-
Any non-zero value will be considered failure.
-
Script
-
Create a script that returns exit status 0 for success.
-
Any non-zero value will be considered failure.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment