Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

updated citation info and fixed codecov badge #34

Merged
merged 1 commit into from
Dec 14, 2021
Merged

updated citation info and fixed codecov badge #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions CITATION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}",
Expand All @@ -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.
},
Expand All @@ -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},
Expand Down Expand Up @@ -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}
}
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.

Expand Down