From 11f16081fa126a109978df28c017e53fc3f8b6a6 Mon Sep 17 00:00:00 2001 From: Tomoki Uda Date: Fri, 3 Jul 2026 21:26:22 +0900 Subject: [PATCH 1/2] docs: add CITATION.cff and cite the published JSIAM Letters paper Add root-level CITATION.cff (CFF 1.2.0) with software metadata matching pyproject.toml and a preferred-citation entry for the JSIAM Letters paper (vol. 18, 2026, pp. 13-16, DOI 10.14495/jsiaml.18.13). Add a Citation section to README.md with a ready-to-copy BibTeX entry and DOI / J-STAGE links. Closes #127 Co-Authored-By: Claude Fable 5 --- CITATION.cff | 30 ++++++++++++++++++++++++++++++ README.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..2f7785c --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,30 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite both the software and the paper below." +type: software +title: "ellphi" +abstract: "Fast ellipse tangency solver for anisotropic persistent homology." +authors: + - family-names: "Uda" + given-names: "Tomoki" +license: MIT +repository-code: "https://github.com/t-uda/ellphi" +url: "https://github.com/t-uda/ellphi" +version: "0.1.2" +keywords: + - "topological data analysis" + - "computational geometry" + - "ellipse" + - "tangency" +preferred-citation: + type: article + title: "Fast and accurate computation of ellipse tangency time for anisotropic persistent homology" + authors: + - family-names: "Uda" + given-names: "Tomoki" + journal: "JSIAM Letters" + volume: 18 + year: 2026 + start: 13 + end: 16 + doi: "10.14495/jsiaml.18.13" + url: "https://doi.org/10.14495/jsiaml.18.13" diff --git a/README.md b/README.md index dddcdf7..406867f 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,35 @@ Build info (including the C++ linear algebra choice): python -m ellphi --build-info ``` +## Citation + +If you use EllPHi in your research, please cite the JSIAM Letters paper: + +> Tomoki Uda, *Fast and accurate computation of ellipse tangency time for +> anisotropic persistent homology*, JSIAM Letters **18** (2026), 13–16. +> DOI: [10.14495/jsiaml.18.13](https://doi.org/10.14495/jsiaml.18.13) +> ([J-STAGE](https://www.jstage.jst.go.jp/article/jsiaml/18/0/18_13/_article/-char/en)) + +BibTeX: + +```bibtex +@article{Uda2026EllipseTangency, + author = {Uda, Tomoki}, + title = {Fast and accurate computation of ellipse tangency time for + anisotropic persistent homology}, + journal = {JSIAM Letters}, + volume = {18}, + year = {2026}, + pages = {13--16}, + doi = {10.14495/jsiaml.18.13}, +} +``` + +To cite the software itself, use the metadata in +[`CITATION.cff`](https://github.com/t-uda/ellphi/blob/main/CITATION.cff) — +GitHub's "Cite this repository" widget (in the sidebar of the repository +page) generates APA and BibTeX entries from it. + ## Contributing Interested in contributing? We welcome pull requests! From 19449aeaa0798a25cf423258422924f783522223 Mon Sep 17 00:00:00 2001 From: Tomoki Uda Date: Fri, 3 Jul 2026 21:47:26 +0900 Subject: [PATCH 2/2] docs: address citation review feedback - Split the README Citation section into 'Citing the paper' and 'Citing the software', noting that GitHub's cite widget generates the paper citation via preferred-citation, and adding a ready-to-copy @software BibTeX entry. - Use a relative link to CITATION.cff so it follows the viewed ref. - Use the EllPHi branding for the CFF software title. Co-Authored-By: Claude Fable 5 --- CITATION.cff | 2 +- README.md | 27 +++++++++++++++++++++++---- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 2f7785c..1863255 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,7 +1,7 @@ cff-version: 1.2.0 message: "If you use this software, please cite both the software and the paper below." type: software -title: "ellphi" +title: "EllPHi" abstract: "Fast ellipse tangency solver for anisotropic persistent homology." authors: - family-names: "Uda" diff --git a/README.md b/README.md index 406867f..15fa2c3 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,11 @@ python -m ellphi --build-info ## Citation +Citation metadata for both the paper and the software is kept in +[`CITATION.cff`](CITATION.cff). + +### Citing the paper + If you use EllPHi in your research, please cite the JSIAM Letters paper: > Tomoki Uda, *Fast and accurate computation of ellipse tangency time for @@ -132,6 +137,10 @@ If you use EllPHi in your research, please cite the JSIAM Letters paper: > DOI: [10.14495/jsiaml.18.13](https://doi.org/10.14495/jsiaml.18.13) > ([J-STAGE](https://www.jstage.jst.go.jp/article/jsiaml/18/0/18_13/_article/-char/en)) +This is also what GitHub's "Cite this repository" widget (in the sidebar of +the repository page) generates, via the `preferred-citation` entry in +`CITATION.cff`. + BibTeX: ```bibtex @@ -147,10 +156,20 @@ BibTeX: } ``` -To cite the software itself, use the metadata in -[`CITATION.cff`](https://github.com/t-uda/ellphi/blob/main/CITATION.cff) — -GitHub's "Cite this repository" widget (in the sidebar of the repository -page) generates APA and BibTeX entries from it. +### Citing the software + +To cite the software itself: + +```bibtex +@software{Uda2026EllPHi, + author = {Uda, Tomoki}, + title = {EllPHi}, + version = {0.1.2}, + year = {2026}, + url = {https://github.com/t-uda/ellphi}, + license = {MIT}, +} +``` ## Contributing