Skip to content

Commit 8b10ec1

Browse files
committed
add software citation doi
1 parent 8c12643 commit 8b10ec1

File tree

3 files changed

+30
-1
lines changed

3 files changed

+30
-1
lines changed

CITATION.cff

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it as below."
3+
authors:
4+
- family-names: "Mocz"
5+
given-names: "Philip"
6+
orcid: "https://orcid.org/0000-0001-6631-2566"
7+
title: "Adirondax"
8+
version: 0.0.4
9+
doi: 10.5281/zenodo.17584122
10+
date-released: 2025-11-12
11+
url: "https://github.com/AdirondaxProject/adirondax"

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
[![asv][asv-badge]][asv-link]
1515
[![Readthedocs Status][docs-badge]][docs-link]
1616
[![License][license-badge]][license-link]
17+
[![Software DOI][software-doi-badge]][software-doi-link]
1718

1819
[status-link]: https://www.repostatus.org/#active
1920
[status-badge]: https://www.repostatus.org/badges/latest/active.svg
@@ -31,6 +32,9 @@
3132
[docs-badge]: https://readthedocs.org/projects/adirondax/badge
3233
[license-link]: https://opensource.org/licenses/Apache-2.0
3334
[license-badge]: https://img.shields.io/badge/License-Apache_2.0-blue.svg
35+
[software-doi-link]: https://doi.org/10.5281/zenodo.17584122
36+
[software-doi-badge]: https://zenodo.org/badge/902479137.svg
37+
3438

3539
A differentiable astrophysics simulator in JAX
3640

@@ -85,3 +89,14 @@ Check out the [`examples/`](https://github.com/AdirondaxProject/adirondax/tree/m
8589

8690
If you use this software, please cite it as below.
8791

92+
```bibtex
93+
@software{Mocz_Adirondax_2025,
94+
author = {Mocz, Philip},
95+
doi = {10.5281/zenodo.17584122},
96+
month = nov,
97+
title = {{Adirondax}},
98+
url = {https://github.com/AdirondaxProject/adirondax},
99+
version = {0.0.4},
100+
year = {2025}
101+
}
102+
```

docs/pages/citing.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,7 @@ Citing
33

44
If you use this software, please cite it as below.
55

6-
TODO
6+
.. literalinclude:: ../../README.md
7+
:start-at: Mocz_Adirondax_2025
8+
:end-before: ```
9+
:language: latex

0 commit comments

Comments
 (0)