|
1 | 1 | .. _citation: |
2 | 2 |
|
3 | 3 | Citation |
4 | | -================= |
| 4 | +========== |
5 | 5 |
|
6 | | -WRF-Python has a Digital Object Identifier (DOI), which is a persistent |
7 | | -identifier for web-based resources. The wrf-python DOI, when used in URL form, |
8 | | -https://doi.org/10.5065/D6W094P1, provides a persistent link to the wrf-python |
9 | | -Github page. The benefit of DOIs is that they are widely accepted by academic |
10 | | -publishers as citable locators for scholarly objects. |
| 6 | +How to cite WRF-Python |
| 7 | +----------------------- |
11 | 8 |
|
12 | | -If you author a paper that involves data analysis with wrf-python, or |
13 | | -visualizations created with wrf-python, we would like to ask you to please |
14 | | -cite wrf-python. This helps us better understand the impact of the software on |
15 | | -the scientific community, which in turns helps us maintain support for the |
16 | | -effort. |
| 9 | +If you use this software, please cite it as described below: |
17 | 10 |
|
18 | | -You can cite wrf-python using the following citation: |
| 11 | +WRF-Python has a Digital Object Identifier (DOI), which is a persistent identifier for |
| 12 | +web-based resources. The benefit of DOIs is that they are widely accepted by academic publishers |
| 13 | +as citable locators for scholarly objects. The WRF-Python DOI, when used in URL form, |
| 14 | +`https://doi.org/10.5065/D6W094P1 <https://doi.org/10.5065/D6W094P1>`_, provides a persistent link |
| 15 | +to the WRF-Python GitHub repository, and can be used to cite the WRF-Python project as a whole. |
19 | 16 |
|
20 | | -.. code-block:: none |
| 17 | +In addition, each WRF-Python version is assigned a separate DOI to allow users to access older |
| 18 | +releases. This ensures that users are not only able to cite the specific software version through |
| 19 | +DOIs but are also able to download & use the corresponding release for reproducibility purposes. |
21 | 20 |
|
22 | | - Ladwig, W. (2017). wrf-python (Version x.x.x) [Software]. Boulder, Colorado: UCAR/NCAR. https://doi.org/10.5065/D6W094P1 |
23 | | - |
24 | | -.. note:: |
| 21 | +If you would like to cite WRF-Python as a whole (without referring to a specific version), use |
| 22 | +the following text: |
25 | 23 |
|
26 | | - The version number x.x.x should be set to the version of wrf-python that you are using. |
| 24 | +**Visualization & Analysis Systems Technologies. (2017). |
| 25 | +Geoscience Community Analysis Toolkit: WRF-Python [Software]. |
| 26 | +Boulder, CO: UCAR/NCAR - Computational and Informational System Lab. doi:10.5065/D6W094P1.** |
| 27 | + |
| 28 | +Instead, if you would like to cite a specific version of WRF-Python, use the following text: |
| 29 | + |
| 30 | +**Visualization & Analysis Systems Technologies. (Year). |
| 31 | +Geoscience Community Analysis Toolkit: WRF-Python (v\<version\>) [Software]. |
| 32 | +Boulder, CO, USA: UCAR/NCAR - Computational and Informational System Lab. doi:\<DOI\>.** |
| 33 | + |
| 34 | +In the above citation text, update the year, WRF-Python version, and DOI as appropriate. For |
| 35 | +example: |
| 36 | + |
| 37 | +**Visualization & Analysis Systems Technologies. (2022). |
| 38 | +Geoscience Community Analysis Toolkit: WRF-Python (v1.3.4.1) [Software]. |
| 39 | +Boulder, CO, USA: UCAR/NCAR - Computational and Informational System Lab. doi:10.5281/zenodo.6685115.** |
| 40 | + |
| 41 | +Please find DOIs for all the WRF-Python versions `here |
| 42 | +<https://zenodo.org/search?page=1&size=20&q=conceptrecid:%226685091%22&sort=-version&all_versions=True>`_. |
| 43 | + |
| 44 | +Please note: The DOI minting service, Zenodo, might be suggesting their own citation text (as |
| 45 | +they are the publisher of such DOIs) in their website. We prefer the text we recommend here to be used; |
| 46 | +however, either way is acceptable. |
| 47 | + |
| 48 | +For further information, please refer to |
| 49 | +`GeoCAT homepage - Citation <https://geocat.ucar.edu/pages/citation.html>`_. |
0 commit comments