Merge pull request #72 from NCAR/reproducibility

Update citation texts per Zenodo DOI implementation per-version

CITATION.cff

@@ -0,0 +1,7 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+  - given-names: "Visualization & Analysis Systems Technologies"
+title: "Geoscience Community Analysis Toolkit: GeoCAT-viz"
+doi: 10.5281/zenodo.6678345
+url: "https://github.com/NCAR/geocat-viz"

README.md

@@ -1,3 +1,4 @@
+
 # GeoCAT-viz
 
 The GeoCAT-viz repo contains tools to help plot data, including convenience and plotting functions that are used
@@ -16,3 +17,8 @@ plotting packages. GeoCAT-viz functionality is used by
 # Installation instructions
 
 Please see our documentation for [installation instructions](https://github.com/NCAR/geocat-viz/blob/main/INSTALLATION.md).
+
+# Citing GeoCAT-viz
+
+If you use this software, please cite it as described at the [GeoCAT-viz - Citation](
+https://geocat-viz.readthedocs.io/en/latest/citation.html) page.

docs/citation.rst

@@ -4,17 +4,39 @@ Citation
 How to cite GeoCAT-viz
 ----------------------
 
-Cite GeoCAT-viz using the following text:
+If you use this software, please cite it as described below.
 
-**Visualization & Analysis Systems Technologies. (Year).
-Geoscience Community Analysis Toolkit (GeoCAT-viz version \<version\>) [Software].
-Boulder, CO: UCAR/NCAR - Computational and Informational System Lab. doi:10.5065/A8PP-4358.**
+Each GeoCAT-viz version is assigned a separate Digital Object Identifier (DOI) to allow
+users to access older releases. This ensures that users are not only able to cite the specific
+software version through DOIs but are also able to download & use the corresponding release for
+reproducibility purposes.
 
-Update the GeoCAT-viz version and year as appropriate. For example:
+If you would like to cite GeoCAT-viz as a whole (without referring to a specific version), use
+the following text:
 
-**Visualization & Analysis Systems Technologies. (2021).
-Geoscience Community Analysis Toolkit (GeoCAT-viz version 2021.08.0) [Software].
-Boulder, CO: UCAR/NCAR - Computational and Informational System Lab. doi:10.5065/A8PP-4358.**
+**Visualization & Analysis Systems Technologies. (2020).
+Geoscience Community Analysis Toolkit: GeoCAT-viz [Software].
+Boulder, CO: UCAR/NCAR - Computational and Informational System Lab. doi:10.5281/zenodo.6678345.**
+
+Instead, if you would like to cite a specific version of GeoCAT-viz, use the following text:
+
+**Visualization & Analysis Systems Technologies. (\<Year\>).
+Geoscience Community Analysis Toolkit: GeoCAT-viz (v\<version\>) [Software].
+Boulder, CO, USA: UCAR/NCAR - Computational and Informational System Lab. doi:\<DOI\>.**
+
+In the above citation text, update the year, GeoCAT-viz version, and DOI as appropriate. For
+example:
+
+**Visualization & Analysis Systems Technologies. (2022).
+Geoscience Community Analysis Toolkit: GeoCAT-viz (v2022.05.0) [Software].
+Boulder, CO, USA: UCAR/NCAR - Computational and Informational System Lab. doi:10.5281/zenodo.6678351.**
+
+Please find DOIs for all the GeoCAT-viz versions `here
+<https://zenodo.org/search?page=1&size=20&q=conceptrecid:%226678345%22&sort=-version&all_versions=True>`_.
+
+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.
 
 For further information, please refer to
 `GeoCAT homepage - Citation <https://geocat.ucar.edu/pages/citation.html>`_.