Skip to content

Commit 56cd254

Browse files
committed
Updated informations and versions
1 parent 8281769 commit 56cd254

File tree

3 files changed

+34
-16
lines changed

3 files changed

+34
-16
lines changed

README.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[![deploy](https://github.com/lucasimi/tda-mapper-python/actions/workflows/deploy.yml/badge.svg)](https://github.com/lucasimi/tda-mapper-python/actions/workflows/deploy.yml)
77
[![docs](https://readthedocs.org/projects/tda-mapper/badge/?version=main)](https://tda-mapper.readthedocs.io/en/main/?badge=main)
88
[![codecov](https://codecov.io/github/lucasimi/tda-mapper-python/graph/badge.svg?token=FWSD8JUG6R)](https://codecov.io/github/lucasimi/tda-mapper-python)
9+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10659652.svg)](https://doi.org/10.5281/zenodo.10659652)
910
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10642381.svg)](https://doi.org/10.5281/zenodo.10642381)
1011
[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://tda-mapper-app.streamlit.app/)
1112

@@ -89,25 +90,39 @@ fig_std.show(config={'scrollZoom': True})
8990

9091
More examples can be found in the documentation https://tda-mapper.readthedocs.io/en/main/.
9192

92-
## Citations
93+
### Demo App
9394

94-
To cite **tda-mapper** in your work you can use the Zenodo archive https://doi.org/10.5281/zenodo.10642381.
95+
You can also run a demo app locally by running
9596

96-
In the archive you can find a permanent reference to the exact version you used in your work.
97+
```
98+
pip install -r app/requirements.txt
99+
streamlit run app/streamlit_app.py
100+
```
97101

98-
For example, to cite version `v0.4.0` you can use:
102+
## Citations
99103

100-
Simi, L. (2024). tda-mapper (v0.4.0). Zenodo. https://doi.org/10.5281/zenodo.10655755
104+
If you want to use **tda-mapper** in your research please use one of the following citation.
105+
For the methodology you can use:
106+
107+
```
108+
Simi, L. (2024). A Scalable Implementation of Mapper for Topological Data Analysis via Vantage Point Trees. Zenodo. https://doi.org/10.5281/zenodo.10659652
109+
```
101110

102111
BibTeX entry:
103112

104-
@software{tda-mapper_v0.4.0,
105-
author = {Simi, Luca},
106-
title = {tda-mapper},
107-
month = feb,
108-
year = 2024,
109-
publisher = {Zenodo},
110-
version = {v0.4.0},
111-
doi = {10.5281/zenodo.10655755},
112-
url = {https://doi.org/10.5281/zenodo.10655755}
113-
}
113+
114+
```
115+
@misc{simi_2024_10659652,
116+
author = {Simi, Luca},
117+
title = {A Scalable Implementation of Mapper for Topological Data Analysis via Vantage Point Trees},
118+
month = feb,
119+
year = 2024,
120+
publisher = {Zenodo},
121+
doi = {10.5281/zenodo.10659652},
122+
url = {https://doi.org/10.5281/zenodo.10659652}
123+
}
124+
```
125+
126+
If you want to refer to the actual library instead, you can reference the Zenodo
127+
archive [https://doi.org/10.5281/zenodo.10642381](https://doi.org/10.5281/zenodo.10642381>).
128+
In the archive you can find a permanent reference to the exact version used in your work.

app/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ streamlit
22
numpy
33
scikit-learn
44
pandas
5-
tda-mapper==0.5.1
5+
tda-mapper

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ version = "0.5.2"
88
description = "A simple and efficient Python implementation of Mapper algorithm for Topological Data Analysis"
99
readme = "README.md"
1010
authors = [{ name = "Luca Simi", email = "lucasimi90@gmail.com" }]
11+
maintainers = [{ name = "Luca Simi", email = "lucasimi90@gmail.com" }]
1112
license = { file = "LICENSE" }
1213
classifiers = [
1314
"License :: OSI Approved :: Apache Software License",
@@ -28,3 +29,5 @@ dev = ["coverage", "pandas", "scikit-learn"]
2829

2930
[project.urls]
3031
Homepage = "https://github.com/lucasimi/tda-mapper-python"
32+
Documentation = "https://tda-mapper.readthedocs.io"
33+
Issues = "https://github.com/lucasimi/tda-mapper-python/issues"

0 commit comments

Comments
 (0)