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

Improve the citation information #1614

Merged
merged 2 commits into from Dec 18, 2020
Merged

Improve the citation information #1614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ead4300
DOC: Improve the citation information (Closes #1594)
dopplershift Dec 18, 2020
aeaac3f
MNT: Fix linkchecker failing on Twitter link
dopplershift Dec 18, 2020
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
4 changes: 3 additions & 1 deletion docs/conf.py
View file
Open in desktop
Expand Up @@ -354,6 +354,8 @@
r'https://codecov.io/github/Unidata/MetPy',
r'https://youtu\.be/[\d\w\-_]+',
# AMS DOIs should be stable, but resolved link consistently 403's with linkcheck
r'https://doi.org/10.1175/.*']
r'https://doi.org/10.1175/.*',
# Giving 404s right now and is not going to change
r'https://twitter.com/MetPy']

linkcheck_request_headers = {'https://www.ncdc.noaa.gov/': {'Accept-Encoding': 'deflate'}}
26 changes: 19 additions & 7 deletions docs/userguide/citing.rst
View file
Open in desktop
Expand Up @@ -17,28 +17,40 @@ Example BibTeX entry:
.. parsed-literal::

@software{metpy,
author = {May, Ryan M. and Arms, Sean C. and Marsh, Patrick and Bruning, Eric and Leeman, John R.
and Goebbert, Kevin and Thielen, Jonathan E. and Bruick, Zachary S.},
author = {May, Ryan M. and Arms, Sean C. and Marsh, Patrick and Bruning, Eric and Leeman,
John R. and Goebbert, Kevin and Thielen, Jonathan E. and Bruick, Zachary S.},
organization = {Unidata},
title = {MetPy: A {Python} Package for Meteorological Data},
year = {2008 - |cite_year|},
year = {|cite_year|},
version = {|cite_version|},
doi = {10.5065/D6WW7G29},
url = {https://github.com/Unidata/MetPy},
address = {Boulder, Colorado}
}


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

AMS suggested BibTeX entry:

.. parsed-literal::

@misc{metpy,
author = {May, Ryan M. and Arms, Sean C. and Marsh, Patrick and Bruning, Eric and Leeman,
John R. and Goebbert, Kevin and Thielen, Jonathan E. and Bruick, Zachary S.},
publisher = {Unidata},
title = {MetPy: A {Python} Package for Meteorological Data},
year = {|cite_year|},
doi = {10.5065/D6WW7G29},
note = {\url{https://github.com/Unidata/MetPy}},
}


Example Citation:

.. parsed-literal::

May, R. M., Arms, S. C., Marsh, P., Bruning, E., Leeman, J. R., Goebbert, K., Thielen, J. E.,
and Bruick, Z., |cite_year|: MetPy: A Python Package for Meteorological Data.
Version |cite_version|, Unidata, Accessed |access_date|.
[Available online at https://github.com/Unidata/MetPy.]
doi:10.5065/D6WW7G29.
Unidata, https://github.com/Unidata/MetPy, doi:10.5065/D6WW7G29.