nrCascadeSim - a tool for generating nuclear recoil spectra resulting from neutron capture

The purpose of this code is to simulate energy deposits due to cascading of energy levels following neutron capture. This code was written for use in nuclear recoil calibration for dark matter detectors, but may be useful in other particle physics applications as well, including coherent elastic neutrino nucleus scattering (CEνNS). Currently, we use a constant acceleration model for the atom slowing down and calculation of the ionization energy. We also use the Lindhard model for calculating the ionization, but the output is complete enough to allow the user to choose their ionization yield model after simulation. The code currently supports Neon, Argon, Silicon, and Germanium cascades slowing down in a lattice of like material.

The documentation does not contain a review of the physics implemented in the library.

If you want to contribute to nrCascadeSim, please check out the contribution guidelines.

Contents:

• 1. Getting started
  • Installation
  • Using nrCascadeSim command-line tools
  • Using nrCascadeSim as a library
• 2. Executables of nrCascadeSim
  • Using realizeCascades command-line executable
  • realizeCascades cascade input file
  • realizeCascades cascade output file
• 3. The libraries of nrCascadeSim
  • cascadeProd.h
  • edepmath.h
  • lindhard.h
  • weisskopf.h
  • isotope_info.h
  • rootUtil.h
• 4. Examples: Putting it all together
  • Reading a Level Input File
  • Printing Isotope Information
  • Fetching an Ionization Yield Model
  • Generating a Single Cascade Realization and Saving
• 5. Documentation and Sphinx
• 6. Geant4 Comparison
  • Geant4
• Citing nrCascadeSim
  • How to cite
  • Research and research software using nrCascadeSim
• Release history
• License
• Contact & Support
• References