summaryrefslogtreecommitdiff
path: root/src/python/introduction.rst
diff options
context:
space:
mode:
authorGard Spreemann <gspr@nonempty.org>2020-08-11 13:57:10 +0200
committerGard Spreemann <gspr@nonempty.org>2020-08-11 13:57:10 +0200
commit1c4694087c9cc2ea155ba99cd3484f788ad4daad (patch)
tree24d3b0e0451decf442e5c92f4c5d473ccfc60b76 /src/python/introduction.rst
parentfe7ba81633feafa9232546be4fef18cf37766b1f (diff)
parent1c05c20d7cf92c96b5036620cc892cb956c96785 (diff)
Merge branch 'dfsg/latest' into debian/sid
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>`_.