remage#

remage is a modern C++ simulation framework for germanium experiments.

Quick start#

The installation process is documented in Installation.

Warning

A proper user guide is not available yet. In the meanwhile, users can have a look at the Basic Tutorial or the provided examples.

In the simplest application, the user can simulate in an existing GDML geometry through the remage executable:

$ remage --help
remage: simulation framework for germanium experiments
Usage: ./src/remage [OPTIONS] [macros...]

Positionals:
  macros FILE ...             Macro files

Options:
  -h,--help                   Print this help message and exit
  -q                          Print only warnings and errors
  -v [0]                      Increase verbosity
  -l,--log-level LEVEL [summary]
                              Logging level debug|detail|summary|warning|error|fatal|nothing
  -i,--interactive            Run in interactive mode
  -t,--threads INT            Number of threads
  -g,--gdml-files FILE ...    GDML files
  -o,--output-file FILE       Output file for detector hits

Macro files can use all available upstream Geant4 macro commands, as well as the remage macro interface

Advanced applications can extend remage and link against libremage with the usual CMake syntax:

project(myapp)
find_package(remage)
# add_library(myapp ...)
# add_executable(myapp ...)
target_link_libraries(myapp PRIVATE RMG::remage)

Next steps#