Merge pull request #239 from lucasimi/add-cover-examples

Add cover examples

Author: lucasimi

README.md

@@ -66,16 +66,6 @@ mathematical foundations and practical applications, read
 | ![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) |
 | Choose lens | Cover image | Run clustering | Build graph |
 
-## Citations
-
-If you use **tda-mapper** in your work, please consider citing both the
-[library](https://doi.org/10.5281/zenodo.10642381), archived in a permanent
-Zenodo record, and the [paper](https://openreview.net/pdf?id=lTX4bYREAZ),
-which provides a broader methodological overview. We recommend citing the
-specific version of the library used in your research, along with the paper.
-For citation examples, please refer to the
-[documentation](https://tda-mapper.readthedocs.io/en/main/#citations).
-
 ## Quick Start
 
 ### Installation
@@ -160,3 +150,13 @@ To run it locally:
     ```
 
 ![tda-mapper-app](https://github.com/lucasimi/tda-mapper-python/raw/main/resources/tda-mapper-app.png)
+
+## Citations
+
+If you use **tda-mapper** in your work, please consider citing both the
+[library](https://doi.org/10.5281/zenodo.10642381), archived in a permanent
+Zenodo record, and the [paper](https://openreview.net/pdf?id=lTX4bYREAZ),
+which provides a broader methodological overview. We recommend citing the
+specific version of the library used in your research, along with the paper.
+For citation examples, please refer to the
+[documentation](https://tda-mapper.readthedocs.io/en/main/#citations).

docs/source/citations.rst

@@ -0,0 +1,38 @@
+Citations
+=========
+
+If you use **tda-mapper** in your work, please consider citing both the
+`library <https://doi.org/10.5281/zenodo.10642381>`__,
+archived in a permanent Zenodo record, and the
+`paper <https://openreview.net/pdf?id=lTX4bYREAZ>`__,
+which provides a broader methodological overview. We recommend citing the
+specific version of the library used in your research, along with the paper.
+
+- **tda-mapper**: For example to cite version 0.8.0 you can use:
+
+  .. code:: bibtex
+
+      @software{simi_2024_14194667,
+         author       = {Simi, Luca},
+         title        = {tda-mapper},
+         month        = nov,
+         year         = 2024,
+         publisher    = {Zenodo},
+         version      = {v0.8.0},
+         doi          = {10.5281/zenodo.14194667},
+         url          = {https://doi.org/10.5281/zenodo.14194667}
+      }
+
+- **Methodology**: For the paper, you can use:
+
+  .. code:: bibtex
+
+      @article{simi2025a,
+         title    = {A Scalable Approach for Mapper via Efficient Spatial Search},
+         author   = {Luca Simi},
+         journal  = {Transactions on Machine Learning Research},
+         issn     = {2835-8856},
+         year     = {2025},
+         url      = {https://openreview.net/forum?id=lTX4bYREAZ},
+         note     = {}
+      }

docs/source/examples.rst

@@ -6,4 +6,5 @@ Examples
 
    notebooks/circles
    notebooks/digits
+   notebooks/cover
 

docs/source/index.rst

@@ -94,52 +94,13 @@ mathematical foundations and practical applications, read
 | Choose lens     | Cover image     | Run clustering  | Build graph     |
 +-----------------+-----------------+-----------------+-----------------+
 
-Citations
----------
-
-If you use **tda-mapper** in your work, please consider citing both the
-`library <https://doi.org/10.5281/zenodo.10642381>`__,
-archived in a permanent Zenodo record, and the
-`paper <https://openreview.net/pdf?id=lTX4bYREAZ>`__,
-which provides a broader methodological overview. We recommend citing the
-specific version of the library used in your research, along with the paper.
-
-- **tda-mapper**: For example to cite version 0.8.0 you can use:
-
-  .. code:: bibtex
-
-      @software{simi_2024_14194667,
-         author       = {Simi, Luca},
-         title        = {tda-mapper},
-         month        = nov,
-         year         = 2024,
-         publisher    = {Zenodo},
-         version      = {v0.8.0},
-         doi          = {10.5281/zenodo.14194667},
-         url          = {https://doi.org/10.5281/zenodo.14194667}
-      }
-
-- **Methodology**: For the paper, you can use:
-
-  .. code:: bibtex
-
-      @article{simi2025a,
-         title    = {A Scalable Approach for Mapper via Efficient Spatial Search},
-         author   = {Luca Simi},
-         journal  = {Transactions on Machine Learning Research},
-         issn     = {2835-8856},
-         year     = {2025},
-         url      = {https://openreview.net/forum?id=lTX4bYREAZ},
-         note     = {}
-      }
-
-
 .. toctree::
    :caption: User's Guide
    :maxdepth: 1
 
    quickstart
    examples 
+   citations
 
 
 .. toctree::