diff options
Diffstat (limited to 'src/common/doc/installation.h')
| -rw-r--r-- | src/common/doc/installation.h | 177 |
1 files changed, 94 insertions, 83 deletions
diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h index c2e63a24..ef668dfb 100644 --- a/src/common/doc/installation.h +++ b/src/common/doc/installation.h @@ -30,6 +30,10 @@ make \endverbatim * This action may require to be in the sudoer or administrator of the machine in function of the operating system and * of <a href="https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html">CMAKE_INSTALL_PREFIX</a>. * + * \note Python module will be compiled by the `make` command, but `make install` will not install it. Please refer to + * the <a href="https://gudhi.inria.fr/python/latest/installation.html#gudhi-python-module-installation">Python + * module installation documentation</a>. + * * \subsection testsuites Test suites * To test your build, run the following command in a terminal: * \verbatim make test \endverbatim @@ -40,11 +44,8 @@ make \endverbatim * \subsection documentationgeneration Documentation * To generate the documentation, <a target="_blank" href="http://www.doxygen.org/">Doxygen</a> is required. * Run the following command in a terminal: -\verbatim -make doxygen -# Documentation will be generated in the folder YYYY-MM-DD-hh-mm-ss_GUDHI_X.Y.Z/doc/html/ -# You can customize the directory name by calling `cmake -DUSER_VERSION_DIR=/my/custom/folder` -\endverbatim + * \verbatim make doxygen \endverbatim + * Documentation will be generated in a folder named <code>html</code>. * * \subsection helloworld Hello world ! * The <a target="_blank" href="https://github.com/GUDHI/hello-gudhi-world">Hello world for GUDHI</a> @@ -57,7 +58,7 @@ make doxygen * * The following example requires the <a target="_blank" href="http://gmplib.org/">GNU Multiple Precision Arithmetic * Library</a> (GMP) and will not be built if GMP is not installed: - * \li <a href="_persistent_cohomology_2rips_multifield_persistence_8cpp-example.html"> + * \li <a href="rips_multifield_persistence_8cpp-example.html"> * Persistent_cohomology/rips_multifield_persistence.cpp</a> * * Having GMP version 4.2 or higher installed is recommended. @@ -75,56 +76,58 @@ make doxygen * * The following examples/utilities require the <a target="_blank" href="http://www.cgal.org/">Computational Geometry Algorithms * Library</a> (CGAL \cite cgal:eb-19b) and will not be built if CGAL version 4.11.0 or higher is not installed: - * \li <a href="_simplex_tree_2example_alpha_shapes_3_simplex_tree_from_off_file_8cpp-example.html"> + * \li <a href="example_alpha_shapes_3_simplex_tree_from_off_file_8cpp-example.html"> * Simplex_tree/example_alpha_shapes_3_simplex_tree_from_off_file.cpp</a> - * \li <a href="_witness_complex_2strong_witness_persistence_8cpp-example.html"> + * \li <a href="strong_witness_persistence_8cpp-example.html"> * Witness_complex/strong_witness_persistence.cpp</a> - * \li <a href="_witness_complex_2weak_witness_persistence_8cpp-example.html"> + * \li <a href="weak_witness_persistence_8cpp-example.html"> * Witness_complex/weak_witness_persistence.cpp</a> - * \li <a href="_witness_complex_2example_strong_witness_complex_off_8cpp-example.html"> + * \li <a href="example_strong_witness_complex_off_8cpp-example.html"> * Witness_complex/example_strong_witness_complex_off.cpp</a> - * \li <a href="_witness_complex_2example_witness_complex_off_8cpp-example.html"> + * \li <a href="example_witness_complex_off_8cpp-example.html"> * Witness_complex/example_witness_complex_off.cpp</a> - * \li <a href="_witness_complex_2example_witness_complex_sphere_8cpp-example.html"> + * \li <a href="example_witness_complex_sphere_8cpp-example.html"> * Witness_complex/example_witness_complex_sphere.cpp</a> - * \li <a href="_alpha_complex_2_alpha_complex_from_off_8cpp-example.html"> + * \li <a href="_alpha_complex_from_off_8cpp-example.html"> * Alpha_complex/Alpha_complex_from_off.cpp</a> - * \li <a href="_alpha_complex_2_alpha_complex_from_points_8cpp-example.html"> + * \li <a href="_alpha_complex_from_points_8cpp-example.html"> * Alpha_complex/Alpha_complex_from_points.cpp</a> - * \li <a href="_alpha_complex_2alpha_complex_persistence_8cpp-example.html"> + * \li <a href="alpha_complex_persistence_8cpp-example.html"> * Alpha_complex/alpha_complex_persistence.cpp</a> - * \li <a href="_persistent_cohomology_2custom_persistence_sort_8cpp-example.html"> + * \li <a href="custom_persistence_sort_8cpp-example.html"> * Persistent_cohomology/custom_persistence_sort.cpp</a> - * \li <a href="_bottleneck_distance_2alpha_rips_persistence_bottleneck_distance_8cpp-example.html"> + * \li <a href="alpha_rips_persistence_bottleneck_distance_8cpp-example.html"> * Bottleneck_distance/alpha_rips_persistence_bottleneck_distance.cpp.cpp</a> - * \li <a href="_bottleneck_distance_2bottleneck_basic_example_8cpp-example.html"> + * \li <a href="bottleneck_basic_example_8cpp-example.html"> * Bottleneck_distance/bottleneck_basic_example.cpp</a> - * \li <a href="_bottleneck_distance_2bottleneck_read_file_8cpp-example.html"> + * \li <a href="bottleneck_distance_8cpp-example.html"> * Bottleneck_distance/bottleneck_distance.cpp</a> - * \li <a href="_nerve__g_i_c_2_coord_g_i_c_8cpp-example.html"> + * \li <a href="_coord_g_i_c_8cpp-example.html"> * Nerve_GIC/CoordGIC.cpp</a> - * \li <a href="_nerve__g_i_c_2_func_g_i_c_8cpp-example.html"> + * \li <a href="_func_g_i_c_8cpp-example.html"> * Nerve_GIC/FuncGIC.cpp</a> - * \li <a href="_nerve__g_i_c_2_nerve_8cpp-example.html"> + * \li <a href="_nerve_8cpp-example.html"> * Nerve_GIC/Nerve.cpp</a> - * \li <a href="_nerve__g_i_c_2_voronoi_g_i_c_8cpp-example.html"> + * \li <a href="_voronoi_g_i_c_8cpp-example.html"> * Nerve_GIC/VoronoiGIC.cpp</a> - * \li <a href="_spatial_searching_2example_spatial_searching_8cpp-example.html"> + * \li <a href="example_spatial_searching_8cpp-example.html"> * Spatial_searching/example_spatial_searching.cpp</a> - * \li <a href="_subsampling_2example_choose_n_farthest_points_8cpp-example.html"> + * \li <a href="example_choose_n_farthest_points_8cpp-example.html"> * Subsampling/example_choose_n_farthest_points.cpp</a> - * \li <a href="_subsampling_2example_pick_n_random_points_8cpp-example.html"> + * \li <a href="example_pick_n_random_points_8cpp-example.html"> * Subsampling/example_pick_n_random_points.cpp</a> - * \li <a href="_subsampling_2example_sparsify_point_set_8cpp-example.html"> + * \li <a href="example_sparsify_point_set_8cpp-example.html"> * Subsampling/example_sparsify_point_set.cpp</a> - * \li <a href="_tangential_complex_2example_basic_8cpp-example.html"> + * \li <a href="example_basic_8cpp-example.html"> * Tangential_complex/example_basic.cpp</a> - * \li <a href="_tangential_complex_2example_with_perturb_8cpp-example.html"> + * \li <a href="example_with_perturb_8cpp-example.html"> * Tangential_complex/example_with_perturb.cpp</a> - * \li <a href="_alpha_complex_2_weighted_alpha_complex_3d_from_points_8cpp-example.html"> + * \li <a href="_weighted_alpha_complex_3d_from_points_8cpp-example.html"> * Alpha_complex/Weighted_alpha_complex_3d_from_points.cpp</a> - * \li <a href="_alpha_complex_2alpha_complex_3d_persistence_8cpp-example.html"> + * \li <a href="alpha_complex_3d_persistence_8cpp-example.html"> * Alpha_complex/alpha_complex_3d_persistence.cpp</a> + * \li <a href="_coxeter_triangulation_2manifold_tracing_flat_torus_with_boundary_8cpp-example.html"> + * Coxeter_triangulation/manifold_tracing_flat_torus_with_boundary.cpp</a> * * \subsection eigen Eigen * Some GUDHI modules (cf. \ref main_page "modules list"), and few examples require @@ -133,42 +136,48 @@ make doxygen * * The following examples/utilities require the <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen</a> and will not be * built if Eigen is not installed: - * \li <a href="_alpha_complex_2_alpha_complex_from_off_8cpp-example.html"> + * \li <a href="_alpha_complex_from_off_8cpp-example.html"> * Alpha_complex/Alpha_complex_from_off.cpp</a> - * \li <a href="_alpha_complex_2_alpha_complex_from_points_8cpp-example.html"> + * \li <a href="_alpha_complex_from_points_8cpp-example.html"> * Alpha_complex/Alpha_complex_from_points.cpp</a> - * \li <a href="_alpha_complex_2alpha_complex_persistence_8cpp-example.html"> + * \li <a href="alpha_complex_persistence_8cpp-example.html"> * Alpha_complex/alpha_complex_persistence.cpp</a> - * \li <a href="_alpha_complex_2alpha_complex_3d_persistence_8cpp-example.html"> + * \li <a href="alpha_complex_3d_persistence_8cpp-example.html"> * Alpha_complex/alpha_complex_3d_persistence.cpp</a> - * \li <a href="_alpha_complex_2_weighted_alpha_complex_3d_from_points_8cpp-example.html"> + * \li <a href="_weighted_alpha_complex_3d_from_points_8cpp-example.html"> * Alpha_complex/Weighted_alpha_complex_3d_from_points.cpp</a> - * \li <a href="_bottleneck_distance_2alpha_rips_persistence_bottleneck_distance_8cpp-example.html"> + * \li <a href="alpha_rips_persistence_bottleneck_distance_8cpp-example.html"> * Bottleneck_distance/alpha_rips_persistence_bottleneck_distance.cpp.cpp</a> - * \li <a href="_persistent_cohomology_2custom_persistence_sort_8cpp-example.html"> + * \li <a href="custom_persistence_sort_8cpp-example.html"> * Persistent_cohomology/custom_persistence_sort.cpp</a> - * \li <a href="_spatial_searching_2example_spatial_searching_8cpp-example.html"> + * \li <a href="example_spatial_searching_8cpp-example.html"> * Spatial_searching/example_spatial_searching.cpp</a> - * \li <a href="_subsampling_2example_choose_n_farthest_points_8cpp-example.html"> + * \li <a href="example_choose_n_farthest_points_8cpp-example.html"> * Subsampling/example_choose_n_farthest_points.cpp</a> - * \li <a href="_subsampling_2example_pick_n_random_points_8cpp-example.html"> + * \li <a href="example_pick_n_random_points_8cpp-example.html"> * Subsampling/example_pick_n_random_points.cpp</a> - * \li <a href="_subsampling_2example_sparsify_point_set_8cpp-example.html"> + * \li <a href="example_sparsify_point_set_8cpp-example.html"> * Subsampling/example_sparsify_point_set.cpp</a> - * \li <a href="_tangential_complex_2example_basic_8cpp-example.html"> + * \li <a href="example_basic_8cpp-example.html"> * Tangential_complex/example_basic.cpp</a> - * \li <a href="_tangential_complex_2example_with_perturb_8cpp-example.html"> + * \li <a href="example_with_perturb_8cpp-example.html"> * Tangential_complex/example_with_perturb.cpp</a> - * \li <a href="_witness_complex_2strong_witness_persistence_8cpp-example.html"> + * \li <a href="strong_witness_persistence_8cpp-example.html"> * Witness_complex/strong_witness_persistence.cpp</a> - * \li <a href="_witness_complex_2weak_witness_persistence_8cpp-example.html"> + * \li <a href="weak_witness_persistence_8cpp-example.html"> * Witness_complex/weak_witness_persistence.cpp</a> - * \li <a href="_witness_complex_2example_strong_witness_complex_off_8cpp-example.html"> + * \li <a href="example_strong_witness_complex_off_8cpp-example.html"> * Witness_complex/example_strong_witness_complex_off.cpp</a> - * \li <a href="_witness_complex_2example_witness_complex_off_8cpp-example.html"> + * \li <a href="example_witness_complex_off_8cpp-example.html"> * Witness_complex/example_witness_complex_off.cpp</a> - * \li <a href="_witness_complex_2example_witness_complex_sphere_8cpp-example.html"> + * \li <a href="example_witness_complex_sphere_8cpp-example.html"> * Witness_complex/example_witness_complex_sphere.cpp</a> + * \li <a href="_coxeter_triangulation_2cell_complex_from_basic_circle_manifold_8cpp-example.html"> + * Coxeter_triangulation/cell_complex_from_basic_circle_manifold.cpp</a> + * \li <a href="_coxeter_triangulation_2manifold_tracing_custom_function_8cpp-example.html"> + * Coxeter_triangulation/manifold_tracing_custom_function.cpp</a> + * \li <a href="_coxeter_triangulation_2manifold_tracing_flat_torus_with_boundary_8cpp-example.html"> + * Coxeter_triangulation/manifold_tracing_flat_torus_with_boundary.cpp</a> * * \subsection tbb Threading Building Blocks * <a target="_blank" href="https://www.threadingbuildingblocks.org/">Intel® TBB</a> lets you easily write parallel @@ -178,74 +187,76 @@ make doxygen * Having Intel® TBB installed is recommended to parallelize and accelerate some GUDHI computations. * * The following examples/utilities are using Intel® TBB if installed: - * \li <a href="_alpha_complex_2_alpha_complex_from_off_8cpp-example.html"> + * \li <a href="_alpha_complex_from_off_8cpp-example.html"> * Alpha_complex/Alpha_complex_from_off.cpp</a> - * \li <a href="_alpha_complex_2_alpha_complex_from_points_8cpp-example.html"> + * \li <a href="_alpha_complex_from_points_8cpp-example.html"> * Alpha_complex/Alpha_complex_from_points.cpp</a> - * \li <a href="_alpha_complex_2alpha_complex_3d_persistence_8cpp-example.html"> + * \li <a href="alpha_complex_3d_persistence_8cpp-example.html"> * Alpha_complex/alpha_complex_3d_persistence.cpp</a> - * \li <a href="_alpha_complex_2alpha_complex_persistence_8cpp-example.html"> + * \li <a href="alpha_complex_persistence_8cpp-example.html"> * Alpha_complex/alpha_complex_persistence.cpp</a> - * \li <a href="_bitmap_cubical_complex_2_bitmap_cubical_complex_8cpp-example.html"> + * \li <a href="cubical_complex_persistence_8cpp-example.html"> * Bitmap_cubical_complex/cubical_complex_persistence.cpp</a> - * \li <a href="_bitmap_cubical_complex_2_bitmap_cubical_complex_periodic_boundary_conditions_8cpp-example.html"> + * \li <a href="periodic_cubical_complex_persistence_8cpp-example.html"> * Bitmap_cubical_complex/periodic_cubical_complex_persistence.cpp</a> - * \li <a href="_bitmap_cubical_complex_2_random_bitmap_cubical_complex_8cpp-example.html"> + * \li <a href="_random_bitmap_cubical_complex_8cpp-example.html"> * Bitmap_cubical_complex/Random_bitmap_cubical_complex.cpp</a> - * \li <a href="_nerve__g_i_c_2_coord_g_i_c_8cpp-example.html"> + * \li <a href="_coord_g_i_c_8cpp-example.html"> * Nerve_GIC/CoordGIC.cpp</a> - * \li <a href="_nerve__g_i_c_2_func_g_i_c_8cpp-example.html"> + * \li <a href="_func_g_i_c_8cpp-example.html"> * Nerve_GIC/FuncGIC.cpp</a> - * \li <a href="_nerve__g_i_c_2_nerve_8cpp-example.html"> + * \li <a href="_nerve_8cpp-example.html"> * Nerve_GIC/Nerve.cpp</a> - * \li <a href="_nerve__g_i_c_2_voronoi_g_i_c_8cpp-example.html"> + * \li <a href="_voronoi_g_i_c_8cpp-example.html"> * Nerve_GIC/VoronoiGIC.cpp</a> - * \li <a href="_simplex_tree_2simple_simplex_tree_8cpp-example.html"> + * \li <a href="simple_simplex_tree_8cpp-example.html"> * Simplex_tree/simple_simplex_tree.cpp</a> - * \li <a href="_simplex_tree_2example_alpha_shapes_3_simplex_tree_from_off_file_8cpp-example.html"> + * \li <a href="example_alpha_shapes_3_simplex_tree_from_off_file_8cpp-example.html"> * Simplex_tree/example_alpha_shapes_3_simplex_tree_from_off_file.cpp</a> - * \li <a href="_simplex_tree_2simplex_tree_from_cliques_of_graph_8cpp-example.html"> + * \li <a href="simplex_tree_from_cliques_of_graph_8cpp-example.html"> * Simplex_tree/simplex_tree_from_cliques_of_graph.cpp</a> - * \li <a href="_simplex_tree_2graph_expansion_with_blocker_8cpp-example.html"> + * \li <a href="graph_expansion_with_blocker_8cpp-example.html"> * Simplex_tree/graph_expansion_with_blocker.cpp</a> - * \li <a href="_persistent_cohomology_2alpha_complex_3d_persistence_8cpp-example.html"> + * \li <a href="alpha_complex_3d_persistence_8cpp-example.html"> * Persistent_cohomology/alpha_complex_3d_persistence.cpp</a> - * \li <a href="_persistent_cohomology_2alpha_complex_persistence_8cpp-example.html"> + * \li <a href="alpha_complex_persistence_8cpp-example.html"> * Persistent_cohomology/alpha_complex_persistence.cpp</a> - * \li <a href="_persistent_cohomology_2rips_persistence_via_boundary_matrix_8cpp-example.html"> + * \li <a href="rips_persistence_via_boundary_matrix_8cpp-example.html"> * Persistent_cohomology/rips_persistence_via_boundary_matrix.cpp</a> - * \li <a href="_persistent_cohomology_2persistence_from_file_8cpp-example.html"> + * \li <a href="persistence_from_file_8cpp-example.html"> * Persistent_cohomology/persistence_from_file.cpp</a> - * \li <a href="_persistent_cohomology_2persistence_from_simple_simplex_tree_8cpp-example.html"> + * \li <a href="persistence_from_simple_simplex_tree_8cpp-example.html"> * Persistent_cohomology/persistence_from_simple_simplex_tree.cpp</a> - * \li <a href="_persistent_cohomology_2plain_homology_8cpp-example.html"> + * \li <a href="plain_homology_8cpp-example.html"> * Persistent_cohomology/plain_homology.cpp</a> - * \li <a href="_persistent_cohomology_2rips_multifield_persistence_8cpp-example.html"> + * \li <a href="rips_multifield_persistence_8cpp-example.html"> * Persistent_cohomology/rips_multifield_persistence.cpp</a> - * \li <a href="_persistent_cohomology_2rips_persistence_step_by_step_8cpp-example.html"> + * \li <a href="rips_persistence_step_by_step_8cpp-example.html"> * Persistent_cohomology/rips_persistence_step_by_step.cpp</a> - * \li <a href="_persistent_cohomology_2custom_persistence_sort_8cpp-example.html"> + * \li <a href="custom_persistence_sort_8cpp-example.html"> * Persistent_cohomology/custom_persistence_sort.cpp</a> - * \li <a href="_rips_complex_2example_one_skeleton_rips_from_points_8cpp-example.html"> + * \li <a href="example_one_skeleton_rips_from_points_8cpp-example.html"> * Rips_complex/example_one_skeleton_rips_from_points.cpp</a> - * \li <a href="_rips_complex_2example_rips_complex_from_off_file_8cpp-example.html"> + * \li <a href="example_rips_complex_from_off_file_8cpp-example.html"> * Rips_complex/example_rips_complex_from_off_file.cpp</a> - * \li <a href="_rips_complex_2rips_distance_matrix_persistence_8cpp-example.html"> + * \li <a href="rips_distance_matrix_persistence_8cpp-example.html"> * Rips_complex/rips_distance_matrix_persistence.cpp</a> - * \li <a href="_rips_complex_2rips_persistence_8cpp-example.html"> + * \li <a href="rips_persistence_8cpp-example.html"> * Rips_complex/rips_persistence.cpp</a> - * \li <a href="_witness_complex_2strong_witness_persistence_8cpp-example.html"> + * \li <a href="strong_witness_persistence_8cpp-example.html"> * Witness_complex/strong_witness_persistence.cpp</a> - * \li <a href="_witness_complex_2weak_witness_persistence_8cpp-example.html"> + * \li <a href="weak_witness_persistence_8cpp-example.html"> * Witness_complex/weak_witness_persistence.cpp</a> - * \li <a href="_witness_complex_2example_nearest_landmark_table_8cpp-example.html"> + * \li <a href="example_nearest_landmark_table_8cpp-example.html"> * Witness_complex/example_nearest_landmark_table.cpp</a> * * \section Contributions Bug reports and contributions - * Please help us improving the quality of the GUDHI library. You may report bugs or suggestions to: - * \verbatim Contact: gudhi-users@lists.gforge.inria.fr \endverbatim + * Please help us improving the quality of the GUDHI library. + * You may <a href="https://github.com/GUDHI/gudhi-devel/issues">report bugs</a> or + * <a href="https://gudhi.inria.fr/contact/">contact us</a> for any suggestions. * - * GUDHI is open to external contributions. If you want to join our development team, please contact us. + * GUDHI is open to external contributions. If you want to join our development team, please take some time to read our + * <a href="https://github.com/GUDHI/gudhi-devel/blob/master/.github/CONTRIBUTING.md">contributing guide</a>. * */ |