summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-03-19 22:07:40 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-03-19 22:07:40 +0000
commit948341a6bf6e9ee8b5e61ae0e2b9ce6452751b76 (patch)
tree12cc317d36bd70382caf4347f1c31f8c8761f345
parent996374432e715d761ec153c47c9eb00b6b916527 (diff)
Add installation doc for witness
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST_cythonize@2201 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 6a531300cf80731e25b7d1337c79bd5bad0350bf
-rw-r--r--src/cython/doc/installation.rst25
1 files changed, 20 insertions, 5 deletions
diff --git a/src/cython/doc/installation.rst b/src/cython/doc/installation.rst
index c47802b9..e7d8c210 100644
--- a/src/cython/doc/installation.rst
+++ b/src/cython/doc/installation.rst
@@ -56,13 +56,14 @@ Optional third-party library
CGAL
====
-The :doc:`Alpha complex </alpha_complex_user>` data structure and
-:doc:`Tangential complex </tangential_complex_user>` data structures,
+The :doc:`Alpha complex </alpha_complex_user>`,
+:doc:`Tangential complex </tangential_complex_user>` and
+:doc:`Witness complex </witness_complex_user>` data structures, and
:doc:`Bottleneck distance </bottleneck_distance_user>` requires CGAL, which is a
C++ library which provides easy access to efficient and reliable geometric
algorithms.
-Having CGAL version 4.7.0 or higher installed is recommended. The procedure to
+Having CGAL version 4.6.0 or higher installed is recommended. The procedure to
install this library according to your operating system is detailed
`here <http://doc.cgal.org/latest/Manual/installation.html>`_.
@@ -70,6 +71,13 @@ The following examples require the Computational Geometry Algorithms Library:
.. only:: builder_html
+ * :download:`euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py <../example/euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py>`
+ * :download:`euclidean_witness_complex_diagram_persistence_from_off_file_example.py <../example/euclidean_witness_complex_diagram_persistence_from_off_file_example.py>`
+
+The following example requires CGAL version ≥ 4.7.0:
+
+.. only:: builder_html
+
* :download:`alpha_complex_diagram_persistence_from_off_file_example.py <../example/alpha_complex_diagram_persistence_from_off_file_example.py>`
* :download:`alpha_complex_from_points_example.py <../example/alpha_complex_from_points_example.py>`
@@ -83,8 +91,9 @@ The following example requires CGAL version ≥ 4.8.0:
Eigen3
======
-The :doc:`Alpha complex </alpha_complex_user>` and
-:doc:`Tangential complex </tangential_complex_user>` data structures and few
+The :doc:`Alpha complex </alpha_complex_user>`,
+:doc:`Tangential complex </tangential_complex_user>` and
+:doc:`Witness complex </witness_complex_user>` data structures and few
examples requires `Eigen3 <http://eigen.tuxfamily.org/>`_, a C++ template
library for linear algebra: matrices, vectors, numerical solvers, and related
algorithms.
@@ -96,6 +105,8 @@ The following examples require the `Eigen3 <http://eigen.tuxfamily.org/>`_:
* :download:`alpha_complex_diagram_persistence_from_off_file_example.py <../example/alpha_complex_diagram_persistence_from_off_file_example.py>`
* :download:`alpha_complex_from_points_example.py <../example/alpha_complex_from_points_example.py>`
* :download:`tangential_complex_plain_homology_from_off_file_example.py <../example/tangential_complex_plain_homology_from_off_file_example.py>`
+ * :download:`euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py <../example/euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py>`
+ * :download:`euclidean_witness_complex_diagram_persistence_from_off_file_example.py <../example/euclidean_witness_complex_diagram_persistence_from_off_file_example.py>`
Matplotlib
==========
@@ -116,6 +127,8 @@ The following examples require the `Matplotlib <http://matplotlib.org>`_:
* :download:`rips_persistence_diagram.py <../example/rips_persistence_diagram.py>`
* :download:`rips_complex_diagram_persistence_from_distance_matrix_file_example.py <../example/rips_complex_diagram_persistence_from_distance_matrix_file_example.py>`
* :download:`tangential_complex_plain_homology_from_off_file_example.py <../example/tangential_complex_plain_homology_from_off_file_example.py>`
+ * :download:`euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py <../example/euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py>`
+ * :download:`euclidean_witness_complex_diagram_persistence_from_off_file_example.py <../example/euclidean_witness_complex_diagram_persistence_from_off_file_example.py>`
Numpy
=====
@@ -135,6 +148,8 @@ The following examples require the `NumPy <http://numpy.org>`_:
* :download:`rips_persistence_diagram.py <../example/rips_persistence_diagram.py>`
* :download:`rips_complex_diagram_persistence_from_distance_matrix_file_example.py <../example/rips_complex_diagram_persistence_from_distance_matrix_file_example.py>`
* :download:`tangential_complex_plain_homology_from_off_file_example.py <../example/tangential_complex_plain_homology_from_off_file_example.py>`
+ * :download:`euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py <../example/euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py>`
+ * :download:`euclidean_witness_complex_diagram_persistence_from_off_file_example.py <../example/euclidean_witness_complex_diagram_persistence_from_off_file_example.py>`
Threading Building Blocks
=========================