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

update citation docs #666

Merged
merged 4 commits into from
Dec 9, 2024
Merged

update citation docs #666

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9b88b6c
update citation docs
kafitzgerald Dec 6, 2024
06a73da
Update release-notes.rst
kafitzgerald Dec 6, 2024
752472b
citations docs formatting
kafitzgerald Dec 6, 2024
bcceb23
remove broken roadmap link
kafitzgerald Dec 9, 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
34 changes: 13 additions & 21 deletions docs/citation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,24 @@ users to access older releases. This ensures that users are not only able to cit
software version through DOIs but are also able to download & use the corresponding release for
reproducibility purposes.

Please find DOIs for all the GeoCAT-comp versions `here
<https://zenodo.org/search?page=1&size=20&q=conceptrecid:%226607205%22&sort=-version&all_versions=True>`__.
DOIs for all GeoCAT-comp versions can be found `here on Zenodo
<https://zenodo.org/search?q=parent.id%3A6607205&f=allversions%3Atrue&l=list&p=1&s=10&sort=version>`__.

If you would like to cite GeoCAT-comp as a whole (without referring to a specific version), use
the following text:
Example citations
^^^^^^^^^^^^^^^^^

**Visualization & Analysis Systems Technologies. (2019).
Geoscience Community Analysis Toolkit: GeoCAT-comp [Software].
Boulder, CO: NSF NCAR Computational and Information System Lab. doi:10.5281/zenodo.6607205.**

Instead, if you would like to cite a specific version of GeoCAT-comp, use the following text:

**Visualization & Analysis Systems Technologies. (\<Year\>).
Geoscience Community Analysis Toolkit: GeoCAT-comp (v\<version\>) [Software].
Boulder, CO, USA: NSF NCAR Computational and Information System Lab. doi:\<DOI\>.**

In the above citation text, update the year, GeoCAT-comp version, and DOI as appropriate. For
example:
Citing a specific version of GeoCAT-comp:

**Visualization & Analysis Systems Technologies. (2022).
Geoscience Community Analysis Toolkit: GeoCAT-comp (v2022.04.0) [Software].
Boulder, CO, USA: NSF NCAR Computational and Information System Lab. doi:10.5281/zenodo.6607349.**

Please note: The DOI minting service, Zenodo, might be suggesting their own citation text (as
they are the publisher of such DOIs) in their website. We prefer the text we recommend here to be used;
however, either way is acceptable.
.. attention::

For further information, please refer to
`GeoCAT homepage - Citation <https://geocat.ucar.edu/pages/citation.html>`_.
Requires updating the year, GeoCAT-comp version, and DOI

Citing GeoCAT-comp without referring to a specific version:

**Visualization & Analysis Systems Technologies. (2019).
Geoscience Community Analysis Toolkit: GeoCAT-comp [Software].
Boulder, CO: NSF NCAR Computational and Information System Lab. doi:10.5281/zenodo.6607205.**
1 change: 1 addition & 0 deletions docs/release-notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Documentation
^^^^^^^^^^^^^
* Fix to documentation theme configuration by `Katelyn FitzGerald`_ in (:pr:`657`)
* Update links to eofs documentation by `Katelyn FitzGerald`_ in (:pr:`661`)
* Update citation documentation removing reference to old GeoCAT website by `Katelyn FitzGerald`_ in (:pr:`666`)

Internal Changes
^^^^^^^^^^^^^^^^
Expand Down
Loading