GUDHI installation

As GUDHI is a header only library, there is no need to install the library.

Examples of GUDHI headers inclusion can be found in Utilities and examples.

Compiling

The library uses c++11 and requires Boost ≥ 1.48.0 and CMake ≥ 3.1. It is a multi-platform library and compiles on Linux, Mac OSX and Visual Studio 2015.

Utilities and examples

To build the utilities, run the following commands in a terminal:

cd /path-to-gudhi/
mkdir build
cd build/
cmake ..
make 

By default, examples are disabled. You can activate their compilation with ccmake (on Linux and Mac OSX), cmake-gui (on Windows) or y mofifying the cmake command as follows :

cmake -DWITH_GUDHI_EXAMPLE=ON ..
make 

A list of utilities and examples is available here.

Installation

To install the library (headers and activated utilities), run the following command in a terminal:

make install 

This action may require to be in the sudoer or administrator of the machine in function of the operating system and of CMAKE_INSTALL_PREFIX.

Test suites

To test your build, run the following command in a terminal:

make test 

Documentation

To generate the documentation, Doxygen is required. Run the following command in a terminal:

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`

Hello world !

The Hello world for GUDHI project is an example to help developers to make their own C++ project on top of the GUDHI library.

Optional third-party library

GMP

The multi-field persistent homology algorithm requires GMP which is a free library for arbitrary-precision arithmetic, operating on signed integers, rational numbers, and floating point numbers.

The following example requires the GNU Multiple Precision Arithmetic Library (GMP) and will not be built if GMP is not installed:

Having GMP version 4.2 or higher installed is recommended.

CGAL

The Alpha complex data structure, Bottleneck distance, and few examples requires CGAL, which is a C++ library which provides easy access to efficient and reliable geometric algorithms.

Note
There is no need to install CGAL, you can just cmake . && make CGAL (or even cmake -DCGAL_HEADER_ONLY=ON . for CGAL version ≥ 4.8.0), thereafter you will be able to compile GUDHI by calling cmake -DCGAL_DIR=/your/path/to/CGAL-X.Y .. && make

Having CGAL version 4.4.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

The following examples/utilities require the Computational Geometry Algorithms Library (CGAL [35]) and will not be built if CGAL is not installed:

The following examples/utilities require CGAL version ≥ 4.6.0:

The following example requires CGAL version ≥ 4.7.0:

The following example requires CGAL version ≥ 4.8.1:

Eigen3

The Alpha complex data structure and few examples requires Eigen3 is a C++ template library for linear algebra: matrices, vectors, numerical solvers, and related algorithms.

The following examples/utilities require the Eigen3 and will not be built if Eigen3 is not installed:

Threading Building Blocks

Intel® TBB 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.

The following examples/utilities are using Intel® TBB if installed:

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.

GUDHI  Version 2.3.0  - C++ library for Topological Data Analysis (TDA) and Higher Dimensional Geometry Understanding.  - Copyright : GPL v3 Generated on Tue Sep 4 2018 14:33:00 for GUDHI by Doxygen 1.8.13