Skip to content

Commit 5a6485f

Browse files
authored
Merge pull request #126 from Axect/docs/joss-publication
Point citation metadata at the published JOSS paper
2 parents 247f8d1 + 0f8ad1a commit 5a6485f

2 files changed

Lines changed: 73 additions & 3 deletions

File tree

‎CITATION.cff‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ authors:
4444
identifiers:
4545
- type: doi
4646
value: 10.5281/zenodo.10815823
47+
description: Concept DOI of the Zenodo software archive
48+
- type: doi
49+
value: 10.21105/joss.10366
50+
description: DOI of the Journal of Open Source Software paper
4751
repository-code: 'https://github.com/Axect/Peroxide'
4852
url: 'https://crates.io/crates/peroxide'
4953
abstract: >-
@@ -69,3 +73,50 @@ keywords:
6973
- Linear algebra
7074
- Differential equation
7175
license: MIT
76+
preferred-citation:
77+
type: article
78+
title: "Peroxide: A Batteries-Included Numerical Computing Library for Rust"
79+
authors:
80+
- given-names: Tae-Geun
81+
family-names: Kim
82+
email: axect.tg@proton.me
83+
affiliation: Fudan University / RIKEN iTHEMS
84+
orcid: 'https://orcid.org/0009-0000-4229-2935'
85+
- given-names: Giorgio
86+
family-names: Comitini
87+
affiliation: Università degli Studi di Catania
88+
orcid: 'https://orcid.org/0000-0002-1758-7878'
89+
- given-names: Jonas
90+
family-names: Grage
91+
affiliation: Independent Researcher
92+
orcid: 'https://orcid.org/0009-0000-9279-7683'
93+
- given-names: Benjamin
94+
family-names: Joens
95+
affiliation: Independent Researcher
96+
orcid: 'https://orcid.org/0009-0002-7922-0884'
97+
- given-names: Marc
98+
family-names: Schreiber
99+
affiliation: Independent Researcher
100+
orcid: 'https://orcid.org/0000-0003-2564-6126'
101+
- given-names: Soumya
102+
family-names: Sen
103+
affiliation: Independent Researcher
104+
orcid: 'https://orcid.org/0009-0008-0337-9964'
105+
- given-names: Russell R P
106+
family-names: Senthamarai
107+
affiliation: Independent Researcher
108+
orcid: 'https://orcid.org/0000-0002-8061-5480'
109+
- given-names: Johanna
110+
family-names: Sörngård
111+
affiliation: Independent Researcher
112+
orcid: 'https://orcid.org/0000-0002-8660-9989'
113+
journal: Journal of Open Source Software
114+
publisher:
115+
name: The Open Journal
116+
volume: 11
117+
issue: 124
118+
start: 10366
119+
year: 2026
120+
month: 8
121+
doi: 10.21105/joss.10366
122+
url: 'https://doi.org/10.21105/joss.10366'

‎README.md‎

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![On crates.io](https://img.shields.io/crates/v/peroxide.svg)](https://crates.io/crates/peroxide)
44
[![On docs.rs](https://docs.rs/peroxide/badge.svg)](https://docs.rs/peroxide)
5+
[![JOSS](https://joss.theoj.org/papers/10.21105/joss.10366/status.svg)](https://doi.org/10.21105/joss.10366)
56
[![DOI](https://zenodo.org/badge/130400565.svg)](https://zenodo.org/doi/10.5281/zenodo.10815823)
67
![github](https://github.com/Axect/Peroxide/workflows/Github/badge.svg)
78

@@ -412,11 +413,29 @@ Hey there!
412413
If you're using Peroxide in your research or project, you're not required to cite us.
413414
But if you do, we'd be really grateful! 😊
414415

415-
To make citing Peroxide easy, we've created a DOI through Zenodo. Just click on this badge:
416+
Peroxide is described in a paper published in the [Journal of Open Source Software](https://doi.org/10.21105/joss.10366):
417+
418+
[![JOSS](https://joss.theoj.org/papers/10.21105/joss.10366/status.svg)](https://doi.org/10.21105/joss.10366)
419+
420+
```bibtex
421+
@article{Kim2026,
422+
author = {Kim, Tae-Geun and Comitini, Giorgio and Grage, Jonas and Joens, Benjamin and Schreiber, Marc and Sen, Soumya and Senthamarai, Russell R P and S\"{o}rng\r{a}rd, Johanna},
423+
title = {Peroxide: A Batteries-Included Numerical Computing Library for {R}ust},
424+
journal = {Journal of Open Source Software},
425+
publisher = {The Open Journal},
426+
volume = {11},
427+
number = {124},
428+
pages = {10366},
429+
year = {2026},
430+
doi = {10.21105/joss.10366},
431+
url = {https://doi.org/10.21105/joss.10366}
432+
}
433+
```
434+
435+
To cite one specific release rather than the paper, use the Zenodo archive:
416436

417437
[![DOI](https://zenodo.org/badge/130400565.svg)](https://zenodo.org/doi/10.5281/zenodo.10815823)
418438

419-
This will take you to the Zenodo page for Peroxide.
420-
At the bottom, you'll find the citation information in various formats like BibTeX, RIS, and APA.
439+
That badge resolves to the newest deposit, and each release page carries citation information in BibTeX, RIS, and APA.
421440

422441
So, if you want to acknowledge the work we've put into Peroxide, citing us would be a great way to do it! Thanks for considering it, we appreciate your support! 👍

0 commit comments

Comments
 (0)