| 1 |
/*! \page installation GUDHI installation |
| 2 |
* \tableofcontents |
| 3 |
* As GUDHI is a header only library, there is no need to install the library. |
| 4 |
* |
| 5 |
* Examples of GUDHI headers inclusion can be found in \ref utilities. |
| 6 |
* |
| 7 |
* \section compiling Compiling |
| 8 |
* The library uses c++17 and requires <a target="_blank" href="https://www.boost.org/">Boost</a> ≥ 1.71.0 |
| 9 |
* and <a target="_blank" href="https://cmake.org/">CMake</a> ≥ 3.15. |
| 10 |
* It is a multi-platform library and compiles on Linux, Mac OSX and Visual Studio 2017. |
| 11 |
* |
| 12 |
* \subsection utilities Utilities and examples |
| 13 |
* To build the utilities, run the following commands in a terminal: |
| 14 |
\verbatim cd /path-to-gudhi/ |
| 15 |
mkdir build |
| 16 |
cd build/ |
| 17 |
cmake -DCMAKE_BUILD_TYPE=Release .. |
| 18 |
make \endverbatim |
| 19 |
* By default, examples are disabled. You can activate their compilation with |
| 20 |
* <a href="https://cmake.org/cmake/help/latest/manual/ccmake.1.html">ccmake</a> (on Linux and Mac OSX), |
| 21 |
* <a href="https://cmake.org/cmake/help/latest/manual/cmake-gui.1.html">cmake-gui</a> (on Windows) or by modifying the |
| 22 |
* cmake command as follows : |
| 23 |
\verbatim cmake -DCMAKE_BUILD_TYPE=Release -DWITH_GUDHI_EXAMPLE=ON .. |
| 24 |
make \endverbatim |
| 25 |
* A list of utilities and examples is available <a href="examples.html">here</a>. |
| 26 |
* |
| 27 |
* \subsection libraryinstallation Installation |
| 28 |
* To install the library (headers and activated utilities), run the following command in a terminal: |
| 29 |
* \verbatim make install \endverbatim |
| 30 |
* This action may require to be in the sudoer or administrator of the machine in function of the operating system and |
| 31 |
* of <a href="https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html">CMAKE_INSTALL_PREFIX</a>. |
| 32 |
* |
| 33 |
* \note Python module will be compiled by the `make` command, but `make install` will not install it. Please refer to |
| 34 |
* the <a href="https://gudhi.inria.fr/python/latest/installation.html#gudhi-python-module-installation">Python |
| 35 |
* module installation documentation</a>. |
| 36 |
* |
| 37 |
* \subsection testsuites Test suites |
| 38 |
* To test your build, run the following command in a terminal: |
| 39 |
* \verbatim make test \endverbatim |
| 40 |
* `make test` is using <a href="https://cmake.org/cmake/help/latest/manual/ctest.1.html">Ctest</a> (CMake test driver |
| 41 |
* program). If some of the tests are failing, please send us the result of the following command: |
| 42 |
* \verbatim ctest --output-on-failure \endverbatim |
| 43 |
* Testing fetching datasets feature requires the use of the internet and is disabled by default. If you want to include this test, set WITH_GUDHI_REMOTE_TEST to ON when building in the previous step (note that this test is included in the python module): |
| 44 |
* \verbatim cmake -DCMAKE_BUILD_TYPE=Release -DWITH_GUDHI_TEST=ON -DWITH_GUDHI_REMOTE_TEST=ON --DWITH_GUDHI_PYTHON=ON .. \endverbatim |
| 45 |
* |
| 46 |
* \subsection documentationgeneration C++ documentation |
| 47 |
* To generate the C++ documentation, the <a target="_blank" href="http://www.doxygen.org/">doxygen</a> program |
| 48 |
* is required (version ≥ 1.9.5 is advised). Run the following command in a terminal: |
| 49 |
* \verbatim make doxygen \endverbatim |
| 50 |
* Documentation will be generated in a folder named <code>html</code>. |
| 51 |
* |
| 52 |
* In case there is not a full setup present and only the documentation should be build the following command sequence |
| 53 |
* can be used: |
| 54 |
\verbatim cmake -DWITH_GUDHI_THIRD_PARTY=OFF .. |
| 55 |
make doxygen\endverbatim |
| 56 |
* |
| 57 |
* \subsection helloworld Hello world ! |
| 58 |
* The <a target="_blank" href="https://github.com/GUDHI/hello-gudhi-world">Hello world for GUDHI</a> |
| 59 |
* project is an example to help developers to make their own C++ project on top of the GUDHI library. |
| 60 |
* |
| 61 |
* \section optionallibrary Optional third-party library |
| 62 |
* \subsection gmp GMP |
| 63 |
* The multi-field persistent homology algorithm requires GMP which is a free library for arbitrary-precision |
| 64 |
* arithmetic, operating on signed integers, rational numbers, and floating point numbers. |
| 65 |
* |
| 66 |
* The following example requires the <a target="_blank" href="https://gmplib.org/">GNU Multiple Precision Arithmetic |
| 67 |
* Library</a> (GMP) and will not be built if GMP is not installed: |
| 68 |
* \li \gudhi_example_link{Persistent_cohomology,rips_multifield_persistence.cpp} |
| 69 |
* |
| 70 |
* Having GMP version 4.2 or higher installed is recommended. |
| 71 |
* |
| 72 |
* \subsection cgal CGAL |
| 73 |
* Some GUDHI modules (cf. \ref main_page "modules list"), and few examples require CGAL, a C++ library that provides |
| 74 |
* easy access to efficient and reliable geometric algorithms. |
| 75 |
* |
| 76 |
* \note There is no need to install CGAL, you can just <CODE>cmake -DCMAKE_BUILD_TYPE=Release . && make</CODE> CGAL |
| 77 |
* (or even <CODE>cmake -DCMAKE_BUILD_TYPE=Release -DCGAL_HEADER_ONLY=ON .</CODE>), thereafter you will be able to |
| 78 |
* compile GUDHI by calling <CODE>cmake -DCMAKE_BUILD_TYPE=Release -DCGAL_DIR=/your/path/to/CGAL-X.Y .. && make</CODE> |
| 79 |
* |
| 80 |
* The procedure to install this library according to |
| 81 |
* your operating system is detailed here http://doc.cgal.org/latest/Manual/installation.html |
| 82 |
* |
| 83 |
* The following examples/utilities require the <a target="_blank" href="http://www.cgal.org/">Computational Geometry Algorithms |
| 84 |
* Library</a> (CGAL \cite cgal:eb-19b) and will not be built if CGAL version 5.1.0 or higher is not installed: |
| 85 |
* \li \gudhi_example_link{Simplex_tree,example_alpha_shapes_3_simplex_tree_from_off_file.cpp} |
| 86 |
* \li \gudhi_example_link{Witness_complex,strong_witness_persistence.cpp} |
| 87 |
* \li \gudhi_example_link{Witness_complex,weak_witness_persistence.cpp} |
| 88 |
* \li \gudhi_example_link{Witness_complex,example_strong_witness_complex_off.cpp} |
| 89 |
* \li \gudhi_example_link{Witness_complex,example_witness_complex_off.cpp} |
| 90 |
* \li \gudhi_example_link{Witness_complex,example_witness_complex_sphere.cpp} |
| 91 |
* \li \gudhi_example_link{Alpha_complex,Alpha_complex_from_off.cpp} |
| 92 |
* \li \gudhi_example_link{Alpha_complex,Alpha_complex_from_points.cpp} |
| 93 |
* \li \gudhi_example_link{Alpha_complex,alpha_complex_persistence.cpp} |
| 94 |
* \li \gudhi_example_link{Persistent_cohomology,custom_persistence_sort.cpp} |
| 95 |
* \li \gudhi_example_link{Bottleneck_distance,alpha_rips_persistence_bottleneck_distance.cpp} |
| 96 |
* \li \gudhi_example_link{Bottleneck_distance,bottleneck_basic_example.cpp} |
| 97 |
* \li \gudhi_example_link{Bottleneck_distance,bottleneck_distance.cpp} |
| 98 |
* \li \gudhi_example_link{Nerve_GIC,CoordGIC.cpp} |
| 99 |
* \li \gudhi_example_link{Nerve_GIC,FuncGIC.cpp} |
| 100 |
* \li \gudhi_example_link{Nerve_GIC,Nerve.cpp} |
| 101 |
* \li \gudhi_example_link{Nerve_GIC,VoronoiGIC.cpp} |
| 102 |
* \li \gudhi_example_link{Spatial_searching,example_spatial_searching.cpp} |
| 103 |
* \li \gudhi_example_link{Subsampling,example_choose_n_farthest_points.cpp} |
| 104 |
* \li \gudhi_example_link{Subsampling,example_pick_n_random_points.cpp} |
| 105 |
* \li \gudhi_example_link{Subsampling,example_sparsify_point_set.cpp} |
| 106 |
* \li \gudhi_example_link{Tangential_complex,example_basic.cpp} |
| 107 |
* \li \gudhi_example_link{Tangential_complex,example_with_perturb.cpp} |
| 108 |
* \li \gudhi_example_link{Alpha_complex,Weighted_alpha_complex_3d_from_points.cpp} |
| 109 |
* \li \gudhi_example_link{Alpha_complex,alpha_complex_3d_persistence.cpp} |
| 110 |
* \li \gudhi_example_link{Coxeter_triangulation,manifold_tracing_flat_torus_with_boundary.cpp} |
| 111 |
* |
| 112 |
* \subsection eigen Eigen |
| 113 |
* Some GUDHI modules (cf. \ref main_page "modules list"), and few examples require |
| 114 |
* <a target="_blank" href="https://eigen.tuxfamily.org">Eigen</a> is a C++ template library for linear algebra: |
| 115 |
* matrices, vectors, numerical solvers, and related algorithms. |
| 116 |
* |
| 117 |
* The following examples/utilities require the <a target="_blank" href="https://eigen.tuxfamily.org">Eigen</a> and will not be |
| 118 |
* built if Eigen version 3.3.0 or higher is not installed: |
| 119 |
* \li \gudhi_example_link{Alpha_complex,Alpha_complex_from_off.cpp} |
| 120 |
* \li \gudhi_example_link{Alpha_complex,Alpha_complex_from_points.cpp} |
| 121 |
* \li \gudhi_example_link{Alpha_complex,alpha_complex_persistence.cpp} |
| 122 |
* \li \gudhi_example_link{Alpha_complex,alpha_complex_3d_persistence.cpp} |
| 123 |
* \li \gudhi_example_link{Alpha_complex,Weighted_alpha_complex_3d_from_points.cpp} |
| 124 |
* \li \gudhi_example_link{Bottleneck_distance,alpha_rips_persistence_bottleneck_distance.cpp} |
| 125 |
* \li \gudhi_example_link{Persistent_cohomology,custom_persistence_sort.cpp} |
| 126 |
* \li \gudhi_example_link{Spatial_searching,example_spatial_searching.cpp} |
| 127 |
* \li \gudhi_example_link{Subsampling,example_choose_n_farthest_points.cpp} |
| 128 |
* \li \gudhi_example_link{Subsampling,example_pick_n_random_points.cpp} |
| 129 |
* \li \gudhi_example_link{Subsampling,example_sparsify_point_set.cpp} |
| 130 |
* \li \gudhi_example_link{Tangential_complex,example_basic.cpp} |
| 131 |
* \li \gudhi_example_link{Tangential_complex,example_with_perturb.cpp} |
| 132 |
* \li \gudhi_example_link{Witness_complex,strong_witness_persistence.cpp} |
| 133 |
* \li \gudhi_example_link{Witness_complex,weak_witness_persistence.cpp} |
| 134 |
* \li \gudhi_example_link{Witness_complex,example_strong_witness_complex_off.cpp} |
| 135 |
* \li \gudhi_example_link{Witness_complex,example_witness_complex_off.cpp} |
| 136 |
* \li \gudhi_example_link{Witness_complex,example_witness_complex_sphere.cpp} |
| 137 |
* \li \gudhi_example_link{Coxeter_triangulation,cell_complex_from_basic_circle_manifold.cpp} |
| 138 |
* \li \gudhi_example_link{Coxeter_triangulation,manifold_tracing_custom_function.cpp} |
| 139 |
* \li \gudhi_example_link{Coxeter_triangulation,manifold_tracing_flat_torus_with_boundary.cpp} |
| 140 |
* |
| 141 |
* \subsection tbb oneAPI Threading Building Blocks |
| 142 |
* <a target="_blank" href="https://github.com/oneapi-src/oneTBB">Intel® oneAPI TBB</a> lets you easily write |
| 143 |
* parallel C++ programs that take full advantage of multicore performance, that are portable and composable, and that |
| 144 |
* have future-proof scalability. |
| 145 |
* |
| 146 |
* Having Intel® oneAPI TBB (version 20.19.7 or higher) installed is recommended to parallelize and accelerate some |
| 147 |
* GUDHI computations. |
| 148 |
* |
| 149 |
* The following examples/utilities are using Intel® oneAPI TBB if installed: |
| 150 |
* \li \gudhi_example_link{Alpha_complex,Alpha_complex_from_off.cpp} |
| 151 |
* \li \gudhi_example_link{Alpha_complex,Alpha_complex_from_points.cpp} |
| 152 |
* \li \gudhi_example_link{Alpha_complex,alpha_complex_3d_persistence.cpp} |
| 153 |
* \li \gudhi_example_link{Alpha_complex,alpha_complex_persistence.cpp} |
| 154 |
* \li \gudhi_example_link{Bitmap_cubical_complex,cubical_complex_persistence.cpp} |
| 155 |
* \li \gudhi_example_link{Bitmap_cubical_complex,periodic_cubical_complex_persistence.cpp} |
| 156 |
* \li \gudhi_example_link{Bitmap_cubical_complex,Random_bitmap_cubical_complex.cpp} |
| 157 |
* \li \gudhi_example_link{Nerve_GIC,CoordGIC.cpp} |
| 158 |
* \li \gudhi_example_link{Nerve_GIC,FuncGIC.cpp} |
| 159 |
* \li \gudhi_example_link{Nerve_GIC,Nerve.cpp} |
| 160 |
* \li \gudhi_example_link{Nerve_GIC,VoronoiGIC.cpp} |
| 161 |
* \li \gudhi_example_link{Simplex_tree,simple_simplex_tree.cpp} |
| 162 |
* \li \gudhi_example_link{Simplex_tree,example_alpha_shapes_3_simplex_tree_from_off_file.cpp} |
| 163 |
* \li \gudhi_example_link{Simplex_tree,simplex_tree_from_cliques_of_graph.cpp} |
| 164 |
* \li \gudhi_example_link{Simplex_tree,graph_expansion_with_blocker.cpp} |
| 165 |
* \li \gudhi_example_link{Persistent_cohomology,alpha_complex_3d_persistence.cpp} |
| 166 |
* \li \gudhi_example_link{Persistent_cohomology,alpha_complex_persistence.cpp} |
| 167 |
* \li \gudhi_example_link{Persistent_cohomology,rips_persistence_via_boundary_matrix.cpp} |
| 168 |
* \li \gudhi_example_link{Persistent_cohomology,persistence_from_file.cpp} |
| 169 |
* \li \gudhi_example_link{Persistent_cohomology,persistence_from_simple_simplex_tree.cpp} |
| 170 |
* \li \gudhi_example_link{Persistent_cohomology,plain_homology.cpp} |
| 171 |
* \li \gudhi_example_link{Persistent_cohomology,rips_multifield_persistence.cpp} |
| 172 |
* \li \gudhi_example_link{Persistent_cohomology,rips_persistence_step_by_step.cpp} |
| 173 |
* \li \gudhi_example_link{Persistent_cohomology,custom_persistence_sort.cpp} |
| 174 |
* \li \gudhi_example_link{Rips_complex,example_one_skeleton_rips_from_points.cpp} |
| 175 |
* \li \gudhi_example_link{Rips_complex,example_rips_complex_from_off_file.cpp} |
| 176 |
* \li \gudhi_example_link{Rips_complex,rips_distance_matrix_persistence.cpp} |
| 177 |
* \li \gudhi_example_link{Rips_complex,rips_persistence.cpp} |
| 178 |
* \li \gudhi_example_link{Witness_complex,strong_witness_persistence.cpp} |
| 179 |
* \li \gudhi_example_link{Witness_complex,weak_witness_persistence.cpp} |
| 180 |
* \li \gudhi_example_link{Witness_complex,example_nearest_landmark_table.cpp} |
| 181 |
* |
| 182 |
* \section Contributions Bug reports and contributions |
| 183 |
* Please help us improving the quality of the GUDHI library. |
| 184 |
* You may <a href="https://github.com/GUDHI/gudhi-devel/issues">report bugs</a> or |
| 185 |
* <a href="https://gudhi.inria.fr/contact/">contact us</a> for any suggestions. |
| 186 |
* |
| 187 |
* GUDHI is open to external contributions. If you want to join our development team, please take some time to read our |
| 188 |
* <a href="https://github.com/GUDHI/gudhi-devel/blob/master/.github/CONTRIBUTING.md">contributing guide</a>. |
| 189 |
* |
| 190 |
*/ |
| 191 |
|
| 192 |
/*! \page Citation Acknowledging the GUDHI library |
| 193 |
* We kindly ask users to cite the GUDHI library as appropriately as possible in their papers, and to mention the use |
| 194 |
* of the GUDHI library on the web pages of their projects using GUDHI and provide us with links to these web pages. |
| 195 |
* Feel free to contact us in case you have any question or remark on this topic. |
| 196 |
* |
| 197 |
* We provide \ref GudhiBibtex entries for the modules of the User and Reference Manual, as well as for publications |
| 198 |
* directly related to the GUDHI library. |
| 199 |
* \section GudhiBibtex GUDHI bibtex |
| 200 |
* \verbinclude biblio/how_to_cite_gudhi.bib |
| 201 |
*/ |