Skip to content
Snippets Groups Projects

Draft: Updating documentation on README

Open Whitney Armstrong requested to merge build_doc into master
1 unresolved thread
1 file
+ 24
5
Compare changes
  • Side-by-side
  • Inline
+ 24
5
@@ -89,6 +89,25 @@ The idea is to write as much generic code as possible, so this can be used by a
@@ -89,6 +89,25 @@ The idea is to write as much generic code as possible, so this can be used by a
| `BEAMLINE` | Optional, name of beamline/interaction region to build first | `ip6` or `ip8` | Not used if undefined |
| `BEAMLINE` | Optional, name of beamline/interaction region to build first | `ip6` or `ip8` | Not used if undefined |
| `BEAMLINE_VERSION` | Branch or tagged version to use | Same as | Default typically `main` or `master` |
| `BEAMLINE_VERSION` | Branch or tagged version to use | Same as | Default typically `main` or `master` |
 
#### Other Configurable Variables
 
 
 
| Variable | Meaning and use | Examples | Notes |
 
| :--- | :--- | :--- | :--- |
 
| `DETECTOR_CONFIG` | Name of a top level detector description (xml) file | `epic_far_forward_only` | These should not be required for well developed benchmarks. Can be useful developing new bms. |
 
| todo : | default value for `DETECTOR_CONFIG`? | | |
Please register or sign in to reply
 
#### Predefined Variables
 
 
Do not override these values.
 
 
| Variable | Meaning and use | Value | Notes |
 
| :--- | :--- | :--- | :--- |
 
| `LOCAL_PREFIX` | Installation path for `common_bench` | `.local` | First searched via `$PATH`,`$LD_LIBRARY_PATH`, etc. |
 
| `DETECTOR_PREFIX` | Path for downloading repos and build directories | `$LOCAL_PREFIX/detector` | |
 
| `DETECTOR_PATH` | Path to top level detector description files | `$LOCAL_PREFIX/share/$DETECTOR` | This is where various `DETECTOR_CONFIG`s should live too |
 
| `LOCAL_DATA_PATH` | Large file data storage for pipeline jobs | `/scratch/${CI_PROJECT_NAME}_${CI_PIPELINE_ID}` | use for most data files |
 
 
#### Build Strategy
#### Build Strategy
First, let's start with the underlying assumptions:
First, let's start with the underlying assumptions:
@@ -96,15 +115,15 @@ First, let's start with the underlying assumptions:
@@ -96,15 +115,15 @@ First, let's start with the underlying assumptions:
- Development necessitates rebuilding some of the packaged software. Here we need to avoid unintentionally using the container packaged version we want to supplant.
- Development necessitates rebuilding some of the packaged software. Here we need to avoid unintentionally using the container packaged version we want to supplant.
- This problem persists across CI jobs, triggered pipelines, and working locally.
- This problem persists across CI jobs, triggered pipelines, and working locally.
In the case
todo
#### Data Flow: Artifacts Vs dedicated storage
 
#### Data Flow: Artifacts vs dedicated storage
 
- Do not store large files as artifacts.
 
- Use `LOCAL_DATA_PATH` for large files, such as, field maps, rootfiles, etc.
### For benchmarks
### For benchmarks
todo
Loading