obscura - Direct detection of dark matter with nucleus and electron recoil experiments

A modular C++ tool and library for dark matter direct detection computations for both nuclear and electron recoil experiments.

You can find more detailed documentation of obscura here. The documentation contains e.g. a guide to get started and a list of all included experiments.

CITATION

If you decide to use this code, or if you want to add a reference to it, please cite both the paper and the code.

Emken, T., obscura: A modular C++ tool and library for the direct detection of (sub-GeV) dark matter via nuclear and electron recoils, Journal of Open Source Software, 6(68), 3725, 2021.

Emken, T., 2021, obscura - A C++ library for dark matter detection computations [Code] [DOI:10.5281/zenodo.4557187].

Bibtex entries

@article{Emken:2021uzb,
    author = "Emken, Timon",
    title = "{obscura: A modular C++ tool and library for the direct detection of (sub-GeV) dark matter via nuclear and electron recoils}",
    eprint = "2112.01489",
    archivePrefix = "arXiv",
    primaryClass = "hep-ph",
    doi = "10.21105/joss.03725",
    journal = "J. Open Source Softw.",
    volume = "6",
    pages = "3725",
    year = "2021"
}

@software{obscura,
  author = {Emken, Timon},
  title = {{obscura - A C++ library for dark matter detection computations [Code]}},
  year         = {2021},
  publisher    = {Zenodo},
  doi          = {DOI:10.5281/zenodo.4557187},
  url          = {https://doi.org/10.5281/zenodo.4557187},
  howpublished={The code can be found under \url{https://github.com/temken/obscura}.}
}

Cite a specific version (e.g. v1.0.1)

If you want to cite a specific version, please cite the respective DOI that can be found here. For example, for v1.0.1:

Emken, T., 2021, obscura - A C++ library for dark matter detection computations [Code v1.0.1] [DOI:10.5281/zenodo.5956877].

The corresponding bibtex entry:

@software{obscura_1_0_1,
  author = {Emken, Timon},
  title = {{obscura - A C++ library for dark matter detection computations [Code, v1.0.1]}},
  year         = {2021},
  publisher    = {Zenodo},
  version      = {v1.0.1},
  doi          = {DOI:10.5281/zenodo.5956877},
  url          = {https://doi.org/10.5281/zenodo.5956877},
  howpublished={The code can be found under \url{https://github.com/temken/obscura}.}
}

VERSION HISTORY

• 29.04.2024: Release of version 1.1.0
• 10.11.2021: Release of version 1.0.0
• 23.02.2021: Release of version 0.1.0

AUTHORS & CONTACT

The author of obscura is Timon Emken.

For questions, support, bug reports, or other suggestions, please contact [email protected] or open an issue.

LICENSE

This project is licensed under the MIT License - see the LICENSE file.