diff options
Diffstat (limited to 'src/cython/doc')
| -rw-r--r-- | src/cython/doc/installation.rst | 19 | ||||
| -rw-r--r-- | src/cython/doc/persistence_graphical_tools_user.rst | 25 |
2 files changed, 42 insertions, 2 deletions
diff --git a/src/cython/doc/installation.rst b/src/cython/doc/installation.rst index 0a715b34..c47802b9 100644 --- a/src/cython/doc/installation.rst +++ b/src/cython/doc/installation.rst @@ -135,3 +135,22 @@ 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>` + +Threading Building Blocks +========================= + +`Intel® TBB <https://www.threadingbuildingblocks.org/>`_ lets you easily write +parallel C++ programs that take full advantage of multicore performance, that +are portable and composable, and that have future-proof scalability. + +Having Intel® TBB installed is recommended to parallelize and accelerate some +GUDHI computations. + +Bug reports and contributions +***************************** + +Please help us improving the quality of the GUDHI library. You may report bugs or suggestions to: + + Contact: gudhi-users@lists.gforge.inria.fr + +GUDHI is open to external contributions. If you want to join our development team, please contact us. diff --git a/src/cython/doc/persistence_graphical_tools_user.rst b/src/cython/doc/persistence_graphical_tools_user.rst index 43c695bf..1a5195c5 100644 --- a/src/cython/doc/persistence_graphical_tools_user.rst +++ b/src/cython/doc/persistence_graphical_tools_user.rst @@ -17,6 +17,11 @@ This function is useful to show the color palette values of dimension: import gudhi gudhi.show_palette_values(alpha=1.0) +.. plot:: + + import gudhi + gudhi.show_palette_values(alpha=1.0) + Show persistence as a barcode ----------------------------- @@ -30,6 +35,13 @@ This function can display the persistence result as a barcode: diag = periodic_cc.persistence() gudhi.barcode_persistence(diag) +.. plot:: + + import gudhi + + periodic_cc = gudhi.PeriodicCubicalComplex(perseus_file='3d_torus.txt') + diag = periodic_cc.persistence() + gudhi.barcode_persistence(diag) Show persistence as a diagram ----------------------------- @@ -40,7 +52,16 @@ This function can display the persistence result as a diagram: import gudhi - alpha_complex = gudhi.AlphaComplex(off_file='tore3D_300.off') - simplex_tree = alpha_complex.create_simplex_tree() + rips_complex = gudhi.RipsComplex(off_file='tore3D_300.off', max_edge_length=2.0) + simplex_tree = rips_complex.create_simplex_tree(max_dimension=3) + diag = simplex_tree.persistence() + gudhi.diagram_persistence(diag) + +.. plot:: + + import gudhi + + rips_complex = gudhi.RipsComplex(off_file='tore3D_300.off', max_edge_length=2.0) + simplex_tree = rips_complex.create_simplex_tree(max_dimension=3) diag = simplex_tree.persistence() gudhi.diagram_persistence(diag) |