Skip to content

Commit 49f8640

Browse files
Add Citation section with Zenodo DOI and project disambiguation
1 parent 59a3ef1 commit 49f8640

1 file changed

Lines changed: 36 additions & 2 deletions

File tree

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ efficiency, python-cmethods offers a comprehensive suite of functions tailored
2626
for applying bias correction methods to climate model simulations and
2727
observational datasets via command-line interface and API.
2828

29-
If you use this project, cite it as described in
30-
https://zenodo.org/doi/10.5281/zenodo.7652755.
29+
If you use this project, please cite it as described in the
30+
[Citation](#citation) section below.
3131

3232
## Table of Contents
3333

@@ -38,6 +38,7 @@ https://zenodo.org/doi/10.5281/zenodo.7652755.
3838
5. [ Notes ](#notes)
3939
6. [ Contribution ](#contribution)
4040
7. [ References ](#references)
41+
8. [ Citation ](#citation)
4142

4243
<a name="about"></a>
4344

@@ -315,3 +316,36 @@ Notes:
315316
https://github.com/btschwertfeger/python-cmethods/issues/47. I appreciate all
316317
the valuable suggestions provided throughout the implementation of the
317318
subsequent changes.
319+
320+
<a name="citation"></a>
321+
322+
## 8. Citation
323+
324+
If you use python-cmethods in your research, please cite the software through its
325+
Zenodo archive. The DOI below is the concept DOI that always resolves to the
326+
latest release.
327+
328+
> Benjamin Thomas Schwertfeger. _python-cmethods: A collection of bias correction
329+
> techniques written in Python - for climate sciences_. Zenodo.
330+
> https://doi.org/10.5281/zenodo.7652755
331+
332+
```bibtex
333+
@software{python_cmethods,
334+
author = {Schwertfeger, Benjamin Thomas},
335+
title = {{python-cmethods: A collection of bias correction techniques written in Python - for climate sciences}},
336+
year = {2023},
337+
publisher = {Zenodo},
338+
doi = {10.5281/zenodo.7652755},
339+
url = {https://github.com/btschwertfeger/python-cmethods}
340+
}
341+
```
342+
343+
To cite the exact version you used, replace the concept DOI with the
344+
version-specific DOI shown on the corresponding
345+
[Zenodo record](https://doi.org/10.5281/zenodo.7652755).
346+
347+
**Which project should I cite?** python-cmethods is the Python package. If you
348+
used the C++ command-line tool instead, cite
349+
[BiasAdjustCXX](https://github.com/btschwertfeger/BiasAdjustCXX) and its SoftwareX
350+
paper (https://doi.org/10.1016/j.softx.2023.101379). That paper describes the C++
351+
tool, not this Python package, so it is not the right reference for python-cmethods.

0 commit comments

Comments
 (0)