Merge pull request #481 from lincc-frameworks/add_citation

Add citation information

Author: jeremykubica

CITATION.bib

@@ -0,0 +1,16 @@
+@ARTICLE{2024RNAAS...8..141O,
+       author = {{Oldag}, Drew and {DeLucchi}, Melissa and {Beebe}, Wilson and {Branton}, Doug and {Campos}, Sandro and {Chandler}, Colin Orion and {Christofferson}, Carl and {Connolly}, Andrew and {Kubica}, Jeremy and {Lynn}, Olivia and {Malanchev}, Konstantin and {Malz}, Alex I. and {Mandelbaum}, Rachel and {McGuire}, Sean and {Wenneman}, Chris},
+        title = "{A Python Project Template for Healthy Scientific Software}",
+      journal = {Research Notes of the American Astronomical Society},
+     keywords = {Open source software, 1866},
+         year = 2024,
+        month = may,
+       volume = {8},
+       number = {5},
+          eid = {141},
+        pages = {141},
+          doi = {10.3847/2515-5172/ad4da1},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2024RNAAS...8..141O},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+}
+

README.md

@@ -3,7 +3,9 @@
 [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/lincc-frameworks/python-project-template/ci.yml)](https://github.com/lincc-frameworks/python-project-template/ci.yml)
 [![Read the Docs](https://img.shields.io/readthedocs/lincc-ppt)](https://lincc-ppt.readthedocs.io/)
 
-This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation. It is meant to help new python projects get started quickly, letting the user focus on writing code. The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
+[![DOI:10.3847/2515-5172/ad4da1](https://zenodo.org/badge/DOI/10.3847/2515-5172/ad4da1.svg)](https://ui.adsabs.harvard.edu/abs/2024RNAAS...8..141O)
+
+This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation. It is meant to help new python projects get started quickly, letting the user focus on writing code. The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over. You can read more in the [PPT research note](https://iopscience.iop.org/article/10.3847/2515-5172/ad4da1).
 
 [Copier](https://copier.readthedocs.io/en/latest/) is required to use this template. Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures. It's really neat!
 
@@ -30,6 +32,11 @@ bash .initialize_new_project.sh
 
 See full documentation at [readthedocs](https://lincc-ppt.readthedocs.io/en/latest/source/contributing.html)
 
+## Citation
+
+If you use Python Project Template in your work, we ask the you cite the ["A Python Project Template for Healthy Scientific Software" research note](https://iopscience.iop.org/article/10.3847/2515-5172/ad4da1) [full citation](./CITATION.bib):
+
+
 ## Acknowledgements
 
 This project is supported by Schmidt Sciences.

docs/index.rst

@@ -26,6 +26,7 @@ please :doc:`/source/contact`
    source/configuration_checklist
    source/update_project
    source/contributing
+   source/citation
    source/contact
 
 

docs/source/citation.rst

@@ -0,0 +1,22 @@
+Citation
+===============================================================================
+
+If you use Python Project Template in your work, we ask the you cite the `"A Python Project Template for Healthy Scientific Software" <https://iopscience.iop.org/article/10.3847/2515-5172/ad4da1)>`_ research note:
+
+.. code-block:: text
+
+    @ARTICLE{2024RNAAS...8..141O,
+        author = {{Oldag}, Drew and {DeLucchi}, Melissa and {Beebe}, Wilson and {Branton}, Doug and {Campos}, Sandro and {Chandler}, Colin Orion and {Christofferson}, Carl and {Connolly}, Andrew and {Kubica}, Jeremy and {Lynn}, Olivia and {Malanchev}, Konstantin and {Malz}, Alex I. and {Mandelbaum}, Rachel and {McGuire}, Sean and {Wenneman}, Chris},
+        title = "{A Python Project Template for Healthy Scientific Software}",
+        journal = {Research Notes of the American Astronomical Society},
+        keywords = {Open source software, 1866},
+        year = 2024,
+        month = may,
+        volume = {8},
+        number = {5},
+        eid = {141},
+        pages = {141},
+        doi = {10.3847/2515-5172/ad4da1},
+        adsurl = {https://ui.adsabs.harvard.edu/abs/2024RNAAS...8..141O},
+        adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+    }

docs/source/overview.rst

@@ -22,7 +22,7 @@ the full benefit of the template.
 .. _prerequisites:
 
 Prerequisites
---------------
+-------------
 
 To use our template you'll need to install 
 `Copier <https://copier.readthedocs.io/en/latest/>`_.