This is a generic analysis application for CLAS12 in groovy to read HIPO events selecting all unique final state particle combinations corresponding to a given topology, compute generic event-level kinematics commonly used for SIDIS analyses, and output the selected combinations and their respective kinematics to ROOT TNTuples.
The main purpose of this tool is to to compute event-level kinematics for all unique combinations of a given set of particles (e.g. proton pion pairs) without the hassle of rewriting your code and plugging in different configurations every time.
This tool only reads HIPO files (see CLAS12-Offline-Software) and outputs to ROOT files.
To build the project you will need the following additional tools:
- jdk==17.0.*
- groovy==4.0.*
- gradle==8.12
- scons>=4.5.2
- maven==3.9.9
Note that this project is under active development and has only been tested for jdk/17.0.2 and groovy 4.0.3. On ifarm you may need to module load this java version. You may also need to update the library versions in gradle/libs.versions.toml and the java version in app/build.gradle.
Begin by cloning the repository and running the setup script
git clone --recurse-submodules https://github.com/mfmceneaney/CLAS12-Analysis.git
cd CLAS12-Analysis
source bin/setup.shThen source the environment script from your startup script:
pushd /path/to/CLAS12-Analysis >> /dev/null
#Uncomment this line if using csh: cd j2root; source setup.csh; cd ..;
source env.sh
popd >> /dev/nullCurrently the default scons version 2.5 on ifarm does not support python 2.3, so just run the following before sourcing the setup script to get around this.
# For interactive use
alias scons "/usr/bin/env python2 `which scons`"
# For jobs
function scons {
/usr/bin/env python2 `which scons`
}Depending on what java version you have, in particular for java 8 on ifarm, you need to edit the setup script by commenting and uncommenting these two lines:
jar -c -f clasqa.jar clasqa/*.groovy # Comment this
# jar cf clasqa.jar clasqa/*.groovy # Uncomment thisFinally, you might have to run the following so that gradle can SLURM jobs can read your gradle files:
chmod +r ~/.gradle/daemon/<version>/registry.binTo set your $CLASSPATH manually add the following to your startup script (borrowed from bin/clara-shell script in $CLARA_HOME):
# set default classpath
if [ -z "${CLASSPATH}" ]; then
CLASSPATH="${CLARA_HOME}/lib/*"
# Add every plugin
for plugin in "${plugins_dir}"/*/; do
plugin=${plugin%*/}
if [ "${plugin##*/}" = "clas12" ]; then # COAT has special needs
CLASSPATH+=":${plugin}/lib/clas/*:${plugin}/lib/services/*"
else
CLASSPATH+=":${plugin}/services/*:${plugin}/lib/*"
fi
done
CLASSPATH+=":${CLARA_HOME}/services/*"
export CLASSPATH
fiand run from $C12ANALYSIS/bin/run.sh.
Assuming your $CLASSPATH is configured correctly, you can proceed without further setup.
You should now be able to run the application with $C12ANALYSIS/bin/run.sh which runs directly from groovy.
Some version info will pop up if you do not supply any arguments.
Use the -h or --help option to see a detailed list of all available command line options and arguments.
As a legacy option, you may also run the application with $C12ANALYSIS/bin/an-groovy, which will automatically use the correct $CLASSPATH. However, you can run into thread permissions errors running gradle from this script in SLURM jobs so it is better to just set your $CLASSPATH manually and use $C12ANALYSIS/bin/run.sh instead.
Although this tool is primarily intended to have a generic application and primarily be used via execution of $C12ANALYSIS/bin/run.sh from the command line, you may also configure and run an analysis with more direct control over the configuration process by using a groovy script. See the examples folder for, well, examples!
Please note, the Constants and ExtendedConstants classes are not necessarily up to date, and you should also be especially careful to correctly set the beam energy and target mass.
Check out our Read The Docs page for the full groovy docs!
Contact: [email protected]