Installing All Things PUEO

Table of Contents

• • Step 0: ssh works?
  • Step 1: submodules
  • Step 2: prepare build
  • Step 3: optional
  • Step 4: compile and install
  • Step 5: test run

Attention

In this section, it is assumed that the commands are run inside the pueoBuilder/ directory.
If you followed the previous sections and cloned pueoBuilder to your home directory, you should

cd ${HOME}/pueoBuilder

Step 0: ssh works?

• Make sure that ssh is still working (e.g. you can still git pull);
• If not, run the following again

  eval "$(ssh-agent -s)"
  ssh -T GitHub_or_whatever_alias_you_want

  (assuming that you have set up the ssh keys, see Step 1: set up secure shell)

Step 1: submodules

• At this stage, the folders inside components/ are still emtpy.
• Initialize the submodules and associate them with these folders:

  git submodule init

• And then populate the folders with

  git submodule update

Remarks

In case you don't want to build the analysis software (for example, if you only want to run the simulatePueo executable and want to save some build time), you can exclude the analysis repositories (e.g. pueoAnalysisTools) with

git submodule deinit components/pueoAnalysisTools

Step 2: prepare build

• Next, prepare the build/ directory:

  cmake -S . -B build

• This uses CMakeLists.txt in the current diretory (.) as the source of build instructions.
• Additionally, it creates a build/ directory and puts all "build artifacts" in it.

  Remarks

  The path build/ is a standard choice. Try an "out-of-source" build by changing the command to

  cmake -S . -B ../OutOfSourceBuild

  and see if your computer explodes.

Step 3: optional

• You may optionally check out some of the build options.

  ccmake build

• This opens up the ccmake terminal user interface (TUI) and lets you view/edit the CMake build options.

  Remarks

  You can read more about these options in the CMakeLists.txt. These are more advanced, so if they seem foreign to you, don't worry about them.

Step 4: compile and install

• Compile and install everything with, for example, 4 threads:

  cmake --build build -- -j4

• Our CMakeLists.txt is set up such that everything is installed to $PUEO_UTIL_INSTALL_DIR automatically, so in this case there is no need to run a separate install command.

Step 5: test run

• If everything compiled and installed, you should be able to run the executable.

  ./install/bin/simulatePueo -i pueo.conf -n 10 -e 21 -o ${HOME}/pueo_output -r 420

• This creates a directory pueo_output/ in home and places the simulation result (a bunch of *.root files) inside a run420/ directory.
• See Introduction to the Simulation for more information on the executable simulatePueo.
• You can use the scripts in pueoAnalysisTools to make some plots with the simulated data.

Deprecated

• As of April 22, 2025 pueoBuilder PR #18, $LD_LIBRARY_PATH is no longer needed to run PUEO binaries (ie. C++ scripts, eg. simulatePueo).
• That said, to run the Python scripts (for example the ones in pueoAnalysisTools/SharedUtils), the library path still needs to be a part of $LD_LIBRARY_PATH.
• That is, do export LD_LIBRARY_PATH=${PUEO_UTIL_INSTALL_DIR}/lib64 if you are running the Python scripts.