Skip to content

Commit d5faea8

Browse files
author
sambit-giri
committed
citation section
1 parent b53b31a commit d5faea8

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[![PyPI version](https://badge.fury.io/py/tools21cm.svg)](https://badge.fury.io/py/tools21cm)
88
[![Read the Docs](https://readthedocs.org/projects/tools21cm/badge/?version=latest)](https://tools21cm.readthedocs.io/)
99

10-
A python package for analysing simulated 21-cm signals from the Epoch of Reionization (EoR) and Cosmic Dawn (CD). Full documentation (with examples, installation instructions and complete module description) can be found at [readthedocs](https://tools21cm.readthedocs.io/).
10+
A python package for analysing simulated 21-cm signal during the Epoch of Reionization (EoR) and Cosmic Dawn (CD). Full documentation (with examples, installation instructions and complete module description) can be found at [readthedocs](https://tools21cm.readthedocs.io/).
1111

1212
## Package details
1313

@@ -87,6 +87,27 @@ For testing, one can use [pytest](https://docs.pytest.org/en/stable/) or [nosete
8787

8888
nosetests -v
8989

90+
## 📖 Citation
91+
92+
If you use `tools21cm` in your work, please cite the following paper:
93+
94+
> Giri, S., Mellema, G., \& Jensen, H. (2020). Tools21cm: A python package to analyse the large-scale 21-cm signal from the Epoch of Reionization and Cosmic Dawn. Journal of Open Source Software, 5(52), 2363.
95+
> [https://doi.org/10.21105/joss.02363](https://doi.org/10.21105/joss.02363)
96+
97+
BibTeX:
98+
```bibtex
99+
@article{giri2020tools21cm,
100+
title={Tools21cm: A python package to analyse the large-scale 21-cm signal from the Epoch of Reionization and Cosmic Dawn},
101+
author={Giri, Sambit and Mellema, Garrelt and Jensen, Hannes},
102+
journal={Journal of Open Source Software},
103+
volume={5},
104+
number={52},
105+
pages={2363},
106+
year={2020},
107+
publisher={Open Journals}
108+
}
109+
```
110+
90111
## CONTRIBUTING
91112

92113
If you find any bugs or unexpected behavior in the code, please feel free to open a [Github issue](https://github.com/sambit-giri/tools21cm/issues). The issue page is also good if you seek help or have suggestions for us. For more details, please see [here](https://tools21cm.readthedocs.io/contributing.html).

0 commit comments

Comments
 (0)