diff --git a/README.md b/README.md index af03b0f8d979e421ad7dad86a6d18e13958476a2..168d95b2b7da1b601f3eb9a19e9ea0c4383f4c6d 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,34 @@ See [common_bench](https://eicweb.phy.anl.gov/EIC/benchmarks/common_bench/). See `benchmarks` directory for examples. +## 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 JUGGLER_INSTALL_PREFIX=$HOME/stow/juggler # not needed for detector_benchmarks +export JUGGLER_DETECTOR=athena # athena is the default +export BEAMLINE_CONFIG=ip6 # ip6 is the default +``` + + +``` +git@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 +``` + + + ### Pass/Fail tests