Skip to content

Commit f72365d

Browse files
authored
Merge pull request #239 from lucasimi/add-cover-examples
Add cover examples
2 parents 1552297 + 6574198 commit f72365d

File tree

5 files changed

+364
-50
lines changed

5 files changed

+364
-50
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -66,16 +66,6 @@ mathematical foundations and practical applications, read
6666
| ![Step 1](https://github.com/lucasimi/tda-mapper-python/raw/main/resources/mapper_1.png) | ![Step 2](https://github.com/lucasimi/tda-mapper-python/raw/main/resources/mapper_2.png) | ![Step 3](https://github.com/lucasimi/tda-mapper-python/raw/main/resources/mapper_3.png) | ![Step 2](https://github.com/lucasimi/tda-mapper-python/raw/main/resources/mapper_4.png) |
6767
| Choose lens | Cover image | Run clustering | Build graph |
6868

69-
## Citations
70-
71-
If you use **tda-mapper** in your work, please consider citing both the
72-
[library](https://doi.org/10.5281/zenodo.10642381), archived in a permanent
73-
Zenodo record, and the [paper](https://openreview.net/pdf?id=lTX4bYREAZ),
74-
which provides a broader methodological overview. We recommend citing the
75-
specific version of the library used in your research, along with the paper.
76-
For citation examples, please refer to the
77-
[documentation](https://tda-mapper.readthedocs.io/en/main/#citations).
78-
7969
## Quick Start
8070

8171
### Installation
@@ -160,3 +150,13 @@ To run it locally:
160150
```
161151

162152
![tda-mapper-app](https://github.com/lucasimi/tda-mapper-python/raw/main/resources/tda-mapper-app.png)
153+
154+
## Citations
155+
156+
If you use **tda-mapper** in your work, please consider citing both the
157+
[library](https://doi.org/10.5281/zenodo.10642381), archived in a permanent
158+
Zenodo record, and the [paper](https://openreview.net/pdf?id=lTX4bYREAZ),
159+
which provides a broader methodological overview. We recommend citing the
160+
specific version of the library used in your research, along with the paper.
161+
For citation examples, please refer to the
162+
[documentation](https://tda-mapper.readthedocs.io/en/main/#citations).

docs/source/citations.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Citations
2+
=========
3+
4+
If you use **tda-mapper** in your work, please consider citing both the
5+
`library <https://doi.org/10.5281/zenodo.10642381>`__,
6+
archived in a permanent Zenodo record, and the
7+
`paper <https://openreview.net/pdf?id=lTX4bYREAZ>`__,
8+
which provides a broader methodological overview. We recommend citing the
9+
specific version of the library used in your research, along with the paper.
10+
11+
- **tda-mapper**: For example to cite version 0.8.0 you can use:
12+
13+
.. code:: bibtex
14+
15+
@software{simi_2024_14194667,
16+
author = {Simi, Luca},
17+
title = {tda-mapper},
18+
month = nov,
19+
year = 2024,
20+
publisher = {Zenodo},
21+
version = {v0.8.0},
22+
doi = {10.5281/zenodo.14194667},
23+
url = {https://doi.org/10.5281/zenodo.14194667}
24+
}
25+
26+
- **Methodology**: For the paper, you can use:
27+
28+
.. code:: bibtex
29+
30+
@article{simi2025a,
31+
title = {A Scalable Approach for Mapper via Efficient Spatial Search},
32+
author = {Luca Simi},
33+
journal = {Transactions on Machine Learning Research},
34+
issn = {2835-8856},
35+
year = {2025},
36+
url = {https://openreview.net/forum?id=lTX4bYREAZ},
37+
note = {}
38+
}

docs/source/examples.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ Examples
66

77
notebooks/circles
88
notebooks/digits
9+
notebooks/cover
910

docs/source/index.rst

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -94,52 +94,13 @@ mathematical foundations and practical applications, read
9494
| Choose lens | Cover image | Run clustering | Build graph |
9595
+-----------------+-----------------+-----------------+-----------------+
9696

97-
Citations
98-
---------
99-
100-
If you use **tda-mapper** in your work, please consider citing both the
101-
`library <https://doi.org/10.5281/zenodo.10642381>`__,
102-
archived in a permanent Zenodo record, and the
103-
`paper <https://openreview.net/pdf?id=lTX4bYREAZ>`__,
104-
which provides a broader methodological overview. We recommend citing the
105-
specific version of the library used in your research, along with the paper.
106-
107-
- **tda-mapper**: For example to cite version 0.8.0 you can use:
108-
109-
.. code:: bibtex
110-
111-
@software{simi_2024_14194667,
112-
author = {Simi, Luca},
113-
title = {tda-mapper},
114-
month = nov,
115-
year = 2024,
116-
publisher = {Zenodo},
117-
version = {v0.8.0},
118-
doi = {10.5281/zenodo.14194667},
119-
url = {https://doi.org/10.5281/zenodo.14194667}
120-
}
121-
122-
- **Methodology**: For the paper, you can use:
123-
124-
.. code:: bibtex
125-
126-
@article{simi2025a,
127-
title = {A Scalable Approach for Mapper via Efficient Spatial Search},
128-
author = {Luca Simi},
129-
journal = {Transactions on Machine Learning Research},
130-
issn = {2835-8856},
131-
year = {2025},
132-
url = {https://openreview.net/forum?id=lTX4bYREAZ},
133-
note = {}
134-
}
135-
136-
13797
.. toctree::
13898
:caption: User's Guide
13999
:maxdepth: 1
140100

141101
quickstart
142102
examples
103+
citations
143104

144105

145106
.. toctree::

0 commit comments

Comments
 (0)