summaryrefslogtreecommitdiff
path: root/src/python
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-05-31 10:43:07 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-05-31 10:43:07 +0200
commit3b91ae863718c402a991c5807579f578d266a04b (patch)
tree0e10bab34907a28ce565672db3fd64b22b93e87b /src/python
parent433a8cdaa111ebb777450fc1ee2e316480e4b46a (diff)
add md file
Diffstat (limited to 'src/python')
-rw-r--r--src/python/introduction.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/src/python/introduction.md b/src/python/introduction.md
new file mode 100644
index 00000000..3277e0ac
--- /dev/null
+++ b/src/python/introduction.md
@@ -0,0 +1,30 @@
+![](https://gudhi.inria.fr/images/gudhi_architecture.png)
+
+#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][1].
+
+ [1]: https://en.wikipedia.org/wiki/Topological_data_analysis
+