summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-05-29 12:33:54 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-05-29 12:33:54 +0200
commitdc642f06e4c5174ecd2301eb7bcd1daeb7c4a2ec (patch)
tree52bcd66d51e46a9d25a2d2874dcb265659a4309e /src
parenta99f1e8ceef3ccb8606ac6f5af169329db8352f4 (diff)
Rename nerve_gic_complex_sum.rst as nerve_gic_complex_sum.inc and use introduction sections
Diffstat (limited to 'src')
-rw-r--r--src/cython/doc/index.rst79
-rw-r--r--src/cython/doc/nerve_gic_complex_sum.inc (renamed from src/cython/doc/nerve_gic_complex_sum.rst)0
-rw-r--r--src/cython/doc/nerve_gic_complex_user.rst2
3 files changed, 37 insertions, 44 deletions
diff --git a/src/cython/doc/index.rst b/src/cython/doc/index.rst
index 15cbe267..e379bc23 100644
--- a/src/cython/doc/index.rst
+++ b/src/cython/doc/index.rst
@@ -6,80 +6,73 @@ GUDHI Python module documentation
:alt: Gudhi banner
:figclass: align-center
-Introduction
-************
-
-The Python interface for the Gudhi library (Geometry Understanding in Higher
-Dimensions) is a generic open source
-`Python module <http://gudhi.gforge.inria.fr/python/latest/>`_, for
-Computational Topology and Topological Data Analysis
-(`TDA <https://en.wikipedia.org/wiki/Topological_data_analysis>`_).
-The GUDHI library intends to help the development of new algorithmic solutions
-in TDA and their transfer to applications. It provides robust, efficient,
-flexible and easy to use implementations of state-of-the-art algorithms and
-data structures.
-
-The current release of the GUDHI library includes:
+Complexes
+*********
-* Data structures to represent, construct and manipulate simplicial complexes.
-* Simplification of simplicial complexes by edge contraction.
-* Algorithms to compute persistent homology and bottleneck distance.
+Cubical complexes
+=================
-We refer to :cite:`gudhilibrary_ICMS14` for a detailed description of the
-design of the library.
+.. include:: cubical_complex_sum.inc
-Data structures
-***************
+Simplicial complexes
+====================
Alpha complex
-=============
+-------------
.. include:: alpha_complex_sum.inc
-Cover complexes
-===============
+Rips complex
+-------------
+
+.. include:: rips_complex_sum.inc
-.. include:: nerve_gic_complex_sum.rst
+Witness complex
+---------------
-Cubical complex
+.. include:: witness_complex_sum.inc
+
+Cover complexes
===============
-.. include:: cubical_complex_sum.inc
+.. include:: nerve_gic_complex_sum.inc
-Rips complex
-============
+Data structures and basic operations
+************************************
-.. include:: rips_complex_sum.inc
+Data structures
+===============
Simplex tree
-============
+------------
.. include:: simplex_tree_sum.inc
+Topological descriptors computation
+***********************************
+
+Persistence cohomology
+======================
+
+.. include:: persistent_cohomology_sum.inc
+
+Manifold reconstruction
+***********************
+
Tangential complex
==================
.. include:: tangential_complex_sum.inc
-Witness complex
-===============
-
-.. include:: witness_complex_sum.inc
-
-Toolbox
-*******
+Topological descriptors tools
+*****************************
Bottleneck distance
===================
.. include:: bottleneck_distance_sum.inc
-Persistence cohomology
-======================
-
-.. include:: persistent_cohomology_sum.inc
-
Persistence graphical tools
===========================
diff --git a/src/cython/doc/nerve_gic_complex_sum.rst b/src/cython/doc/nerve_gic_complex_sum.inc
index 47bf84fd..47bf84fd 100644
--- a/src/cython/doc/nerve_gic_complex_sum.rst
+++ b/src/cython/doc/nerve_gic_complex_sum.inc
diff --git a/src/cython/doc/nerve_gic_complex_user.rst b/src/cython/doc/nerve_gic_complex_user.rst
index 44f30e1a..94a2b246 100644
--- a/src/cython/doc/nerve_gic_complex_user.rst
+++ b/src/cython/doc/nerve_gic_complex_user.rst
@@ -7,7 +7,7 @@ Cover complexes user manual
Definition
----------
-.. include:: nerve_gic_complex_sum.rst
+.. include:: nerve_gic_complex_sum.inc
Visualizations of the simplicial complexes can be done with either
neato (from `graphviz <http://www.graphviz.org/>`_),