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.

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

ENH: Add information for citing MetPy in publications #384

Merged
merged 2 commits into from
Apr 3, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CITATION.txt
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
include README.rst
include CITATION.txt
include AUTHORS.txt
include LICENSE
include CONTRIBUTING.md
include versioneer.py
Expand Down
39 changes: 39 additions & 0 deletions docs/citing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.. _Citing_MetPy:

Citing MetPy
============

If MetPy played an important role in your research, then please add us to
your reference list using one of the options below.

DOI: `10.5065/D6WW7G29 <https://doi.org/10.5065/D6WW7G29>`_

************
BibTeX entry
************

Example BibTeX entry::

@software{metpy,
author = {May, Ryan and Arms, Sean and Marsh, Patrick and Bruning, Eric and Leeman, John },
organization = {Unidata},
title = {MetPy: A {Python} Package for Meteorological Data},
year = {2008 - 2017},
version = {0.4.3},
doi = {10.5065/D6WW7G29},
url = {https://github.com/Unidata/MetPy},
address = {Boulder, Colorado}
}


*****************
AMS Journal Style
*****************

Example Citation::

May, R. M., Arms, S. C., Marsh, P., Bruning, E. and Leeman, J. R., 2017:
MetPy: A Python Package for Meteorological Data.
Unidata, Accessed 31 March 2017.
[Available online at https://github.com/Unidata/MetPy.]
doi:10.5065/D6WW7G29.
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Documentation
tutorials/index
api/index
developerguide
citing
references

----------
Expand All @@ -51,6 +52,7 @@ Contact Us
`GitHub issue tracker`__
* MetPy has a Gitter_ chatroom for more "live" communication
* MetPy can also be found on Twitter_
* If you use MetPy in a publication, please see :ref:`Citing_MetPy`.

.. _python-users: https://www.unidata.ucar.edu/support/#mailinglists
.. _GitHub: https://github.com/Unidata/MetPy
Expand Down