Skip to content

Commit e08e969

Browse files
committed
Moved citations after quickstart and examples
1 parent d40e865 commit e08e969

File tree

3 files changed

+49
-50
lines changed

3 files changed

+49
-50
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,6 @@ mathematical foundations and practical applications, read
6464
| ![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) |
6565
| Choose lens | Cover image | Run clustering | Build graph |
6666

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

7969
### Installation
@@ -158,3 +148,13 @@ To run it locally:
158148
```
159149

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

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

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

13797
quickstart
13898
examples
99+
citations
139100

140101

141102
.. toctree::

0 commit comments

Comments
 (0)