Skip to content

Commit 49d572e

Browse files
committed
Badge and bib
1 parent 4ca2f8a commit 49d572e

File tree

2 files changed

+19
-18
lines changed

2 files changed

+19
-18
lines changed

CITATION.bib

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

README.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
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+
[![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)
7+
68
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).
79

810
[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
3234

3335
## Citation
3436

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):
37+
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):
3638

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-
```
5439

5540
## Acknowledgements
5641

0 commit comments

Comments
 (0)