env.sh

#!/bin/bash

## =============================================================================
## Global configuration variables for the benchmark scripts
## The script defines the following environment variables that are meant to
## be overriden by the Gitlab continuous integration (CI)
##
##  - BEAMLINE:         compact detector files for the interaciton point beamline
##  - BEAMLINE_VERSION: compact detector files for the interaciton point beamline
##  - DETECTOR:                detector package to be used for the benchmark
##  - DETECTOR_CONFIG:         detector package config to be used for the benchmark
##  - DETECTOR_VERSION:        detector package to be used for the benchmark
##  - BENCHMARK_N_EVENTS:      events processed by simulation/reconstruction
##  - BENCHMARK_N_THREADS:     number of threads/processes to spawn in parallel
##  - BENCHMARK_RNG_SEED:      random seed for the RNG
##
## It also defines the following additional variables for internally usage
##  - LOCAL_PREFIX:           prefix for packages installed during the benchmark
##  - LOCAL_DATA_PATH:        local storage for pipeline jobs
##  - DETECTOR_PREFIX:        prefix for the detector definitions
##  - DETECTOR_PATH:          root path to locally installed detector definition xml files
##
## Finally, it makes sure LOCAL_PREFIX and JUGGLER_PREFIX are added to PATH
## and LD_LIBRARY_PATH
## =============================================================================

echo "Setting up the Physics Benchmarks environment"

## =============================================================================
## Default variable definitions, normally these should be set
## by the CI. In case of local development you may want to change these
## in case you would like to modify the detector package or
## number of events to be analyzed during the benchmark

## Detector package to be used during the benchmark process
## If you didn't define DETECTOR already, you have bigger problesm

if [ ! -n  "${DETECTOR}" ] ; then
  echo "ERROR: No DETECTOR defined!" 
  echo "       There is no assumed default detector."
  echo "       Set the environment variable DETECTOR accordingly."
  #export DETECTOR="epic"
fi

# Optional variable, define it or don't use it
#if [ ! -n  "${DETECTOR_CONFIG}" ] ; then
#  export DETECTOR_CONFIG="${DETECTOR}_full"
#fi

if [ ! -n  "${DETECTOR_VERSION}" ] ; then 
  export DETECTOR_VERSION="main"
