Skip to content

Commit f34945a

Browse files
deargledeargle
authored
refactor docs tocs and index page (#239)
- puts the "tutorials" and "case studies" tocs under the "user's guide" toc, instead of them being their own TOCs. - breaks the API page out to its own TOC - moves the "citations" and "contributions" pages into their own .txt files for no good reason
1 parent aee3500 commit f34945a

File tree

6 files changed

+128
-98
lines changed

6 files changed

+128
-98
lines changed

‎docs/case_studies.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Case studies
2+
============
3+
4+
These pages are in-depth applications of KeplerMapper to various interesting domains.
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
notebooks/KeplerMapper-Newsgroup20-Pipeline
10+
notebooks/TOR-XGB-TDA
11+
notebooks/Confidence-Graphs
12+
notebooks/self-guessing

‎docs/citations.txt‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
Citations
2+
---------
3+
4+
To credit KeplerMapper in your work, please cite both the `JOSS paper`_
5+
and the `Zenodo archive`_. The former provides a high level description
6+
of the package, and the latter points to a permanent record of all KeplerMapper versions
7+
(we encourage you to cite the specific version you used).
8+
9+
.. _JOSS paper: https://doi.org/10.21105/joss.01315
10+
.. _Zenodo archive: https://doi.org/10.5281/zenodo.1002377
11+
12+
Example citations (for KeplerMapper 1.4.1):
13+
14+
van Veen et al., (2019). Kepler Mapper: A flexible Python implementation of the Mapper algorithm.
15+
Journal of Open Source Software, 4(42), 1315, https://doi.org/10.21105/joss.01315
16+
17+
Hendrik Jacob van Veen, Nathaniel Saul, David Eargle, & Sam W. Mangham.
18+
(2019, October 14). Kepler Mapper: A flexible Python implementation of the Mapper algorithm (Version 1.4.1).
19+
Zenodo. http://doi.org/10.5281/zenodo.4077395
20+
21+
Bibtex entry for JOSS article:
22+
23+
::
24+
25+
@article{KeplerMapper_JOSS,
26+
doi = {10.21105/joss.01315},
27+
url = {https://doi.org/10.21105/joss.01315},
28+
year = {2019},
29+
publisher = {The Open Journal},
30+
volume = {4},
31+
number = {42},
32+
pages = {1315},
33+
author = {Hendrik Jacob van Veen and Nathaniel Saul and David Eargle and Sam W. Mangham},
34+
title = {Kepler Mapper: A flexible Python implementation of the Mapper algorithm.},
35+
journal = {Journal of Open Source Software}
36+
}
37+
38+
Bibtex entry for the Zenodo archive, version 1.4.1:
39+
40+
::
41+
42+
@software{KeplerMapper_v1.4.1-Zenodo,
43+
author = {Hendrik Jacob van Veen and
44+
Nathaniel Saul and
45+
Eargle, David and
46+
Sam W. Mangham},
47+
title = {{Kepler Mapper: A flexible Python implementation of
48+
the Mapper algorithm}},
49+
month = oct,
50+
year = 2020,
51+
publisher = {Zenodo},
52+
version = {1.4.1},
53+
doi = {10.5281/zenodo.4077395},
54+
url = {https://doi.org/10.5281/zenodo.4077395}
55+
}

‎docs/contributions.txt‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Contributions
2+
-------------
3+
4+
We welcome contributions of all shapes and sizes. There are lots of
5+
opportunities for potential projects, so please get in touch if you would like
6+
to help out. Everything from an implementation of your favorite distance,
7+
notebooks, examples, and documentation are all equally valuable so please don’t
8+
feel you can’t contribute.
9+
10+
See `the contributing page in the code repository`__ for more details.
11+
12+
__ https://github.com/scikit-tda/kepler-mapper/blob/master/CONTRIBUTING.md

‎docs/index.rst‎

Lines changed: 35 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -7,124 +7,63 @@
77
|Codecov| |DOI zenodo| |DOI JOSS|
88

99
Kepler Mapper
10-
----------------
10+
=============
1111

12+
.. epigraph::
1213

13-
Nature uses as little as possible of anything. - Johannes Kepler
14+
Nature uses as little as possible of anything.
1415

15-
This is a library implementing the Mapper algorithm in Python. KeplerMapper can be used for visualization of high-dimensional data and 3D point cloud data. KeplerMapper can make use of Scikit-Learn API compatible cluster and scaling algorithms. You can find the source code on github at
16-
`scikit-tda/kepler-mapper <https://github.com/scikit-tda/kepler-mapper>`_.
16+
-- Johannes Kepler
1717

18-
KeplerMapper employs approaches based on the MAPPER algorithm (Singh et al.) as first described in the paper "Topological Methods for the Analysis of High Dimensional Data Sets and 3D Object Recognition".
18+
This is a library implementing the Mapper algorithm in Python. KeplerMapper can
19+
be used for visualization of high-dimensional data and 3D point cloud data.
20+
KeplerMapper can make use of Scikit-Learn API compatible cluster and scaling
21+
algorithms. You can find the source code on github at
22+
`scikit-tda/kepler-mapper`_.
1923

20-
Setup
21-
=======================
24+
.. _scikit-tda/kepler-mapper: https://github.com/scikit-tda/kepler-mapper
2225

23-
Install KeplerMapper with pip:
26+
KeplerMapper employs approaches based on the MAPPER algorithm (Singh et al.) as
27+
first described in the paper "Topological Methods for the Analysis of High
28+
Dimensional Data Sets and 3D Object Recognition".
2429

25-
::
2630

27-
pip install kmapper
31+
.. User's Guide
32+
.. ------------
33+
..
34+
.. These pages explain what KeplerMapper is, illustrate how to use it, and discuss
35+
.. and demonstrate applications of it.
2836
2937
3038
31-
Citations
32-
=======================
33-
34-
To credit KeplerMapper in your work, please cite both the `JOSS paper`_
35-
and the `Zenodo archive`_. The former provides a high level description
36-
of the package, and the latter points to a permanent record of all KeplerMapper versions
37-
(we encourage you to cite the specific version you used).
38-
39-
.. _JOSS paper: https://doi.org/10.21105/joss.01315
40-
.. _Zenodo archive: https://doi.org/10.5281/zenodo.1002377
41-
42-
Example citations (for KeplerMapper 1.4.1):
43-
44-
van Veen et al., (2019). Kepler Mapper: A flexible Python implementation of the Mapper algorithm.
45-
Journal of Open Source Software, 4(42), 1315, https://doi.org/10.21105/joss.01315
46-
47-
Hendrik Jacob van Veen, Nathaniel Saul, David Eargle, & Sam W. Mangham.
48-
(2019, October 14). Kepler Mapper: A flexible Python implementation of the Mapper algorithm (Version 1.4.1).
49-
Zenodo. http://doi.org/10.5281/zenodo.4077395
50-
51-
Bibtex entry for JOSS article:
52-
53-
::
54-
55-
@article{KeplerMapper_JOSS,
56-
doi = {10.21105/joss.01315},
57-
url = {https://doi.org/10.21105/joss.01315},
58-
year = {2019},
59-
publisher = {The Open Journal},
60-
volume = {4},
61-
number = {42},
62-
pages = {1315},
63-
author = {Hendrik Jacob van Veen and Nathaniel Saul and David Eargle and Sam W. Mangham},
64-
title = {Kepler Mapper: A flexible Python implementation of the Mapper algorithm.},
65-
journal = {Journal of Open Source Software}
66-
}
67-
68-
Bibtex entry for the Zenodo archive, version 1.4.1:
69-
70-
::
71-
72-
@software{KeplerMapper_v1.4.1-Zenodo,
73-
author = {Hendrik Jacob van Veen and
74-
Nathaniel Saul and
75-
Eargle, David and
76-
Sam W. Mangham},
77-
title = {{Kepler Mapper: A flexible Python implementation of
78-
the Mapper algorithm}},
79-
month = oct,
80-
year = 2020,
81-
publisher = {Zenodo},
82-
version = {1.4.1},
83-
doi = {10.5281/zenodo.4077395},
84-
url = {https://doi.org/10.5281/zenodo.4077395}
85-
}
86-
87-
88-
89-
Contributions
90-
=======================
91-
92-
We welcome contributions of all shapes and sizes. There are lots of opportunities for potential projects, so please get in touch if you would like to help out. Everything from an implementation of your favorite distance, notebooks, examples, and documentation are all equally valuable so please don’t feel you can’t contribute.
93-
94-
To contribute please fork the project make your changes and submit a pull request. We will do our best to work through any issues with you and get your code merged into the main branch.
95-
96-
.. include:: ../README.rst
9739
9840
.. toctree::
99-
:hidden:
100-
:maxdepth: 1
101-
:caption: User Guide
41+
:caption: User's Guide
42+
:maxdepth: 2
10243

10344
theory
10445
started
10546
examples
10647
applications
107-
reference/index
48+
tutorials
49+
case_studies
10850

109-
.. toctree::
110-
:hidden:
111-
:maxdepth: 1
112-
:caption: Tutorials
11351

114-
notebooks/Adapters
115-
notebooks/Plotly-Demo
116-
notebooks/Cancer-demo
117-
notebooks/KeplerMapper-usage-in-Jupyter-Notebook
52+
.. API Reference
53+
.. -------------
54+
..
55+
.. These pages link to documentation for specific KeplerMapper classes and functions.
11856
11957
.. toctree::
120-
:hidden:
121-
:maxdepth: 1
122-
:caption: Advanced Case Studies
123-
124-
notebooks/KeplerMapper-Newsgroup20-Pipeline
125-
notebooks/TOR-XGB-TDA
126-
notebooks/Confidence-Graphs
127-
notebooks/self-guessing
58+
:caption: API Reference
59+
:maxdepth: 2
60+
61+
reference/index
62+
63+
64+
.. include:: citations.txt
65+
.. include:: contributions.txt
66+
12867

12968

13069
.. |Downloads| image:: https://img.shields.io/pypi/dm/kmapper

‎docs/reference/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

2-
API Reference
3-
---------------
2+
API
3+
---
44

55
.. currentmodule:: kmapper
66

‎docs/tutorials.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Tutorials
2+
---------
3+
4+
These pages demonstrate using KeplerMapper in various ways.
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
Visualization Adapters <notebooks/Adapters>
10+
notebooks/Plotly-Demo
11+
Choosing a Lens <notebooks/Cancer-demo>
12+
notebooks/KeplerMapper-usage-in-Jupyter-Notebook

0 commit comments

Comments
 (0)