Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -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."
Comment thread
Copilot marked this conversation as resolved.
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"
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
Loading