The WIMpy_NREFT
code (also known as just WIMpy
) allows you to calculate Dark Matter-Nucleus scattering rates in the framework of NREFT (see e.g. arXiv:1203.3542). The code is written in python, with more detailed documentation to appear soon.
The code currently supports operators to , as well as millicharged and magnetic dipole Dark Matter. The code can be used to generate spectra for Xenon, Argon, Carbon, Germanium, Iodine and Fluorine targets.
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:
- 29/09/2021: Version 1.1 - Some operators were missing powers of (q/mN)^2 in the rate calculation, which has now been corrected.
You can install WIMpy_NREFT
using pip
:
pip install git+https://github.com/bradkav/WIMpy_NREFT
Requires python3 as well as NumPy and SciPy.
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.
The code is still a work in progress, so be aware of the following:
If you use the WIMpy code, please cite it as
B. J. Kavanagh and T. D. P. Edwards, WIMpy NREFT v1.0 [Computer Software], doi:10.5281/zenodo.1230503. Available at https://github.com/bradkav/WIMpy_NREFT, (2018)
The corresponding bibtex is:
@misc{WIMpy-code,
author = {Kavanagh, Bradley J. and Edwards, Thomas D. P.},
title = {\textnormal{WIMpy\_NREFT v1.1 [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 = {2018}
}