From 0f8ad1a1b1c300456b07fa8c89d7cdbb80932b7f Mon Sep 17 00:00:00 2001 From: axect Date: Mon, 10 Aug 2026 10:56:14 +0900 Subject: [PATCH] DOCS: Point citation metadata at the published JOSS paper Peroxide was published in JOSS on 2026-08-10 as 11(124), 10366, DOI 10.21105/joss.10366. - README: add the JOSS status badge and make the paper the primary citation in `Cite Peroxide`, with a ready-to-paste BibTeX entry. The Zenodo concept DOI stays as the way to cite one specific release. - CITATION.cff: add the JOSS DOI to `identifiers` and add a `preferred-citation` article entry so GitHub's citation widget and cffconvert consumers resolve to the paper. Validated against the Citation File Format 1.2.0 schema with cffconvert, which Zenodo also runs during release archiving. --- CITATION.cff | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 25 ++++++++++++++++++++++--- 2 files changed, 73 insertions(+), 3 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index f5d513f..26f3292 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -44,6 +44,10 @@ authors: identifiers: - type: doi value: 10.5281/zenodo.10815823 + description: Concept DOI of the Zenodo software archive + - type: doi + value: 10.21105/joss.10366 + description: DOI of the Journal of Open Source Software paper repository-code: 'https://github.com/Axect/Peroxide' url: 'https://crates.io/crates/peroxide' abstract: >- @@ -69,3 +73,50 @@ keywords: - Linear algebra - Differential equation license: MIT +preferred-citation: + type: article + title: "Peroxide: A Batteries-Included Numerical Computing Library for Rust" + authors: + - given-names: Tae-Geun + family-names: Kim + email: axect.tg@proton.me + affiliation: Fudan University / RIKEN iTHEMS + orcid: 'https://orcid.org/0009-0000-4229-2935' + - given-names: Giorgio + family-names: Comitini + affiliation: Università degli Studi di Catania + orcid: 'https://orcid.org/0000-0002-1758-7878' + - given-names: Jonas + family-names: Grage + affiliation: Independent Researcher + orcid: 'https://orcid.org/0009-0000-9279-7683' + - given-names: Benjamin + family-names: Joens + affiliation: Independent Researcher + orcid: 'https://orcid.org/0009-0002-7922-0884' + - given-names: Marc + family-names: Schreiber + affiliation: Independent Researcher + orcid: 'https://orcid.org/0000-0003-2564-6126' + - given-names: Soumya + family-names: Sen + affiliation: Independent Researcher + orcid: 'https://orcid.org/0009-0008-0337-9964' + - given-names: Russell R P + family-names: Senthamarai + affiliation: Independent Researcher + orcid: 'https://orcid.org/0000-0002-8061-5480' + - given-names: Johanna + family-names: Sörngård + affiliation: Independent Researcher + orcid: 'https://orcid.org/0000-0002-8660-9989' + journal: Journal of Open Source Software + publisher: + name: The Open Journal + volume: 11 + issue: 124 + start: 10366 + year: 2026 + month: 8 + doi: 10.21105/joss.10366 + url: 'https://doi.org/10.21105/joss.10366' diff --git a/README.md b/README.md index b3f7ad7..43fecab 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![On crates.io](https://img.shields.io/crates/v/peroxide.svg)](https://crates.io/crates/peroxide) [![On docs.rs](https://docs.rs/peroxide/badge.svg)](https://docs.rs/peroxide) +[![JOSS](https://joss.theoj.org/papers/10.21105/joss.10366/status.svg)](https://doi.org/10.21105/joss.10366) [![DOI](https://zenodo.org/badge/130400565.svg)](https://zenodo.org/doi/10.5281/zenodo.10815823) ![github](https://github.com/Axect/Peroxide/workflows/Github/badge.svg) @@ -412,11 +413,29 @@ Hey there! If you're using Peroxide in your research or project, you're not required to cite us. But if you do, we'd be really grateful! 😊 -To make citing Peroxide easy, we've created a DOI through Zenodo. Just click on this badge: +Peroxide is described in a paper published in the [Journal of Open Source Software](https://doi.org/10.21105/joss.10366): + +[![JOSS](https://joss.theoj.org/papers/10.21105/joss.10366/status.svg)](https://doi.org/10.21105/joss.10366) + +```bibtex +@article{Kim2026, + 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}, + title = {Peroxide: A Batteries-Included Numerical Computing Library for {R}ust}, + journal = {Journal of Open Source Software}, + publisher = {The Open Journal}, + volume = {11}, + number = {124}, + pages = {10366}, + year = {2026}, + doi = {10.21105/joss.10366}, + url = {https://doi.org/10.21105/joss.10366} +} +``` + +To cite one specific release rather than the paper, use the Zenodo archive: [![DOI](https://zenodo.org/badge/130400565.svg)](https://zenodo.org/doi/10.5281/zenodo.10815823) -This will take you to the Zenodo page for Peroxide. -At the bottom, you'll find the citation information in various formats like BibTeX, RIS, and APA. +That badge resolves to the newest deposit, and each release page carries citation information in BibTeX, RIS, and APA. 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! 👍