diff options
Diffstat (limited to 'src/cython/doc')
| -rw-r--r-- | src/cython/doc/installation.rst | 3 | ||||
| -rw-r--r-- | src/cython/doc/persistence_graphical_tools_ref.rst | 1 | ||||
| -rw-r--r-- | src/cython/doc/persistence_graphical_tools_user.rst | 26 | ||||
| -rwxr-xr-x | src/cython/doc/pyplots/diagram_persistence.py | 4 | ||||
| -rwxr-xr-x | src/cython/doc/pyplots/show_palette_values.py | 3 | ||||
| -rw-r--r-- | src/cython/doc/tangential_complex_user.rst | 7 |
6 files changed, 13 insertions, 31 deletions
diff --git a/src/cython/doc/installation.rst b/src/cython/doc/installation.rst index 52c5eb49..b0bc5f38 100644 --- a/src/cython/doc/installation.rst +++ b/src/cython/doc/installation.rst @@ -43,6 +43,9 @@ following command in a terminal: export PYTHONPATH='$PYTHONPATH:/path-to-gudhi/build/cython' ctest -R py_test +If tests fail, please try to :code:`import gudhi` and check the errors. +The problem can come from a third-party library bad link or installation. + Documentation ============= diff --git a/src/cython/doc/persistence_graphical_tools_ref.rst b/src/cython/doc/persistence_graphical_tools_ref.rst index 27c2f68a..a69c8ba2 100644 --- a/src/cython/doc/persistence_graphical_tools_ref.rst +++ b/src/cython/doc/persistence_graphical_tools_ref.rst @@ -3,6 +3,5 @@ Persistence graphical tools reference manual ============================================ .. autofunction:: gudhi.__min_birth_max_death -.. autofunction:: gudhi.show_palette_values .. autofunction:: gudhi.plot_persistence_barcode .. autofunction:: gudhi.plot_persistence_diagram diff --git a/src/cython/doc/persistence_graphical_tools_user.rst b/src/cython/doc/persistence_graphical_tools_user.rst index a5523d23..46f871c7 100644 --- a/src/cython/doc/persistence_graphical_tools_user.rst +++ b/src/cython/doc/persistence_graphical_tools_user.rst @@ -5,24 +5,6 @@ Definition .. include:: persistence_graphical_tools_sum.rst -Show palette values -------------------- - -This function is useful to show the color palette values of dimension: - - -.. testcode:: - - import gudhi - plt = gudhi.show_palette_values(alpha=1.0) - plt.show() - -.. plot:: - - import gudhi - plt = gudhi.show_palette_values(alpha=1.0) - plt.show() - Show persistence as a barcode ----------------------------- @@ -59,10 +41,10 @@ This function can display the persistence result as a diagram: import gudhi point_cloud = gudhi.read_off(off_file=gudhi.__root_source_dir__ + '/data/points/tore3D_1307.off') - rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.2) + rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.3) simplex_tree = rips_complex.create_simplex_tree(max_dimension=3) diag = simplex_tree.persistence() - plt = gudhi.plot_persistence_diagram(diag, band_boot=0.13) + plt = gudhi.plot_persistence_diagram(diag) plt.show() .. plot:: @@ -70,8 +52,8 @@ This function can display the persistence result as a diagram: import gudhi point_cloud = gudhi.read_off(off_file=gudhi.__root_source_dir__ + '/data/points/tore3D_1307.off') - rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.2) + rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.3) simplex_tree = rips_complex.create_simplex_tree(max_dimension=3) diag = simplex_tree.persistence() - plt = gudhi.plot_persistence_diagram(diag, band_boot=0.13) + plt = gudhi.plot_persistence_diagram(diag) plt.show() diff --git a/src/cython/doc/pyplots/diagram_persistence.py b/src/cython/doc/pyplots/diagram_persistence.py index ac20bf47..3bab0ca1 100755 --- a/src/cython/doc/pyplots/diagram_persistence.py +++ b/src/cython/doc/pyplots/diagram_persistence.py @@ -2,8 +2,8 @@ import gudhi point_cloud = gudhi.read_off(off_file=gudhi.__root_source_dir__ + \ '/data/points/tore3D_1307.off') -rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.2) +rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.3) simplex_tree = rips_complex.create_simplex_tree(max_dimension=3) diag = simplex_tree.persistence() -plt = gudhi.plot_persistence_diagram(diag, band_boot=0.13) +plt = gudhi.plot_persistence_diagram(diag) plt.show() diff --git a/src/cython/doc/pyplots/show_palette_values.py b/src/cython/doc/pyplots/show_palette_values.py deleted file mode 100755 index fdf9645f..00000000 --- a/src/cython/doc/pyplots/show_palette_values.py +++ /dev/null @@ -1,3 +0,0 @@ -import gudhi -plt = gudhi.show_palette_values(alpha=1.0) -plt.show() diff --git a/src/cython/doc/tangential_complex_user.rst b/src/cython/doc/tangential_complex_user.rst index efa6d7ce..fafb3193 100644 --- a/src/cython/doc/tangential_complex_user.rst +++ b/src/cython/doc/tangential_complex_user.rst @@ -122,8 +122,8 @@ This example builds the Tangential complex of point set read in an OFF file. .. testcode:: import gudhi - tc = gudhi.TangentialComplex(off_file=gudhi.__root_source_dir__ + \ - '/data/points/alphacomplexdoc.off') + tc = gudhi.TangentialComplex(intrisic_dim = 1, + off_file=gudhi.__root_source_dir__ + '/data/points/alphacomplexdoc.off') result_str = 'Tangential contains ' + repr(tc.num_simplices()) + \ ' simplices - ' + repr(tc.num_vertices()) + ' vertices.' print(result_str) @@ -169,7 +169,8 @@ simplices. .. testcode:: import gudhi - tc = gudhi.TangentialComplex(points=[[0.0, 0.0], [1.0, 0.0], [0.0, 1.0], [1.0, 1.0]]) + tc = gudhi.TangentialComplex(intrisic_dim = 1, + points=[[0.0, 0.0], [1.0, 0.0], [0.0, 1.0], [1.0, 1.0]]) result_str = 'Tangential contains ' + repr(tc.num_vertices()) + ' vertices.' print(result_str) |