summaryrefslogtreecommitdiff
path: root/src/python/introduction.rst
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-06-19 15:33:43 +0200
committerMarc Glisse <marc.glisse@inria.fr>2020-06-19 15:33:43 +0200
commitf2ebd5d52eb2005d84c4abb631aaae6caf1f0157 (patch)
treeee5a0d2fc100265a464b073004b0a763f7483522 /src/python/introduction.rst
parentdd39431320e8c219b1eab9265c1a41aa53172ee5 (diff)
parentc43010ec0244748c2f86a2b6622713f68fbd6cb8 (diff)
Merge remote-tracking branch 'origin/master' into tomato2
Diffstat (limited to 'src/python/introduction.rst')
-rw-r--r--src/python/introduction.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/python/introduction.rst b/src/python/introduction.rst
new file mode 100644
index 00000000..11c06ac5
--- /dev/null
+++ b/src/python/introduction.rst
@@ -0,0 +1,24 @@
+The Gudhi library is an open source library for Computational Topology and
+Topological Data Analysis (TDA). It offers state-of-the-art algorithms
+to construct various types of simplicial complexes, data structures to
+represent them, and algorithms to compute geometric approximations of shapes
+and persistent homology.
+
+The GUDHI library offers the following interoperable modules:
+
+* Complexes:
+ * Cubical
+ * Simplicial: Rips, Witness, Alpha and Čech complexes
+ * Cover: Nerve and Graph induced complexes
+* Data structures and basic operations:
+ * Simplex tree, Skeleton blockers and Toplex map
+ * Construction, update, filtration and simplification
+* Topological descriptors computation
+* Manifold reconstruction
+* Topological descriptors tools:
+ * Bottleneck distance
+ * Statistical tools
+ * Persistence diagram and barcode
+
+For more information about Topological Data Analysis and its workflow, please
+refer to the `Wikipedia TDA dedicated page <https://en.wikipedia.org/wiki/Topological_data_analysis>`_.