diff --git a/CITATION.cff b/CITATION.cff index 1174a71..2fc4517 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -13,6 +13,10 @@ authors: repository-code: "https://github.com/sun-data/ndoptimize" url: "https://ndoptimize.readthedocs.io" license: BSD-3-Clause +identifiers: + - type: doi + description: Concept DOI, which always resolves to the latest version + value: "10.5281/zenodo.23484609" keywords: - nonlinear least squares - Levenberg-Marquardt diff --git a/README.md b/README.md index 50d6068..f31669e 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ [![Ruff](https://github.com/sun-data/ndoptimize/actions/workflows/ruff.yml/badge.svg)](https://github.com/sun-data/ndoptimize/actions/workflows/ruff.yml) [![Documentation Status](https://readthedocs.org/projects/ndoptimize/badge/?version=latest)](https://ndoptimize.readthedocs.io/en/latest/?badge=latest) [![PyPI version](https://badge.fury.io/py/ndoptimize.svg)](https://badge.fury.io/py/ndoptimize) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.23484609.svg)](https://doi.org/10.5281/zenodo.23484609) `ndoptimize` minimizes objective functions for many independent problems at once, similar to @@ -167,14 +168,23 @@ Gaussian plus a straight line, and two Gaussians plus a straight line. If you use ndoptimize in your research, please cite it. The citation metadata is kept in [`CITATION.cff`](https://github.com/sun-data/ndoptimize/blob/main/CITATION.cff), which the "Cite this repository" button on GitHub can export as BibTeX or APA. + +Every release of ndoptimize is archived on Zenodo with its own DOI. +The concept DOI, [10.5281/zenodo.23484609](https://doi.org/10.5281/zenodo.23484609), +always resolves to the latest version, +and the Zenodo page lists the DOI of every version. Please include the version of ndoptimize that you used, which is given by `importlib.metadata.version("ndoptimize")`. +The BibTeX entry below uses the concept DOI. +To cite a specific version instead, +replace `doi` with the DOI of that version. ```bibtex @software{ndoptimize, author = {Smart, Roy T.}, title = {ndoptimize}, version = {X.Y.Z}, + doi = {10.5281/zenodo.23484609}, url = {https://github.com/sun-data/ndoptimize}, } ``` diff --git a/docs/index.rst b/docs/index.rst index fd621da..1b94b6d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -217,8 +217,17 @@ The citation metadata is kept in which the "Cite this repository" button on the `GitHub page `_ can export as BibTeX or APA. + +Every release of :mod:`ndoptimize` is archived on Zenodo with its own DOI. +The concept DOI, +`10.5281/zenodo.23484609 `_, +always resolves to the latest version, +and the Zenodo page lists the DOI of every version. Please include the version of :mod:`ndoptimize` that you used, which is given by ``importlib.metadata.version("ndoptimize")``. +The BibTeX entry below uses the concept DOI. +To cite a specific version instead, +replace ``doi`` with the DOI of that version. .. code-block:: bibtex @@ -226,6 +235,7 @@ which is given by ``importlib.metadata.version("ndoptimize")``. author = {Smart, Roy T.}, title = {ndoptimize}, version = {X.Y.Z}, + doi = {10.5281/zenodo.23484609}, url = {https://github.com/sun-data/ndoptimize}, }