From 96411956f994cb9d0ddaa0bf70f278164863e2b4 Mon Sep 17 00:00:00 2001 From: Jordan Mirocha Date: Tue, 14 Dec 2021 08:31:10 -0500 Subject: [PATCH] updated citation info and fixed codecov badge --- CITATION | 29 +++++++++++++++++++++-------- README.md | 6 +++--- 2 files changed, 24 insertions(+), 11 deletions(-) diff --git a/CITATION b/CITATION index 39e8ea685..e6fb48c2f 100755 --- a/CITATION +++ b/CITATION @@ -1,10 +1,7 @@ -If you use any of the global 21-cm signal or UV/X-ray radiation background stuff, you should cite -citing: +If you use any of the global 21-cm signal or UV/X-ray radiation background stuff, you should cite: Mirocha, J., 2014, MNRAS, 443, 1211 -For BibTex users: - @ARTICLE{2014MNRAS.443.1211M, author = {{Mirocha}, J.}, title = "{Decoding the X-ray properties of pre-reionization era sources}", @@ -21,12 +18,10 @@ archivePrefix = "arXiv", adsnote = {Provided by the SAO/NASA Astrophysics Data System} } -For the 1-D radiative transfer or SED optimization, please cite: +For the 1-D radiative transfer please cite: Mirocha, J., Skory, S., Burns, J.O., Wise, J.W., 2012, ApJ, 756, 94 -For BibTex users: - @ARTICLE{2012ApJ...756...94M, author = {{Mirocha}, J. and {Skory}, S. and {Burns}, J.~O. and {Wise}, J.~H. }, @@ -46,7 +41,7 @@ archivePrefix = "arXiv", adsnote = {Provided by the SAO/NASA Astrophysics Data System} } -For global 21-cm calculations using new UVLF-based model, please cite +For global 21-cm calculations using the UVLF-based model, please cite @ARTICLE{2017MNRAS.464.1365M, author = {{Mirocha}, Jordan and {Furlanetto}, Steven R. and {Sun}, Guochao}, @@ -87,4 +82,22 @@ archivePrefix = {arXiv}, adsnote = {Provided by the SAO/NASA Astrophysics Data System} } +If you use any of the more sophisticated galaxy modeling stuff, e.g., dust reddening, spectral synthesis, please consider citing +@ARTICLE{2020MNRAS.498.2645M, + author = {{Mirocha}, Jordan and {Mason}, Charlotte and {Stark}, Daniel P.}, + title = "{Effects of self-consistent rest-ultraviolet colours in semi-empirical galaxy formation models}", + journal = {\mnras}, + keywords = {dust, extinction, galaxies: evolution, galaxies: high-redshift, galaxies: ISM, Astrophysics - Astrophysics of Galaxies}, + year = 2020, + month = oct, + volume = {498}, + number = {2}, + pages = {2645-2661}, + doi = {10.1093/mnras/staa2586}, +archivePrefix = {arXiv}, + eprint = {2005.07208}, + primaryClass = {astro-ph.GA}, + adsurl = {https://ui.adsabs.harvard.edu/abs/2020MNRAS.498.2645M}, + adsnote = {Provided by the SAO/NASA Astrophysics Data System} +} diff --git a/README.md b/README.md index ee9eaf302..f41f7724c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # **ARES** -[![Documentation Status](https://readthedocs.org/projects/ares/badge/?version=latest)](http://ares.readthedocs.io/en/latest/?badge=latest) ![Tests](https://github.com/mirochaj/ares/actions/workflows/test_suite.yaml/badge.svg) [![codecov](https://codecov.io/gh/mirochaj/ares/branch/master/graph/badge.svg?token=Q3CCKIMQJF)](https://codecov.io/gh/mirochaj/ares) [![Last Commit](https://img.shields.io/github/last-commit/mirochaj/ares)](https://img.shields.io/github/last-commit/mirochaj/ares) +[![Documentation Status](https://readthedocs.org/projects/ares/badge/?version=latest)](http://ares.readthedocs.io/en/latest/?badge=latest) ![Tests](https://github.com/mirochaj/ares/actions/workflows/test_suite.yaml/badge.svg) [![codecov](https://codecov.io/gh/mirochaj/ares/branch/main/graph/badge.svg?token=Q3CCKIMQJF)](https://codecov.io/gh/mirochaj/ares) [![Last Commit](https://img.shields.io/github/last-commit/mirochaj/ares)](https://img.shields.io/github/last-commit/mirochaj/ares) The Accelerated Reionization Era Simulations (ARES) code was designed to rapidly generate models for the global 21-cm signal. It can also be used as a @@ -26,12 +26,12 @@ risk! Correctness of results is not guaranteed. ## Citation -If you use ARES in paper please reference [Mirocha (2014)](http://adsabs.harvard.edu/abs/2014MNRAS.443.1211M) if it's an application of the global 21-cm modeling machinery and [Mirocha et al. (2012)](http://adsabs.harvard.edu/abs/2012ApJ...756...94M) if you use the 1-D radiative transfer and/or SED optimization. Note that for some applications, ARES relies heavily on lookup tables and publicly-available software packages that should be referenced as well. These include: +If you use ARES in paper please reference [Mirocha (2014)](http://adsabs.harvard.edu/abs/2014MNRAS.443.1211M) if it's an application of the global 21-cm modeling machinery and [Mirocha et al. (2012)](http://adsabs.harvard.edu/abs/2012ApJ...756...94M) if you use the 1-D radiative transfer. Note that for some applications, ARES relies heavily on lookup tables and publicly-available software packages that should be referenced as well. These include: - [CAMB](https://camb.readthedocs.io/en/latest/) - [hmf](https://hmf.readthedocs.io/en/latest/) - Collisional coupling coefficients from [Zygelman (2005)](https://ui.adsabs.harvard.edu/abs/2005ApJ...622.1356Z/abstract). -- Lyman:math:`\alpha` transition probabilities from [Pritchard \& Furlanetto](https://ui.adsabs.harvard.edu/abs/2006MNRAS.367.1057P/abstract). +- Lyman-alpha transition probabilities from [Pritchard \& Furlanetto](https://ui.adsabs.harvard.edu/abs/2006MNRAS.367.1057P/abstract). Please also provide a link to [this page](https://github.com/mirochaj/ares) as a footnote.