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

Add DOIs to citations on RTD #815

Merged
merged 2 commits into from
Jul 26, 2024
+13 −5
Merged

Add DOIs to citations on RTD #815

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
812f238
Add DOIs to citations on RTD
trey-stafford Jul 25, 2024
941e4a8
Add missing period to citation
trey-stafford Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions doc/citing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,39 +44,47 @@ An asterisk (`*`) indicates co-equal lead authorship (listed alphabetically).

> Moon, T. A., M. Fisher, T. Stafford, and A. Thurber (2023). QGreenland ({{ release }})
> [dataset], [National Snow and Ice Data Center](https://qgreenland.org/).
> doi: [10.5281/zenodo.12823307](https://doi.org/10.5281/zenodo.12823307)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the bumpversion-driven citation section. The {{ release }} bit above is a myst substitution based on the software's current version number.

I hard-coded the DOI to v3, our latest release, but a future release will mean this is wrong.

We could use the "cite all versions" doi here, but it does mean that someone that copies and uses this citation, intending to get the v3 citation, might end up with a DOI that points to e.g., v4 in a year or two from now. Maybe that's not a huge concern, since the version number would still be in the citation?

@mfisher87 , any thoughts?


> *Fisher, M., *Stafford, T., T. Moon, and A. Thurber (2023). QGreenland ({{ release }})
> [software], [National Snow and Ice Data Center](https://github.com/nsidc/qgreenland)
> [software], [National Snow and Ice Data Center](https://github.com/nsidc/qgreenland).
> doi: [10.5281/zenodo.8326507](https://doi.org/10.5281/zenodo.8326507)


### Version 3

> Moon, T. A., M. Fisher, T. Stafford, and A. Thurber (2023). QGreenland (v3)
> [dataset], [National Snow and Ice Data Center](https://qgreenland.org/).
> doi: [10.5281/zenodo.12823307](https://doi.org/10.5281/zenodo.12823307)

> *Fisher, M., *Stafford, T., T. Moon, and A. Thurber (2023). QGreenland (v3)
> [software], [National Snow and Ice Data Center](https://github.com/nsidc/qgreenland)
> [software], [National Snow and Ice Data Center](https://github.com/nsidc/qgreenland).
> doi: [10.5281/zenodo.8326507](https://doi.org/10.5281/zenodo.8326507)


### Version 2

> Moon, T., Fisher, M., Harden, L., Simonoko, H., and T. Stafford (2022). QGreenland
> (v2) [dataset], [National Snow and Ice Data Center](https://qgreenland.org/).
> doi: [10.5281/zenodo.8247915](https://doi.org/10.5281/zenodo.8247915)

> *Fisher, M., *Stafford, T., Moon, T., Harden, L., and H. Simonoko (2022). QGreenland
> (v2) [software], [National Snow and Ice Data
> Center](https://github.com/nsidc/qgreenland)
> Center](https://github.com/nsidc/qgreenland).
> doi: [10.5281/zenodo.6369184](https://doi.org/10.5281/zenodo.6369184)


### Version 1

> Moon, T., Fisher, M., Harden, L., and T. Stafford (2021). QGreenland (v1)
> [dataset], [National Snow and Ice Data Center](https://qgreenland.org/).
> doi: [10.5281/zenodo.8247896](https://doi.org/10.5281/zenodo.8247896)

> *Fisher, M., *Stafford, T., Moon, T., and L. Harden (2021). QGreenland (v1)
> [software], [National Snow and Ice Data Center](https://github.com/nsidc/qgreenland)
> [software], [National Snow and Ice Data Center](https://github.com/nsidc/qgreenland).
> doi: [10.5281/zenodo.4557875](https://doi.org/10.5281/zenodo.4557875)


## Acknowledgement

> We acknowledge the National Snow and Ice Data Center QGreenland package.
> We acknowledge the National Snow and Ice Data Center QGreenland package.
Loading