Skip to content

LDMX-Software/G4DarkBreM

Repository files navigation

G4DarkBreM

Geant4 Dark Bremmstrahlung from MadGraph

The version submitted in 2022 to Computer Physics Communications is release v1.1.1. Ongoing development of this package is maintained at on GitHub LDMX-Software/G4DarkBreM. A seminar was given to provide more detail on this technique - the slides (with speaker notes) are available on the documentation website.

Installation

The only dependencies of G4DarkBreM are Geant4 which has an extensive installation guide and Boost which can be installed from the website or via your package manager (e.g. on Ubuntu).

As defined by our CMake infrastructure, the minimum versions of these dependencies are 1.68 for Boost and 10.2.3 for Geant4. We use the Boost.Math and Boost.Iostreams subcomponents of Boost if you wish to limit the size of the Boost needed to be installed.

While G4DarkBreM is not explicitly limited to a certain platform, it has only been used on Linux-based operating systems and explicitly uses C++11 standard features.

After installing Geant4, one can build and install G4DarkBreM using tools probably used to install Geant4 (if built from scratch).

cmake -B build -S . -DCMAKE_INSTALL_PREFIX=<my-install>
cd build
make install

Additionally, G4DarkBreM can be pulled into a more expansive simulation framework as a submodule and included as a subdirectory in CMake

add_subdirectory(G4DarkBreM)

This defines the G4DarkBreM cmake target which later targets can link to, for example

target_link_libraries(MySim PUBLIC G4DarkBreM)

Usage

Getting started can be done by looking at the configuration page and the g4db::example namespace which holds a fully functional (though primitive) Geant4 simulation example.

Validation

Analysis and validation of G4DarkBreM has been studied in another repository tomeichlersmith/ldmx-sim-technique. This repository also stands as an example for integrating G4DarkBreM into a larger simulation and processing framework.