A repository of instructions and scripts specific to the University of Virginia LDMX group.
These instructions are taken from the LDMX wiki and adapted to the UVA Rivanna computers. The first steps are to clone the ldmx-sw and ldmx-analysis repositories and then setup the container which contains the complete environment needed for LDMX software.
Operating ldmx-sw in the container (which contains all the correct versions of the required software) is the simplest and cleanest way to build and run the LDMX software. ldmx-sw uses a Docker image, but this requires sudo privileges on Rivanna. However, docker images can be downloaded and converted using singularity. First, make sure you are operating in a bash terminal and then type
module load apptainerNext, clone the ldmx-sw repository.
git clone --recursive https://github.com/LDMX-Software/ldmx-sw.gitNote: the recursive flag is important because there are several necessary parts stored in separate git repositories.
Next, source the ldmx-env.sh script. This will grab the latest docker image and enable you to work inside the container. This may take a few minutes for the first time (and will create a .sif file), but also must be re-run every time a new terminal is opened.
source ldmx-sw/scripts/ldmx-env.shNow you can work inside the container by starting all commands with ldmx. Next, build ldmx-sw.
cd ldmx-sw; mkdir build; cd build;
ldmx cmake ..
ldmx make installYou will have to re-build every time a change is made to ldmx-sw. Now you can run with the ldmx fire command where ldmx operates inside the container and fire is the ldmx-sw specific command that executes the python configuration files. There are several examples on the LDMX wiki.
Sometimes, you may want to make changes to the LDMX software or simply perform analysis without changing the core code in ldmx-sw. For this, it is recommended that you use ldmx-analysis. This also enables a faster build if these changes can be made within ldmx-analysis. ldmx-analysis is intended to be built and run alongside ldmx-sw.
You first need to get access to the ldmx-analysis repository. For access, email Omar Moreno at SLAC with your Github account info. Then, clone the repository.
git clone --recursive https://github.com/LDMX-Software/ldmx-analysis.gitNote: the recursive flag is important because there are several necessary parts stored in separate git repositories.
Before building ldmx-analysis, ldmx-sw needs to be built following the instructions above. Build ldmx-analysis inside the container.
cd ldmx-analysis; mkdir build; cd build;
ldmx cmake ..
ldmx make installYou can run ldmx-analysis in the same way as running ldmx-sw with the ldmx fire command followed by a python configuration script. There are several examples in the config directory.
You will want to update your local repositories frequently to keep up with the rapid changes of ldmx-sw. You must both update the repository and the submodules. Make sure your changes are committed, then in the ldmx-sw directory do:
git pull
git submodule updateAfter the submodules are updated, git will return the submodules to the trunk. So, if you are working on a specific branch, you will need to switch to that branch again. Often times the changes are substantial and will require cleaning the branch before building. The next section explains how to do this.
Updates to the software, either on the main trunk or your local changes, can often lead to unexpected compiling errors. Performing a "total reset" of your branch in both ldmx-sw and ldmx-analysis can often fix the problem. To perform the reset, do the following commands:
cd ldmx-sw
git clean -xf
git submodule foreach git clean -xf
rm -r build
rm -r install
mkdir build
cd build
ldmx cmake ..
ldmx make install