Update HISTORY and README for the release

HISTORY.md

@@ -3,6 +3,11 @@
 History
 -------
 
+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

README.md

@@ -1,7 +1,7 @@
 wimprates
 =========
 
-Differential rates of WIMP-nucleus scattering in the standard halo model, for liquid xenon detectors.
+Differential rates of WIMP-nucleus scattering in the standard halo model, primarily for xenon detectors.
 
 `https://github.com/JelleAalbers/wimprates`
 
@@ -15,29 +15,32 @@ Installation and usage
  - [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.
+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).
-- Under development: DM-electron scattering
+- 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, B. Pelssers and K. Morå, wimprates: v0.3.0 (2019). http://doi.org/10.5281/zenodo.3345959.
+- J. Aalbers, J. Angevaare, K. Morå, and B. Pelssers, wimprates: v0.4.0 (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)  
+  - **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) 
+  - **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
+ * Joran Angevaare
  * Knut Dundas Mora
+ * Bart Pelssers
+