summaryrefslogtreecommitdiff
path: root/trunk/src/cython/doc/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'trunk/src/cython/doc/index.rst')
-rw-r--r--trunk/src/cython/doc/index.rst88
1 files changed, 88 insertions, 0 deletions
diff --git a/trunk/src/cython/doc/index.rst b/trunk/src/cython/doc/index.rst
new file mode 100644
index 00000000..3945d72a
--- /dev/null
+++ b/trunk/src/cython/doc/index.rst
@@ -0,0 +1,88 @@
+GUDHI Python module documentation
+#################################
+
+.. figure::
+ ../../doc/common/Gudhi_banner.png
+ :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:
+
+* Data structures to represent, construct and manipulate simplicial complexes.
+* Simplification of simplicial complexes by edge contraction.
+* Algorithms to compute persistent homology and bottleneck distance.
+
+We refer to :cite:`gudhilibrary_ICMS14` for a detailed description of the
+design of the library.
+
+Data structures
+***************
+
+Alpha complex
+=============
+
+.. include:: alpha_complex_sum.rst
+
+Cubical complex
+===============
+
+.. include:: cubical_complex_sum.rst
+
+Rips complex
+============
+
+.. include:: rips_complex_sum.rst
+
+Simplex tree
+============
+
+.. include:: simplex_tree_sum.rst
+
+Tangential complex
+==================
+
+.. include:: tangential_complex_sum.rst
+
+Witness complex
+===============
+
+.. include:: witness_complex_sum.rst
+
+
+Toolbox
+*******
+
+Bottleneck distance
+===================
+
+.. include:: bottleneck_distance_sum.rst
+
+Persistence cohomology
+======================
+
+.. include:: persistent_cohomology_sum.rst
+
+Persistence graphical tools
+===========================
+
+.. include:: persistence_graphical_tools_sum.rst
+
+Bibliography
+************
+
+.. bibliography:: ../../biblio/bibliography.bib
+ :filter: docnames
+ :style: unsrt