summaryrefslogtreecommitdiff
path: root/src/python/introduction.rst
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-05-31 11:01:24 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-05-31 11:01:24 +0200
commit5141caeff03f1e8c8c4ccae1ee7ca43fbcb2925f (patch)
tree7123e5daffca4fc3307e49453e403a143eb06b02 /src/python/introduction.rst
parent3b91ae863718c402a991c5807579f578d266a04b (diff)
It was not markdown but rst...
Diffstat (limited to 'src/python/introduction.rst')
-rw-r--r--src/python/introduction.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/python/introduction.rst b/src/python/introduction.rst
new file mode 100644
index 00000000..2cc4642e
--- /dev/null
+++ b/src/python/introduction.rst
@@ -0,0 +1,33 @@
+.. figure::
+ https://gudhi.inria.fr/images/gudhi_architecture.png
+ :figclass: align-center
+ :width: 100 %
+ :alt: GUDHI
+
+Introduction
+============
+
+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>`_.