Proton Calorimetry/Detector Simulation

This page contains information on the Geant4 code that form the Proton Calorimetry detector simulation.

In order to run Geant4 simulations, you will either need to download and install the software yourself or make use of the existing installation on the UCL HEP Linux cluster. To use the existing installation, follow this dedicated page.

Local Installation of GEANT4 on MacOS

Tested on MacOS High Sierra 10.13.6 and Catalina 10.15.3

• Install Xcode 10 or higher from Mac App Store and install command line tools by executing in a terminal window xcode-select --install. Agree to the Xcode license: sudo xcodebuild -license
• Install Anaconda3 [1]
• Install XQuartz [2]
• Install MacPorts appropriate for your system [3].
• Install CMake 3.8 or higher [4]
  • After installation, execute: sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install
• Optional: Install CLHEP 2.4.1.0 or higher [5] (see README for build/install instructions)
  • <source_code_dir> is the directory where the README is located.
  • <build_directory> can be any folder you like (can be deleted after installation).
  • <install_directory> should be the default: /usr/local
• Install Expat 2.0.1 or higher [6] (see README for build/install instructions)
  • Execute ./buildconf.sh and then ./configure in the directory <download_directory>/expat
    • If autoreconf is not found, install autoconf by executing: sudo port install automake autoconf libtool
  • Might need to use sudo when executing make install
• Install zlib 1.2.3 or higher [7] (see README for build/install instructions)
  • Might need to use sudo when executing make install</code.>
• Install Xerces-C++ headers and library 3 or higher [8]
  • Will need to install GPG [9] to verify KEYS, see here for instructions: [10]
  • After verification, in expanded Xerces folder execute: ./configure, sudo make and then sudo make install
• Install GEANT4 [11]
  • See installation guide here
  • Execute: cmake -DCMAKE_INSTALL_PREFIX=/usr/local -DGEANT4_BUILD_MULTITHREADED=ON -DGEANT4_INSTALL_DATA=ON -DGEANT4_USE_GDML=ON -DGEANT4_USE_QT=ON -DGEANT4_USE_OPENGL_X11=OFF -DGEANT4_USE_RAYTRACER_X11=OFF -DGEANT4_USE_SYSTEM_EXPAT=ON -DGEANT4_USE_SYSTEM_ZLIB=ON <path to GEANT4 download folder>
    • If you installed your own version of CLHEP, you can add the additional argument -DGEANT4_USE_SYSTEM_CLHEP=ON, although this is not recommended.
    • On MacOS we set: -DGEANT4_USE_OPENGL_X11=OFF and -DGEANT4_USE_RAYTRACER_X11=OFF to avoid clashes with Qt visualisation.
  • Then execute: make -jN where N is the number of cores your machine has.
  • Then execute: sudo make install
• In your .bash_profile (in your home directory, press CMD+SHIFT+. to make the file visible) add the line . /usr/local/bin/geant4.sh so that the environment is set every time a new terminal window is opened.
• Install the DAWN visualisation package [12] (see README for installation instructions).
• Try compiling the basic example B1:
  • Navigate to source folder of example B1: cd /usr/local/share/Geant4-<your version here>/examples/basic/B1
  • Make a directory in which to build: sudo mkdir build and then move to this directory, cd build
  • Execute sudo cmake -DCMAKE_PREFIX_PATH=/usr/local/lib/Geant4-<your version here>/ /usr/local/share/Geant4-<your version here>/examples/basic/B1
  • Execute sudo make
  • Run the example: ./exampleB1
    • Known issue: On MacOS Catalina, upon trying to run the beam after the GUI is loaded, the app will crash with error: Illegal instruction: 4. It is unclear why this occurs. An unanswered forum post about this issue can be found here. This error should not prevent running of the QUARC simulation.

Running QUARC Detector Simulation

• You can copy the simulation files from this path on the HEP cluster: /unix/pbt/users/sshaikh/Simulation
• In the folder 'build', execute: sudo cmake -DCMAKE_PREFIX_PATH=/usr/local/lib/Geant4-<YOUR VERSION HERE>/ <YOUR PATH TO SIMULATION FOLDER>
• Then, execute: sudo make
• To run the simulation with the default macro, inter.mac, execute: ./ProtonSimulation
• To run the simulation with a different macro, e.g. interactive.mac, execute: ./ProtonSimulation ../macros/interactive.mac

