Merge pull request #384 from dopplershift/citation

ENH: Add information for citing MetPy in publications
Unidata · Apr 3, 2017 · a0dbfd3 · a0dbfd3
2 parents 7254119 + c2e64fa
commit a0dbfd3
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 0 deletions.
diff --git a/CITATION.txt b/CITATION.txt
@@ -0,0 +1 @@
+docs/citing.rst
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,6 @@
 include README.rst
+include CITATION.txt
+include AUTHORS.txt
 include LICENSE
 include CONTRIBUTING.md
 include versioneer.py

diff --git a/docs/citing.rst b/docs/citing.rst
@@ -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.
diff --git a/docs/index.rst b/docs/index.rst
@@ -38,6 +38,7 @@ Documentation
    tutorials/index
    api/index
    developerguide
+   citing
    references
 
 ----------
@@ -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