summaryrefslogtreecommitdiff
path: root/src/python/introduction.rst
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-06-16 21:17:18 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-06-16 21:17:18 +0200
commit4e43680ec21c64e575ae991b39a2d897bda2a302 (patch)
treee57fd3de2e28f431dbd93dcab934eb9f069cc729 /src/python/introduction.rst
parent0a26e55af17a19b3e33b852b722f6d089abc6f9c (diff)
parenta12d1451d1413444319ccdc24bfacaae35012ce0 (diff)
Merge branch 'master' into edge_collapse_integration_vincent
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>`_.