Skip to content

Commit 4ca2f8a

Browse files
committed
Add citation information
1 parent 3ff124f commit 4ca2f8a

File tree

4 files changed

+47
-2
lines changed

4 files changed

+47
-2
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![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)
44
[![Read the Docs](https://img.shields.io/readthedocs/lincc-ppt)](https://lincc-ppt.readthedocs.io/)
55

6-
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.
6+
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).
77

88
[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!
99

@@ -30,6 +30,28 @@ bash .initialize_new_project.sh
3030

3131
See full documentation at [readthedocs](https://lincc-ppt.readthedocs.io/en/latest/source/contributing.html)
3232

33+
## Citation
34+
35+
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):
36+
37+
```
38+
@ARTICLE{2024RNAAS...8..141O,
39+
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},
40+
title = "{A Python Project Template for Healthy Scientific Software}",
41+
journal = {Research Notes of the American Astronomical Society},
42+
keywords = {Open source software, 1866},
43+
year = 2024,
44+
month = may,
45+
volume = {8},
46+
number = {5},
47+
eid = {141},
48+
pages = {141},
49+
doi = {10.3847/2515-5172/ad4da1},
50+
adsurl = {https://ui.adsabs.harvard.edu/abs/2024RNAAS...8..141O},
51+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
52+
}
53+
```
54+
3355
## Acknowledgements
3456

3557
This project is supported by Schmidt Sciences.

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ please :doc:`/source/contact`
2626
source/configuration_checklist
2727
source/update_project
2828
source/contributing
29+
source/citation
2930
source/contact
3031

3132

docs/source/citation.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Citation
2+
===============================================================================
3+
4+
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:
5+
6+
.. code-block:: text
7+
8+
@ARTICLE{2024RNAAS...8..141O,
9+
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},
10+
title = "{A Python Project Template for Healthy Scientific Software}",
11+
journal = {Research Notes of the American Astronomical Society},
12+
keywords = {Open source software, 1866},
13+
year = 2024,
14+
month = may,
15+
volume = {8},
16+
number = {5},
17+
eid = {141},
18+
pages = {141},
19+
doi = {10.3847/2515-5172/ad4da1},
20+
adsurl = {https://ui.adsabs.harvard.edu/abs/2024RNAAS...8..141O},
21+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
22+
}

docs/source/overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ the full benefit of the template.
2222
.. _prerequisites:
2323

2424
Prerequisites
25-
--------------
25+
-------------
2626

2727
To use our template you'll need to install
2828
`Copier <https://copier.readthedocs.io/en/latest/>`_.

0 commit comments

Comments
 (0)