Skip to content

Commit b072741

Browse files
author
Joe Hamman
authored
add faq on how to cite xarray (#941)
* add faq on how to cite xarray * respond to @shoyer's comments
1 parent 9d8bb13 commit b072741

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

README.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ xarray: N-D labeled arrays and datasets
1111
:target: https://pypi.python.org/pypi/xarray/
1212
.. image:: https://badges.gitter.im/Join%20Chat.svg
1313
:target: https://gitter.im/pydata/xarray
14+
.. image:: https://zenodo.org/badge/doi/10.5281/zenodo.59499.svg
15+
:target: http://dx.doi.org/10.5281/zenodo.59499
1416

1517
**xarray** (formerly **xray**) is an open source project and Python package that aims to bring the
1618
labeled data power of pandas_ to the physical sciences, by providing

doc/faq.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,3 +132,41 @@ pandas) make it a faster and more flexible data analysis tool. That said, Iris
132132
and CDAT have some great domain specific functionality, and we would love to
133133
have support for converting their native objects to and from xarray (see
134134
:issue:`37` and :issue:`133`)
135+
136+
How should I cite xarray?
137+
-------------------------
138+
139+
If you are using xarray and would like to cite it in academic publication, we
140+
would certainly appreciate it. We recommend two citations.
141+
142+
1. At a minimum, we recommend citing the xarray overview journal article,
143+
to be submitted to the Journal of Open Research Software.
144+
145+
- Hoyer, S., Hamman, J. (In preparation). Xarray: N-D labeled arrays and
146+
datasets in Python. Journal of Open Research Software.
147+
148+
Here’s an example of a BibTeX entry::
149+
150+
@article{hoyer2016xarray,
151+
title = {xarray: {N-D} labeled arrays and datasets in {Python}},
152+
author = {Hoyer, S. and J. Hamman},
153+
journal = {in prep, J. Open Res. Software},
154+
year = {2016}
155+
}
156+
157+
2. You may also want to cite a specific version of the xarray package. We
158+
provide a `Zenodo`__ citation and DOI for this purpose.
159+
160+
- Hoyer, S. et al.. (2016). xarray: v0.8.0. Zenodo. 10.5281/zenodo.59499
161+
162+
An example BibTeX entry::
163+
164+
@misc{xarray_v0_8_0,
165+
author = {Stephan Hoyer and Clark Fitzgerald and Joe Hamman and others},
166+
title = {xarray: v0.8.0},
167+
month = aug,
168+
year = 2016,
169+
doi = {10.5281/zenodo.59499},
170+
url = {http://dx.doi.org/10.5281/zenodo.59499}
171+
}
172+
__ https://zenodo.org

0 commit comments

Comments
 (0)