WIMpy_NREFT

WIMpy_NREFT (also known as just WIMpy) is a python code which allows you to calculate Dark Matter-Nucleus scattering rates in the framework of NREFT (see e.g. arXiv:1203.3542, arXiv:1505.03117, arXiv:1907.02910).

The current version of the code (v1.2) supports operators $\mathcal{O}_1$ to $\mathcal{O}_{20}$ for spin-0, spin-1/2 and spin-1 Dark Matter, as well as millicharged and magnetic dipole Dark Matter. The code can be used to generate spectra for a wide range of targets including light elements such as Hydrogen and Helium, up to heavier targets typically used in direct searches, such as Xenon, Argon, Germanium, Iodine and Fluorine.

WIMpy_NREFT now includes functionality to calculate directional recoil spectra, as well as signals from coherent neutrino-nucleus scattering (including fluxes from the Sun, atmosphere and diffuse supernovae).

Authors: Bradley J Kavanagh, Tom D P Edwards.

For questions, comments or bug reports, please contact Bradley J Kavanagh (bradkav@gmail.com).

Updates:

• 30/10/2024: Version 1.2 - Extended to include all operators up to $\mathcal{O}_{20}$, with support for spin-1 DM
• 30/10/2024: Default branch renamed to main
• 27/04/2022: Fixed some bugs with incorrect nuclear response functions (this should only affect relatively rare parameter combinations for certain elements)
• 06/04/2022: Added new targets to Nuclei.txt.
• 29/09/2021: Version 1.1 - Some operators were missing powers of (q/mN)^2 in the rate calculation, which has now been corrected.

Installation

You can install WIMpy_NREFT using pip:

pip install git+https://github.com/bradkav/WIMpy_NREFT

Requires python3 as well as NumPy and SciPy.

Usage

Most of the relevant routines are contained in the module DMUtils.py. Load with

from WIMpy import DMUtils as DMU

For how to use the routines, there are a number of examples in the Examples/ folder:

• NREFT_example.ipynb, which contains examples of how to use the different parts of the code, including calculating a range of spectra.
• Spectra.ipynb, which can be used to generate plots of spectra for all NREFT operators and a range of experiments.
• Directional.ipynb, which demonstrates how to calculate directional recoil spectra, as well as how to transform into different coordinate systems and account for time-integrated directionality.
• Neutrinos.ipynb, which shows how to calculate neutrino-nucleus scattering spectra.

Citation

If you use the WIMpy code, please cite it as

B. J. Kavanagh and T. D. P. Edwards, WIMpy NREFT v1.2 [Computer Software], doi:10.5281/zenodo.1230503. Available at https://github.com/bradkav/WIMpy_NREFT, (2024)

The corresponding bibtex is:

@misc{WIMpy-code,
author = {Kavanagh, Bradley J. and Edwards, Thomas D. P.},
title = {\textnormal{WIMpy\_NREFT v1.2 [Computer Software]}, \href{https://doi.org/10.5281/zenodo.1230503}{\textnormal{doi:10.5281/zenodo.1230503}}\textnormal{. Available at }\url{https://github.com/bradkav/WIMpy_NREFT}},
year = {2024}
}

Publications

The code has been used in a number of publications, including:

• Troubles mounting for multipolar dark matter, D. Bose et al., arXiv:2312.05131
• Dark Matter from Monogem, C. Cappiello et al., arXiv:2210.09448
• Results on photon-mediated dark matter-nucleus interactions from the PICO-60 C3F8 bubble chamber, Ali et al. (PICO Collaboration, 2022), arXiv:2204.10340
• Constraints on dark matter-nucleon effective couplings in the presence of kinematically distinct halo substructures using the DEAP-3600 detector, Adhikari et al., (DEAP-3600 Collaboration, 2020), arXiv:2005.14667
• Digging for dark matter: Spectral analysis and discovery potential of paleo-detectors, Edwards et al. (2019), arXiv:1811.10549
• Dark Matter Model or Mass, but Not Both: Assessing Near-Future Direct Searches with Benchmark-free Forecasting, Edwards, Kavanagh & Weniger (2018), arXiv:1805.04117