summaryrefslogtreecommitdiff
path: root/src/common/doc/main_page.h
blob: 83908905a8a6fb4204d9c190e9301d6acf6d2000 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/**
\mainpage 

\image html "Gudhi_banner.jpg" "" width=20cm

The Gudhi library (Geometric Understanding in Higher Dimensions) is a generic C++ library for 
topological analysis of high-dimensional data whose goal is to provide robust, efficient, flexible and easy to use 
implementations of 
state-of-the-art algorithms and data structures for computational topology. 

The current release of the library allows to use several data-structures for simplicial complexes :
simplex tree, Hasse diagram or skeleton-blocker. Several  operations can then be done on top of these
representations such as persistent homology computation or simplification. 
All data-structures are generic and several of their aspects (such as stored elements, policies) 
can be parameterized via template classes.
We refer to 
\cite gudhilibrary_ICMS14
for a detailed description of the design of the library.


\section compiling Compiling

The library uses c++11 and requires Boost with version 1.48.0 or more recent :  http://www.boost.org/.
It is a multiplaform library and compiles on Linux, Mac OSX and Visual Studio 2013. 


\subsection gmp 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 examples require The GNU Multiple Precision Arithmetic Library (GMP) http://gmplib.org/
and will not be built if GMP is not installed:
  - Persistent_cohomology/rips_multifield_persistence
  - Simplex_tree/simplex_tree_from_alpha_shapes_3

Having GMP version 4.2 or higher installed is recommended. This library can be obtained from http://gmplib.org/

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

The following example requires CGAL https://www.cgal.org/ and will not be built if CGAL is not installed:
  - 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

\section demos Demos and Examples

To build the library, run the following in a terminal:

\verbatim
cd /path-to-gudhi/
mkdir build
cd build/
cmake -DCMAKE_BUILD_TYPE=Release ..
make
\endverbatim





\details 

\copyright GNU General Public License v3.                         
\verbatim  Contact: gudhi-users@lists.gforge.inria.fr \endverbatim

*/