Skip to content

Commit 5162441

Browse files
DOC: Update citation file with JOSS paper reference (#496)
1 parent 44ed135 commit 5162441

File tree

3 files changed

+26
-9
lines changed

3 files changed

+26
-9
lines changed

CITATION.rst

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,27 @@
1+
Citation Guidelines
2+
===================
3+
4+
|JOSS| |Zenodo|
5+
6+
17
If you use SkyPy for work or research presented in a publication (whether
2-
directly, or as a dependency to another package) we recommend and encourage
8+
directly, or as a dependency of another package) we recommend and encourage
39
the following acknowledgment:
410

511
This research made use of SkyPy, a Python package for forward modeling
6-
astronomical surveys (SkyPy Collaboration, 2020).
12+
astronomical surveys (Amara et. al., 2021, SkyPy Collaboration, 202x).
13+
14+
where the citations are to our publication in the `Journal of Open Source
15+
Software`_ and the `Zenodo DOI`_ for the specific version of the software that
16+
you used. We also encourage citations within the main text wherever
17+
appropriate. DOIs and BibTeX keys are available through the links above.
18+
19+
.. _Journal of Open Source Software: https://joss.theoj.org/papers/10.21105/joss.03056
20+
.. _Zenodo DOI: https://zenodo.org/record/3755531
21+
722

8-
where (SkyPy Collaboration, 2020) is a citation to the software DOI for the
9-
specific version that you used. We also encourage you to cite the software DOI
10-
in the main text wherever appropriate. DOIs and BibTeX keys for each release
11-
can be found on Zenodo_.
23+
.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.03056/status.svg
24+
:target: https://doi.org/10.21105/joss.03056
1225

13-
.. _Zenodo: https://zenodo.org/record/3755531
26+
.. |Zenodo| image:: https://zenodo.org/badge/doi/10.5281/zenodo.4475347.svg
27+
:target: https://doi.org/10.5281/zenodo.3755531

docs/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ intention the simulations can then be compared to data as part of an inference
1111
pipeline.
1212

1313
.. Important:: If you use SkyPy for work presented in a publication or talk
14-
please help the project via proper `citation or acknowledgement
15-
<https://github.com/skypyproject/skypy/blob/main/CITATION.rst>`_.
14+
please follow our :doc:`project/citation`.
15+
16+
1617

1718
.. _getting-started:
1819

@@ -74,6 +75,7 @@ Project details
7475
:maxdepth: 1
7576

7677
project/code_of_conduct
78+
project/citation
7779

7880

7981
*****

docs/project/citation.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../CITATION.rst

0 commit comments

Comments
 (0)