diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..1863255 --- /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..15fa2c3 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,54 @@ Build info (including the C++ linear algebra choice): 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 +> 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)) + +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 +@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}, +} +``` + +### 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 Interested in contributing? We welcome pull requests!