Gudhi  1.2.0
 All Classes Functions Variables Typedefs Friends Groups Pages
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 Demos and examples.

Compiling

The library uses c++11 and requires Boost with version 1.48.0 or more recent. It is a multi-platform library and compiles on Linux, Mac OSX and Visual Studio 2013.

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:

  • Persistent_cohomology/rips_multifield_persistence Having GMP version 4.2 or higher installed is recommended.

CGAL:

CGAL is a C++ library which provides easy access to efficient and reliable geometric algorithms.

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

  • GudhUI
  • Persistent_cohomology/alpha_shapes_persistence
  • Simplex_tree/simplex_tree_from_alpha_shapes_3

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

Demos and examples

To build the demos and libraries, run the following commands in a terminal:

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

Test suites

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

* make test
* 

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.