Skip to content

Commit 9641195

Browse files
committedDec 14, 2021
updated citation info and fixed codecov badge
1 parent acf2ba3 commit 9641195

File tree

2 files changed

+24
-11
lines changed

2 files changed

+24
-11
lines changed
 

‎CITATION

+21-8
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
If you use any of the global 21-cm signal or UV/X-ray radiation background stuff, you should cite
2-
citing:
1+
If you use any of the global 21-cm signal or UV/X-ray radiation background stuff, you should cite:
32

43
Mirocha, J., 2014, MNRAS, 443, 1211
54

6-
For BibTex users:
7-
85
@ARTICLE{2014MNRAS.443.1211M,
96
author = {{Mirocha}, J.},
107
title = "{Decoding the X-ray properties of pre-reionization era sources}",
@@ -21,12 +18,10 @@ archivePrefix = "arXiv",
2118
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
2219
}
2320

24-
For the 1-D radiative transfer or SED optimization, please cite:
21+
For the 1-D radiative transfer please cite:
2522

2623
Mirocha, J., Skory, S., Burns, J.O., Wise, J.W., 2012, ApJ, 756, 94
2724

28-
For BibTex users:
29-
3025
@ARTICLE{2012ApJ...756...94M,
3126
author = {{Mirocha}, J. and {Skory}, S. and {Burns}, J.~O. and {Wise}, J.~H.
3227
},
@@ -46,7 +41,7 @@ archivePrefix = "arXiv",
4641
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
4742
}
4843

49-
For global 21-cm calculations using new UVLF-based model, please cite
44+
For global 21-cm calculations using the UVLF-based model, please cite
5045

5146
@ARTICLE{2017MNRAS.464.1365M,
5247
author = {{Mirocha}, Jordan and {Furlanetto}, Steven R. and {Sun}, Guochao},
@@ -87,4 +82,22 @@ archivePrefix = {arXiv},
8782
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
8883
}
8984

85+
If you use any of the more sophisticated galaxy modeling stuff, e.g., dust reddening, spectral synthesis, please consider citing
9086

87+
@ARTICLE{2020MNRAS.498.2645M,
88+
author = {{Mirocha}, Jordan and {Mason}, Charlotte and {Stark}, Daniel P.},
89+
title = "{Effects of self-consistent rest-ultraviolet colours in semi-empirical galaxy formation models}",
90+
journal = {\mnras},
91+
keywords = {dust, extinction, galaxies: evolution, galaxies: high-redshift, galaxies: ISM, Astrophysics - Astrophysics of Galaxies},
92+
year = 2020,
93+
month = oct,
94+
volume = {498},
95+
number = {2},
96+
pages = {2645-2661},
97+
doi = {10.1093/mnras/staa2586},
98+
archivePrefix = {arXiv},
99+
eprint = {2005.07208},
100+
primaryClass = {astro-ph.GA},
101+
adsurl = {https://ui.adsabs.harvard.edu/abs/2020MNRAS.498.2645M},
102+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
103+
}

‎README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# **ARES**
2-
[![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)
2+
[![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)
33

44
The Accelerated Reionization Era Simulations (ARES) code was designed to
55
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.
2626

2727
## Citation
2828

29-
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:
29+
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:
3030

3131
- [CAMB](https://camb.readthedocs.io/en/latest/)
3232
- [hmf](https://hmf.readthedocs.io/en/latest/)
3333
- Collisional coupling coefficients from [Zygelman (2005)](https://ui.adsabs.harvard.edu/abs/2005ApJ...622.1356Z/abstract).
34-
- Lyman:math:`\alpha` transition probabilities from [Pritchard \& Furlanetto](https://ui.adsabs.harvard.edu/abs/2006MNRAS.367.1057P/abstract).
34+
- Lyman-alpha transition probabilities from [Pritchard \& Furlanetto](https://ui.adsabs.harvard.edu/abs/2006MNRAS.367.1057P/abstract).
3535

3636
Please also provide a link to [this page](https://github.com/mirochaj/ares) as a footnote.
3737

0 commit comments

Comments
 (0)
Please sign in to comment.