Skip to content

Commit 33060c1

Browse files
committed
Improved badges. Updated references
1 parent f630d74 commit 33060c1

2 files changed

Lines changed: 29 additions & 30 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
![Logo](https://github.com/lucasimi/tda-mapper-python/raw/main/docs/source/logos/tda-mapper-logo-horizontal.png)
22

3-
[![PyPI version](https://badge.fury.io/py/tda-mapper.svg)](https://badge.fury.io/py/tda-mapper)
4-
[![downloads](https://img.shields.io/pypi/dm/tda-mapper)](https://pypi.python.org/pypi/tda-mapper/)
5-
[![test](https://github.com/lucasimi/tda-mapper-python/actions/workflows/test.yml/badge.svg)](https://github.com/lucasimi/tda-mapper-python/actions/workflows/test.yml)
6-
[![publish](https://github.com/lucasimi/tda-mapper-python/actions/workflows/publish.yml/badge.svg)](https://github.com/lucasimi/tda-mapper-python/actions/workflows/publish.yml)
7-
[![docs](https://readthedocs.org/projects/tda-mapper/badge/?version=main)](https://tda-mapper.readthedocs.io/en/main/?badge=main)
8-
[![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.10642381.svg)](https://doi.org/10.5281/zenodo.10642381)
10-
[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://tda-mapper-app.streamlit.app/)
3+
[![PyPI version](https://img.shields.io/pypi/v/tda-mapper?logo=python&logoColor=silver)](https://pypi.python.org/pypi/tda-mapper)
4+
[![downloads](https://img.shields.io/pypi/dm/tda-mapper?logo=python&logoColor=silver)](https://pypi.python.org/pypi/tda-mapper)
5+
[![test](https://img.shields.io/github/actions/workflow/status/lucasimi/tda-mapper-python/test.yml?logo=github&logoColor=silver&branch=main&label=test)](https://github.com/lucasimi/tda-mapper-python/actions/workflows/test.yml)
6+
[![publish](https://img.shields.io/github/actions/workflow/status/lucasimi/tda-mapper-python/publish.yml?logo=github&logoColor=silver&label=publish)](https://github.com/lucasimi/tda-mapper-python/actions/workflows/publish.yml)
7+
[![docs](https://img.shields.io/readthedocs/tda-mapper/main?logo=readthedocs&logoColor=silver)](https://tda-mapper.readthedocs.io/en/main/)
8+
[![codecov](https://img.shields.io/codecov/c/github/lucasimi/tda-mapper-python?logo=codecov&logoColor=silver)](https://codecov.io/github/lucasimi/tda-mapper-python)
9+
[![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.10642381-blue?logo=doi&logoColor=silver)](https://doi.org/10.5281/zenodo.10642381)
10+
[![Streamlit App](https://img.shields.io/badge/Streamlit-App-blue?logo=streamlit&logoColor=silver)](https://tda-mapper-app.streamlit.app/)
1111

1212
# tda-mapper
1313

docs/source/index.rst

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
.. |PyPI version| image:: https://badge.fury.io/py/tda-mapper.svg
2-
:target: https://badge.fury.io/py/tda-mapper
3-
.. |downloads| image:: https://img.shields.io/pypi/dm/tda-mapper
4-
:target: https://pypi.python.org/pypi/tda-mapper/
5-
.. |test| image:: https://github.com/lucasimi/tda-mapper-python/actions/workflows/test.yml/badge.svg
1+
.. |PyPI version| image:: https://img.shields.io/pypi/v/tda-mapper?logo=python&logoColor=silver
2+
:target: https://pypi.python.org/pypi/tda-mapper
3+
.. |downloads| image:: https://img.shields.io/pypi/dm/tda-mapper?logo=python&logoColor=silver
4+
:target: https://pypi.python.org/pypi/tda-mapper
5+
.. |test| image:: https://img.shields.io/github/actions/workflow/status/lucasimi/tda-mapper-python/test.yml?logo=github&logoColor=silver&branch=main&label=test
66
:target: https://github.com/lucasimi/tda-mapper-python/actions/workflows/test.yml
7-
.. |publish| image:: https://github.com/lucasimi/tda-mapper-python/actions/workflows/publish.yml/badge.svg
7+
.. |publish| image:: https://img.shields.io/github/actions/workflow/status/lucasimi/tda-mapper-python/publish.yml?logo=github&logoColor=silver&label=publish
88
:target: https://github.com/lucasimi/tda-mapper-python/actions/workflows/publish.yml
9-
.. |docs| image:: https://readthedocs.org/projects/tda-mapper/badge/?version=main
10-
:target: https://tda-mapper.readthedocs.io/en/main/?badge=main
11-
.. |codecov| image:: https://codecov.io/github/lucasimi/tda-mapper-python/graph/badge.svg?token=FWSD8JUG6R
9+
.. |docs| image:: https://img.shields.io/readthedocs/tda-mapper/main?logo=readthedocs&logoColor=silver
10+
:target: https://tda-mapper.readthedocs.io/en/main/
11+
.. |codecov| image:: https://img.shields.io/codecov/c/github/lucasimi/tda-mapper-python?logo=codecov&logoColor=silver
1212
:target: https://codecov.io/github/lucasimi/tda-mapper-python
13-
.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10642381.svg
13+
.. |DOI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.10642381-blue?logo=doi&logoColor=silver
1414
:target: https://doi.org/10.5281/zenodo.10642381
15-
.. |Streamlit App| image:: https://static.streamlit.io/badges/streamlit_badge_black_white.svg
15+
.. |Streamlit App| image:: https://img.shields.io/badge/Streamlit-App-blue?logo=streamlit&logoColor=silver
1616
:target: https://tda-mapper-app.streamlit.app/
1717
.. |Step 1| image:: https://github.com/lucasimi/tda-mapper-python/raw/main/resources/mapper_1.png
1818
.. |Step 2| image:: https://github.com/lucasimi/tda-mapper-python/raw/main/resources/mapper_2.png
@@ -80,35 +80,34 @@ archived in a permanent Zenodo record, and the
8080
which provides a broader methodological overview.
8181
We recommend citing the specific version of the library used in your research, as well as the latest version of the preprint.
8282

83-
- **tda-mapper**: For example to cite version 0.7.3 you can use:
83+
- **tda-mapper**: For example to cite version 0.8.0 you can use:
8484

8585
.. code:: bibtex
8686
87-
@software{simi_2024_12729251,
87+
@software{simi_2024_14194667,
8888
author = {Simi, Luca},
8989
title = {tda-mapper},
90-
month = jul,
90+
month = nov,
9191
year = 2024,
9292
publisher = {Zenodo},
93-
version = {v0.7.3},
94-
doi = {10.5281/zenodo.12729251},
95-
url = {https://doi.org/10.5281/zenodo.12729251}
96-
}
93+
version = {v0.8.0},
94+
doi = {10.5281/zenodo.14194667},
95+
url = {https://doi.org/10.5281/zenodo.14194667}
96+
}
9797
9898
- **Methodology**: For the preprint, you can use:
9999

100100
.. code:: bibtex
101101
102-
@misc{simi_2024_11187959,
102+
@misc{simi_2024_11187959,
103103
author = {Simi, Luca},
104-
title = {{A Scalable Approach for Mapper via Vantage Point
105-
Trees}},
104+
title = {{A Scalable Approach for Mapper via Vantage Point Trees}},
106105
month = may,
107106
year = 2024,
108107
publisher = {Zenodo},
109108
doi = {10.5281/zenodo.11187959},
110109
url = {https://doi.org/10.5281/zenodo.11187959}
111-
}
110+
}
112111
113112
114113
.. toctree::

0 commit comments

Comments
 (0)