wimprates 0.2.2

Differential rates of WIMP-nucleus scattering

wimprates
=========

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

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

[](https://travis-ci.org/JelleAalbers/wimprates)
[](https://zenodo.org/badge/latestdoi/117823144)

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.


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).
- Under development: DM-electron scattering


How to cite
------------
- When citing wimpates, please list the DOI of the version you're using. Click the DOI badge above for more information.
- Please cite the original sources for the different models you use:
- **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
* Bart Pelssers



History
-------


------------------
0.2.2 (2019-03-27)
------------------
* DM-electon scattering (under development)


------------------
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