From 72ce9eef26255928b51b81ba4f328bdd29180e91 Mon Sep 17 00:00:00 2001 From: Whitney Armstrong <warmstrong@anl.gov> Date: Fri, 6 Oct 2023 15:56:42 -0500 Subject: [PATCH] Doc update --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9a39aaa..362405a 100644 --- a/README.md +++ b/README.md @@ -100,11 +100,13 @@ The idea is to write as much generic code as possible, so this can be used by a 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 | `$LOACL_PREFIX/share/$DETECTOR` | This is where various `DETECTOR_CONFIG`s should live too | +| 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 @@ -115,9 +117,10 @@ First, let's start with the underlying assumptions: todo -#### Data Flow: Artifacts Vs dedicated storage +#### Data Flow: Artifacts vs dedicated storage -todo +- Do not store large files as artifacts. +- Use `LOCAL_DATA_PATH` for large files, such as, field maps, rootfiles, etc. ### For benchmarks -- GitLab