wimprates 0.5.0
Differential rates of WIMP-nucleus scattering
License: MIT
Keywords: wimp,spin-dependent,spin-independent,bremsstrahlung,migdal

wimprates
=========

Differential rates of WIMP-nucleus scattering in the standard halo model, primarily for xenon detectors.

`https://github.com/JelleAalbers/wimprates`

[![DOI](https://zenodo.org/badge/117823144.svg)](https://zenodo.org/badge/latestdoi/117823144)
[![Test package](https://github.com/JelleAalbers/wimprates/actions/workflows/pytest.yml/badge.svg?branch=master)](https://github.com/JelleAalbers/wimprates/actions/workflows/pytest.yml)
[![Coverage Status](https://coveralls.io/repos/github/JelleAalbers/wimprates/badge.svg?branch=master)](https://coveralls.io/github/JelleAalbers/wimprates?branch=master)

Installation and usage
----------------------
 - `pip install wimprates`
 - [See this basic example for usage.](https://github.com/JelleAalbers/wimprates/blob/master/notebooks/Example.ipynb)

The package uses numericalunits (https://pypi.python.org/pypi/numericalunits); all function inputs
are expected to have proper units (except for the `rate_wimp_std` convenience function).


Features
--------
- Spin-indendent and spin-dependent DM-nucleus scattering;
- Elastic NR, bremsstrahlung, and Migdal effect detection mechanisms;
- Time dependent observed dark matter speed distribution (annual modulation only, no daily modulation);
- DM-electron scattering (experimental);
- Support for xenon (all models, default), argon, germanium, and silicon (many models).


How to cite
------------
- J. Aalbers, J. Angevaare, K. Morå, and B. Pelssers, wimprates: v0.4.1 (2022). https://doi.org/10.5281/zenodo.2604222.
- The original sources for models used in wimprates are:
  - **Spin-dependent scattering**: Klos, P. et al., [Phys.Rev. D88 (2013) no.8, 083516](https://journals.aps.org/prd/abstract/10.1103/PhysRevD.88.083516), Erratum: [Phys.Rev. D89 (2014) no.2, 029901](https://journals.aps.org/prd/abstract/10.1103/PhysRevD.89.029901). [[arXiv:1304.7684]](https://arxiv.org/abs/1304.7684)
  - **Bremsstrahlung**: C. Kouvaris and J. Pradler, [Phys. Rev. Lett. 118, 031803 (2017)](https://journals.aps.org/prl/abstract/10.1103/PhysRevLett.118.031803). [arXiv:1607.01789](https://arxiv.org/abs/1607.01789)
  - **Migdal effect**: M. Ibe et al., [JHEP 1803 (2018) 194](https://link.springer.com/article/10.1007/JHEP03(2018)194). [arXiv:1707.07258](https://arxiv.org/abs/1707.07258)
  - **Dark matter electron scattering**: R. Essig, T. Volansky, T.-T. Yu: [Phys. Rev. D 96, 043017 (2017)](https://journals.aps.org/prd/abstract/10.1103/PhysRevD.96.043017). [arXiv:1703.00910](https://arxiv.org/abs/1703.00910).
    - Ionization form factors from: T.-T. Yu, http://ddldm.physics.sunysb.edu/ddlDM/, 2018-11-05.

Contributors
-------------
 * Jelle Aalbers
 * Joran Angevaare
 * Knut Dundas Mora
 * Bart Pelssers





History
-------

0.5.0 (2023-02-13)
------------------
 * Change default v_0 and v_pec to match [current conventions](https://arxiv.org/abs/2105.00599) (#14)
 * If no time is provided, spectra are now calculated at a reference time (#14)
 * Fix bug where user-specified halo models would not override v_0 (#14)
 * Fix tests for numpy 1.24 (#15)

0.4.1 (2022-09-01)
------------------
 * Restore python 3.7 compatibility (#13)

0.4.0 (2022-08-14)
------------------
 * Fixes for alternate materials (#7)
 * Update notebooks, continuous integration tests (#9)

0.3.2 (2019-11-24)
------------------
* Fix technical release issue

0.3.1 (2019-11-24)
------------------
* Alternate materials for SI scattering (#4)
* Faster J200 timestamp conversion (#5)

0.3.0 (2019-07-22)
------------------
* Flexible halo model (#3)
* DM form factor choice for DM-electron scattering

0.2.2 (2019-03-27)
------------------
* DM-electron scattering

0.2.1 (2019-03-23)
------------------
* Fix package data specification

0.2.0 (2019-03-23)
------------------
* Annual modulation (#2)
* Migdal effect
* Configurable mediator mass
* Resistance to numericalunits.reset_units()
* Restructure as python package

0.1 (2018-01-17)
----------------
* Initial release