From 51624416ac28ebd573b700c975332272127f9349 Mon Sep 17 00:00:00 2001 From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com> Date: Tue, 2 Nov 2021 14:29:24 +0000 Subject: [PATCH] DOC: Update citation file with JOSS paper reference (#496) --- CITATION.rst | 28 +++++++++++++++++++++------- docs/index.rst | 6 ++++-- docs/project/citation.rst | 1 + 3 files changed, 26 insertions(+), 9 deletions(-) create mode 100644 docs/project/citation.rst diff --git a/CITATION.rst b/CITATION.rst index 04e06d0a2..f5a45657d 100644 --- a/CITATION.rst +++ b/CITATION.rst @@ -1,13 +1,27 @@ +Citation Guidelines +=================== + +|JOSS| |Zenodo| + + If you use SkyPy for work or research presented in a publication (whether -directly, or as a dependency to another package) we recommend and encourage +directly, or as a dependency of another package) we recommend and encourage the following acknowledgment: This research made use of SkyPy, a Python package for forward modeling - astronomical surveys (SkyPy Collaboration, 2020). + astronomical surveys (Amara et. al., 2021, SkyPy Collaboration, 202x). + +where the citations are to our publication in the `Journal of Open Source +Software`_ and the `Zenodo DOI`_ for the specific version of the software that +you used. We also encourage citations within the main text wherever +appropriate. DOIs and BibTeX keys are available through the links above. + +.. _Journal of Open Source Software: https://joss.theoj.org/papers/10.21105/joss.03056 +.. _Zenodo DOI: https://zenodo.org/record/3755531 + -where (SkyPy Collaboration, 2020) is a citation to the software DOI for the -specific version that you used. We also encourage you to cite the software DOI -in the main text wherever appropriate. DOIs and BibTeX keys for each release -can be found on Zenodo_. +.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.03056/status.svg + :target: https://doi.org/10.21105/joss.03056 -.. _Zenodo: https://zenodo.org/record/3755531 +.. |Zenodo| image:: https://zenodo.org/badge/doi/10.5281/zenodo.4475347.svg + :target: https://doi.org/10.5281/zenodo.3755531 diff --git a/docs/index.rst b/docs/index.rst index e3efcf7e6..b3d882feb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,8 +11,9 @@ intention the simulations can then be compared to data as part of an inference pipeline. .. Important:: If you use SkyPy for work presented in a publication or talk - please help the project via proper `citation or acknowledgement - `_. + please follow our :doc:`project/citation`. + + .. _getting-started: @@ -74,6 +75,7 @@ Project details :maxdepth: 1 project/code_of_conduct + project/citation ***** diff --git a/docs/project/citation.rst b/docs/project/citation.rst new file mode 100644 index 000000000..ff43a0525 --- /dev/null +++ b/docs/project/citation.rst @@ -0,0 +1 @@ +.. include:: ../../CITATION.rst