Skip to content
Snippets Groups Projects

Updating readme

Merged Whitney Armstrong requested to merge new_doc into master
+ 14
16
@@ -3,6 +3,19 @@ Physics Benchmarks for the EIC
![pipeline status](https://eicweb.phy.anl.gov/EIC/benchmarks/physics_benchmarks/badges/master/pipeline.svg)
## Adding new benchmarks
See the [`benchmarks/DVCS`](https://eicweb.phy.anl.gov/EIC/benchmarks/physics_benchmarks/-/tree/master/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](https://eicweb.phy.anl.gov/EIC/benchmarks/common_bench) for details.
## Running Locally
### Local development example
@@ -10,12 +23,11 @@ Physics Benchmarks for the EIC
Here we setup to use our local build of the `juggler` library.
First set some environment variables.
```
export JUGGLER_INSTALL_PREFIX=$HOME/stow/juggler
export JUGGLER_INSTALL_PREFIX=$HOME/stow/juggler # if developing algorithms
export JUGGLER_DETECTOR=athena # athena is the default
export BEAMLINE_CONFIG=ip6 # ip6 is the default
```
```
git@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
@@ -28,17 +40,3 @@ mkdir -p config
```
## Common bench
See [common_bench](https://eicweb.phy.anl.gov/EIC/benchmarks/common_bench) for details.
## Adding new benchmarks
### Pass/Fail tests
- Create a script that returns exit status 0 for success.
- Any non-zero value will be considered failure.
- Script
Loading