else
  # handle spack version spec format (e.g. git.fcf90937193c983c0af2acf1251e01f2e2c3a259=main)
  DETECTOR_VERSION=${DETECTOR_VERSION##git.}
  export DETECTOR_VERSION=${DETECTOR_VERSION%%=*}
fi

if [ ! -n  "${DETECTOR_REPOSITORYURL}" ] ; then
  export DETECTOR_REPOSITORYURL="https://eicweb.phy.anl.gov/EIC/detectors/${DETECTOR}.git"

  # This if statement should be removed -- just define the variable upstream. 
  if [ "${DETECTOR}" == "epic" ] ; then
    export DETECTOR_REPOSITORYURL="https://github.com/eic/${DETECTOR}.git"
  fi
fi

## Number of events that will be processed by the reconstruction
if [ ! -n  "${BENCHMARK_N_EVENTS}" ] ; then 
  export BENCHMARK_N_EVENTS=100
fi
export JUGGLER_N_EVENTS=${BENCHMARK_N_EVENTS}

# optionally use a BEAMLINE repository
if [ "${BEAMLINE}" ] ; then

  if [ ! -n  "${BEAMLINE_VERSION}" ] ; then 
    export BEAMLINE_VERSION="main"
  fi

  if [ ! -n  "${BEAMLINE_REPOSITORYURL}" ] ; then 
    export BEAMLINE_REPOSITORYURL="https://eicweb.phy.anl.gov/EIC/detectors/${BEAMLINE}.git"
  fi
fi



## Maximum number of threads or processes a single pipeline should use
## (this is not enforced, but the different pipeline scripts should use
##  this to guide the number of parallel processes or threads they 
##  spawn).
if [ ! -n "${BENCHMARK_N_THREADS}" ]; then
  export BENCHMARK_N_THREADS=10
fi
export JUGGLER_N_THREADS=${BENCHMARK_N_THREADS}

## Random seed for event generation, should typically not be changed for
## reproductability.
if [ ! -n "${BENCHMARK_RNG_SEED}" ]; then
  export BENCHMARK_RNG_SEED=1
fi
export JUGGLER_RNG_SEED=${BENCHMARK_RNG_SEED}

## Location of local data for pass data from job to job within pipeline.
## Not saved as artifacts.
## Local /scratch directory is presumed to be writable. 
if [ ! -n  "${LOCAL_DATA_PATH}" ] ; then 
  export LOCAL_DATA_PATH="/scratch/${CI_PROJECT_NAME}_${CI_PIPELINE_ID}"
fi
mkdir -p "${LOCAL_DATA_PATH}"
if [ ! -d "${LOCAL_DATA_PATH}" ]; then 
  echo "LOCAL_DATA_PATH (${LOCAL_DATA_PATH}) does not exist!!"
  echo "Creating LOCAL_DATA_PATH=$(pwd)/local_data "
  export LOCAL_DATA_PATH="$(pwd)/local_data"
  mkdir -p "${LOCAL_DATA_PATH}"
fi

## =============================================================================
## Other utility variables that govern how some of the dependent packages
## are built and installed. You should not have to change these.

## local prefix to be used for local storage of packages
## downloaded/installed during the benchmark process
LOCAL_PREFIX=".local"
mkdir -p "${LOCAL_PREFIX}"
export LOCAL_PREFIX=`realpath ${LOCAL_PREFIX}`

## detector prefix: prefix for the detector definition repositories
export DETECTOR_PREFIX="${LOCAL_PREFIX}/detector"
mkdir -p ${DETECTOR_PREFIX}

## detector path: root path to locally installed detector definition xml files
export DETECTOR_PATH="${LOCAL_PREFIX}/share/${DETECTOR}"

## build dir for ROOT to put its binaries etc.
export ROOT_BUILD_DIR=$LOCAL_PREFIX/root_build

export ROOT_INCLUDE_PATH=${LOCAL_PREFIX}/include:${ROOT_INCLUDE_PATH}

echo "DETECTOR=${DETECTOR}" >> .env
#echo "DETECTOR_CONFIG=${DETECTOR_CONFIG}" >> .env
echo "DETECTOR_VERSION=${DETECTOR_VERSION}" >> .env
echo "DETECTOR_REPOSITORYURL=${DETECTOR_REPOSITORYURL}" >> .env
echo "BEAMLINE=${BEAMLINE}" >> .env
echo "BEAMLINE_VERSION=${BEAMLINE_VERSION}" >> .env
echo "BEAMLINE_REPOSITORYURL=${BEAMLINE_REPOSITORYURL}" >> .env
#echo "BENCHMARK_N_EVENTS=${BENCHMARK_N_EVENTS}" >> .env
#echo "BENCHMARK_N_THREADS=${BENCHMARK_N_THREADS}" >> .env
#echo "BENCHMARK_RNG_SEED=${BENCHMARK_RNG_SEED}" >> .env
#echo "JUGGLER_N_EVENTS=${JUGGLER_N_EVENTS}" >> .env
#echo "JUGGLER_N_THREADS=${JUGGLER_N_THREADS}" >> .env
#echo "JUGGLER_RNG_SEED=${JUGGLER_RNG_SEED}" >> .env
echo "LOCAL_PREFIX=${LOCAL_PREFIX}" >> .env
echo "DETECTOR_PREFIX=${DETECTOR_PREFIX}" >> .env
echo "DETECTOR_PATH=${DETECTOR_PATH}" >> .env
echo "ROOT_BUILD_DIR=${ROOT_BUILD_DIR}" >> .env
echo "ROOT_INCLUDE_PATH=${ROOT_INCLUDE_PATH}" >> .env
echo "LOCAL_DATA_PATH=${LOCAL_DATA_PATH}" >> .env

## =============================================================================
## Setup PATH and LD_LIBRARY_PATH to include our prefixes
echo "Adding LOCAL_PREFIX to PATH and LD_LIBRARY_PATH"
export PATH=${LOCAL_PREFIX}/bin:${PATH}
export LD_LIBRARY_PATH=${LOCAL_PREFIX}/lib:${LD_LIBRARY_PATH}

# Local field maps
mkdir -p ${LOCAL_DATA_PATH}/fieldmaps
ln -sf ${LOCAL_DATA_PATH}/fieldmaps

## =============================================================================
## That's all!
echo "Environment setup complete."