Running QUARC Detector Simulation in Eclipse IDE

• Create new makefile project with existing code in Eclipse and choose the directory containing CMakeLists.txt as the Existing Code Location.
• Under Run -> External Tools -> External Tools Configurations:
  • Create a new launch configuration and set the variables Location to ${workspace_loc:/Simulation/eclipse_build.sh} and Working Directory to: ${workspace_loc:/Simulation/build} (adjust paths if needed).
  • This will run cmake, which is necessary before building.
  • Set Refresh behaviour to refresh the workspace after completion.
  • Uncheck Build Before Launch
• Under Project Properties –> C/C++ build:
  • Uncheck "Use Default Build Command" and "Generate Makefiles Automatically".
  • Set the build command to: make -jN where N is the number of cores your machine has.
  • Set the build location to: ${workspace_loc:/Simulation}/build, adjusting path if needed.
• Under Project Properties –> C/C++ General –> Paths and Symbols -> Includes, add the variables to include GEANT4 headers (for all languages and configurations, adjusting directories appropriately for your installations):
  • /usr/local/include/GEANT4
  • /usr/local/include/CLHEP (May not be necessary and requires non-GEANT4 installation of CLHEP).
  • /Applications/root_v6.20.00 (If ROOT is required)
• Under Run -> Run Configurations, create a new configuration of type C/C++ application for the project:
  • Set C/C++ application to build/ProtonSimulation
  • Under Arguments, set the working directory to: ${workspace_loc:Simulation}/build
  • Under Environment, define the variables pointing to GEANT4's data sets:
    • These are defined at the bottom of /usr/local/bin/geant4.sh under 'Export resource file paths'
    • e.g. Variable: G4ENSDFSTATEDATA, Value: /usr/local/share/Geant4-10.6.1/data/G4ENSDFSTATE2.2
    • There are 11 of them in GEANT4 10.6.1.
• To then run the simulation, run the external tool and then run the launch configuration (which by default will make and run the application).

General Notes

• In output file EdepAccurate, each number represents the energy deposited in the user-defined sheet thickness, divided by spatial resolution (not in file name)
  • e.g. EdepAccurate_252.7MeV_200x2_500mustep_100p_refl.out represents 252.7 MeV beam, 200 sheets of 2mm thickness, 500 micron StepMax, 100 protons, reflection allowed.
  • StepMax represents the minimum resolution in GEANT4’s tracking of particles, characteristics are calculated in distance intervals. If undefined, GEANT4 will choose a step size that represents the finest increment required by the various physics lists. Default value might be ~2mm.
• Can choose to record number of photons produced or number of photons that reach the edge of the scintillator. In the latter, allowing reflections is necessary.
  • Number of photons produced is stored in NPhoton
  • Number of photons that reach edge of scintillator is stored in NPhotonTop
• In file Hits, there is a list of all protons produced in simulation with their energy, 2 mystery numbers and their stopping depth.
  • Small numbers are indicative of a nuclear interaction, which results in a proton being deflected sufficient to warrant a new particle ID.
• The parameter rangeCut defines the minimum range of a secondary particle (electrons, positrons & gammas) such that it is tracked until it stops. Such particles with ranges below rangeCut just have their energy deposited in place and are then deleted. This is such to avoid long-computation times.
  • This does not however apply to any other secondaries, e.g. neutrons or alpha particles.
• Notation: e.g. /control/multiply x {y} {z}
  • x = y times z
  • Brackets are required when using previously defined variables
• Positional origin of simulation is in middle of scintillator
• It is more important to have sufficient numbers of protons in simulation in order to accurately simulate the energy deposition curve. While in reality approx. 10000 photons per MeV lost in protons is produced, this would take far too long to simulate and would require reducing the number of protons. However, the depth-light curve can only ever be as good as the energy deposition curve – so sampling more photons with only few protons will NOT give a good depth-light curve.

Existing Issues

• The macros, e.g. inter.mac attempt to define aspects of the detector geometry, but fail do so. It appears that GEANT4 defines a geometry based on PTDetectorConstruction and then does not allow the macro to update the geometry. See ProtonSimulation.cc: the macro is called after the geometry is defined. Find some code where a macro redefines the geometry successfully to find out where to place the macro-defined geometry parameters. Probably needs work in the Messenger source files or PTDetectorConstruction::UpdateGeometry().