{"id":24327896,"url":"https://github.com/temken/obscura","last_synced_at":"2025-09-27T12:31:26.126Z","repository":{"id":42569557,"uuid":"250298432","full_name":"temken/obscura","owner":"temken","description":"A modular C++ tool and library for dark matter direct detection computations for both nuclear and electron recoil experiments.","archived":false,"fork":false,"pushed_at":"2024-04-29T07:30:17.000Z","size":20789,"stargazers_count":5,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-04-29T08:35:08.104Z","etag":null,"topics":["dark-matter","direct-detection-experiments"],"latest_commit_sha":null,"homepage":"https://obscura.readthedocs.io/en/latest/","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/temken.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-26T15:34:51.000Z","updated_at":"2024-04-29T08:35:15.830Z","dependencies_parsed_at":"2024-01-24T11:00:40.146Z","dependency_job_id":null,"html_url":"https://github.com/temken/obscura","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":"temken/cpp_cmake_template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temken%2Fobscura","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temken%2Fobscura/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temken%2Fobscura/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temken%2Fobscura/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/temken","download_url":"https://codeload.github.com/temken/obscura/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234435226,"owners_count":18832093,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dark-matter","direct-detection-experiments"],"created_at":"2025-01-17T22:17:56.157Z","updated_at":"2025-09-27T12:31:18.395Z","avatar_url":"https://github.com/temken.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://github.com/temken/obscura/workflows/Build%20Status/badge.svg)](https://github.com/temken/obscura/actions)\n[![codecov](https://codecov.io/gh/temken/obscura/branch/main/graph/badge.svg)](https://codecov.io/gh/temken/obscura)\n[![Documentation Status](https://readthedocs.org/projects/obscura/badge/?version=latest)](https://obscura.readthedocs.io/en/latest/?badge=latest)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\n# obscura - Direct detection of dark matter with nucleus and electron recoil experiments\n\n[![status](https://joss.theoj.org/papers/fd8076268036956d3bf08193c4fc2db9/status.svg)](https://joss.theoj.org/papers/fd8076268036956d3bf08193c4fc2db9)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4557187.svg)](https://doi.org/10.5281/zenodo.4557187)\n\nA modular C++ tool and library for dark matter direct detection computations for both nuclear and electron recoil experiments.\n\n\u003cimg src=\"paper/FlowChart.png\" width=\"500\"\u003e\n\nYou can find more detailed documentation of *obscura* [here](https://obscura.readthedocs.io/en/latest/index.html). The documentation contains e.g. a [guide to get started](https://obscura.readthedocs.io/en/latest/01_Getting_Started.html) and a [list of all included experiments](https://obscura.readthedocs.io/en/latest/08_Experiments.html).\n\n## CITATION\n\nIf you decide to use this code, or if you want to add a reference to it, please cite both the paper and the code.\n\n\u003e 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](https://joss.theoj.org/papers/10.21105/joss.03725).\n\n\u003e Emken, T., 2021, obscura - A C++ library for dark matter detection computations [Code] [[DOI:10.5281/zenodo.4557187]](https://zenodo.org/record/4557187).\n\n\u003cdetails\u003e\u003csummary\u003eBibtex entries\u003c/summary\u003e\n\u003cp\u003e\n\n```\n@article{Emken:2021uzb,\n    author = \"Emken, Timon\",\n    title = \"{obscura: A modular C++ tool and library for the direct detection of (sub-GeV) dark matter via nuclear and electron recoils}\",\n    eprint = \"2112.01489\",\n    archivePrefix = \"arXiv\",\n    primaryClass = \"hep-ph\",\n    doi = \"10.21105/joss.03725\",\n    journal = \"J. Open Source Softw.\",\n    volume = \"6\",\n    pages = \"3725\",\n    year = \"2021\"\n}\n```\n\n```\n@software{obscura,\n  author = {Emken, Timon},\n  title = {{obscura - A C++ library for dark matter detection computations [Code]}},\n  year         = {2021},\n  publisher    = {Zenodo},\n  doi          = {DOI:10.5281/zenodo.4557187},\n  url          = {https://doi.org/10.5281/zenodo.4557187},\n  howpublished={The code can be found under \\url{https://github.com/temken/obscura}.}\n}\n```\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eCite a specific version (e.g. v1.0.1)\u003c/summary\u003e\n\u003cp\u003e\n\nIf you want to cite a specific version, please cite the respective DOI that can be found [here](https://zenodo.org/record/4557187). For example, for v1.0.1:\n\n\u003e Emken, T., 2021, obscura - A C++ library for dark matter detection computations [Code v1.0.1] [[DOI:10.5281/zenodo.5956877]](https://zenodo.org/record/5956877).\n\nThe corresponding bibtex entry:\n\n```\n@software{obscura_1_0_1,\n  author = {Emken, Timon},\n  title = {{obscura - A C++ library for dark matter detection computations [Code, v1.0.1]}},\n  year         = {2021},\n  publisher    = {Zenodo},\n  version      = {v1.0.1},\n  doi          = {DOI:10.5281/zenodo.5956877},\n  url          = {https://doi.org/10.5281/zenodo.5956877},\n  howpublished={The code can be found under \\url{https://github.com/temken/obscura}.}\n}\n```\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n## VERSION HISTORY\n\n- 29.04.2024: Release of version 1.1.0\n- 10.11.2021: Release of version 1.0.0\n- 23.02.2021: Release of version 0.1.0\n\n## AUTHORS \u0026 CONTACT\n\nThe author of *obscura* is [Timon Emken](https://timonemken.com/).\n\nFor questions, support, bug reports, or other suggestions, please contact [timon.emken@fysik.su.se](mailto:timon.emken@fysik.su.se) or open an [issue](https://github.com/temken/obscura/issues).\n\n\n## LICENSE\n\nThis project is licensed under the MIT License - see the LICENSE file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftemken%2Fobscura","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftemken%2Fobscura","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftemken%2Fobscura/lists"}