From 4ca2f8aa1fc43fa8a5e7a295c5dc2aed00d76a61 Mon Sep 17 00:00:00 2001
From: Jeremy Kubica <104161096+jeremykubica@users.noreply.github.com>
Date: Mon, 30 Sep 2024 15:07:24 -0400
Subject: [PATCH 1/2] Add citation information

---
 README.md                | 24 +++++++++++++++++++++++-
 docs/index.rst           |  1 +
 docs/source/citation.rst | 22 ++++++++++++++++++++++
 docs/source/overview.rst |  2 +-
 4 files changed, 47 insertions(+), 2 deletions(-)
 create mode 100644 docs/source/citation.rst

diff --git a/README.md b/README.md
index 34f021f..dae2fef 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 [![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.
+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 +30,28 @@ 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):
+
+```
+@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}
+}
+```
+
 ## Acknowledgements
 
 This project is supported by Schmidt Sciences.
diff --git a/docs/index.rst b/docs/index.rst
index e11553e..0846924 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -26,6 +26,7 @@ please :doc:`/source/contact`
    source/configuration_checklist
    source/update_project
    source/contributing
+   source/citation
    source/contact
 
 
diff --git a/docs/source/citation.rst b/docs/source/citation.rst
new file mode 100644
index 0000000..1ee3f86
--- /dev/null
+++ b/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}
+    }
\ No newline at end of file
diff --git a/docs/source/overview.rst b/docs/source/overview.rst
index 49e533f..bafa1a7 100644
--- a/docs/source/overview.rst
+++ b/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/>`_. 

From 49d572e0f402f1e654fef1113a04e79e0ad5f7c0 Mon Sep 17 00:00:00 2001
From: Melissa DeLucchi <delucchi@andrew.cmu.edu>
Date: Mon, 30 Sep 2024 15:13:02 -0400
Subject: [PATCH 2/2] Badge and bib

---
 CITATION.bib | 16 ++++++++++++++++
 README.md    | 21 +++------------------
 2 files changed, 19 insertions(+), 18 deletions(-)
 create mode 100644 CITATION.bib

diff --git a/CITATION.bib b/CITATION.bib
new file mode 100644
index 0000000..af209d7
--- /dev/null
+++ b/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}
+}
+
diff --git a/README.md b/README.md
index dae2fef..4e86ef0 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,8 @@
 [![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/)
 
+[![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!
@@ -32,25 +34,8 @@ See full documentation at [readthedocs](https://lincc-ppt.readthedocs.io/en/late
 
 ## 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):
+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):
 
-```
-@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}
-}
-```
 
 ## Acknowledgements
 
