From 3b22ae31478387efd64ae5f185128857f17ca9ee Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Fri, 23 Oct 2015 09:40:36 +0000 Subject: generate_version excludes bottleneck for version 1.2.0 - to be removed for 1.3.0 generate_version copies concept for doxygen purpose Contact gudhi-users on skbl and contraction page Doxygen warning fixes Doxygen Software section git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@871 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: bd7e252c2d0528f4bbc40c33a9221e1d6b386510 --- src/common/doc/main_page.h | 51 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 50 insertions(+), 1 deletion(-) (limited to 'src/common') diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 315aa0ac..d1060740 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -7,7 +7,7 @@ The Gudhi library (Geometric Understanding in Higher Dimensions) is a generic C+ 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. -This library is part of the Gudhi project. +This library is part of the Gudhi project. 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 @@ -70,3 +70,52 @@ make \verbatim Contact: gudhi-users@lists.gforge.inria.fr \endverbatim */ + +/*! \page Software Software + * \tableofcontents + * \section SoftwareIntroduction Introduction + * The GUDHI open source library will provide the central data structures and algorithms that underly applications in geometry understanding in higher dimensions. It is intended to both help the development of new algorithmic solutions inside and outside the project, and to facilitate the transfer of results in applied fields. + * + * The current release of the GUDHI library includes: + * + * – Data structures to represent, construct and manipulate simplicial complexes. + * + * – Algorithms to compute persistent homology and multi-field persistent homology. + * + * – Simplification methods via implicit representations. + * + * + * The library is available here and the documentation is + * available at this webpage. + * + * \section ReleaseHistory Release history + * + * – ??-??-2015; release v.1.2.0, Skeleton-Blocker simplex insertion, GudhUI (Gudhi Qt demo), Simplex tree coface function, Clang build issue fix. + * + * – 12-18-2014; release v.1.1, Skeleton-Blocker data-structure, simplification package, additional examples for topological persistence. + * + * – 08-12-2014; release v. 1.0.2, initialize simplex keys in initialize_filtration in Simplex_tree + * + * – 07-11-2014: release v. 1.0.1, bug fix in summing columns in Persistent_cohomology + * + * – 06-23-2014: release v. 1.0 + * + * \section Citation How to cite Gudhi + * Each Gudhi module (either data structures or algorithms) has an author section. + * + * Thank you to refer to this section, and to cite the author(s) of all the module you are using. + * + * \section Soon Coming soon + * + * – Alpha complex. + * + * – Bottleneck distance. + * + * – Zig zag persistence. + * + * – Witness complex. + * + * – Tangential complex. + * + * – Hard clustering. +*/ -- cgit v1.2.3 From 03f17b1d0bfd5473dc10b3d2d31ad9da60954d30 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Fri, 23 Oct 2015 15:53:32 +0000 Subject: Software page text modification git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@872 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 43ef4b9ee503de54decee6a25bcd88c9b79be34f --- src/CMakeLists.txt | 2 +- src/common/doc/main_page.h | 9 +++++---- 2 files changed, 6 insertions(+), 5 deletions(-) (limited to 'src/common') diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index a84090e9..68eca65e 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -75,7 +75,7 @@ else() # Install the GUDHIConfig.cmake and GUDHIConfigVersion.cmake install(FILES - "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/GUDHIConfig.cmake" + "${PROJECT_BINARY_DIR}/GUDHIConfig.cmake" "${PROJECT_BINARY_DIR}/GUDHIConfigVersion.cmake" DESTINATION share/gudhi) diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index d1060740..55cf53a6 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -38,7 +38,6 @@ arithmetic, operating on signed integers, rational numbers, and floating point n The following examples require the GNU Multiple Precision Arithmetic Library (GMP) 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. @@ -47,6 +46,8 @@ CGAL is a C++ library which provides easy access to efficient and reliable geome The following example requires 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 @@ -90,7 +91,7 @@ make * * \section ReleaseHistory Release history * - * – ??-??-2015; release v.1.2.0, Skeleton-Blocker simplex insertion, GudhUI (Gudhi Qt demo), Simplex tree coface function, Clang build issue fix. + * – ??-??-2015; release v.1.2.0, GudhUI (Gudhi Qt demo), Simplex tree coface function, Clang build issue fix. * * – 12-18-2014; release v.1.1, Skeleton-Blocker data-structure, simplification package, additional examples for topological persistence. * @@ -105,7 +106,7 @@ make * * Thank you to refer to this section, and to cite the author(s) of all the module you are using. * - * \section Soon Coming soon + * \section Upcoming Upcoming * * – Alpha complex. * @@ -117,5 +118,5 @@ make * * – Tangential complex. * - * – Hard clustering. + * – Clustering. */ -- cgit v1.2.3 From deeae2331c2b720a07c093ac797e825ed3d04ebe Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Sat, 24 Oct 2015 07:19:34 +0000 Subject: Add contributions section git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@873 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: d251621a0a143139b8ea787017bd195d26bd2e9f --- src/common/doc/main_page.h | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'src/common') diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 55cf53a6..1aea2716 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -91,7 +91,7 @@ make * * \section ReleaseHistory Release history * - * – ??-??-2015; release v.1.2.0, GudhUI (Gudhi Qt demo), Simplex tree coface function, Clang build issue fix. + * – 24-10-2015; release v.1.2.0, GudhUI (Gudhi Qt demo), Simplex tree coface function, Clang build issue fix. * * – 12-18-2014; release v.1.1, Skeleton-Blocker data-structure, simplification package, additional examples for topological persistence. * @@ -119,4 +119,16 @@ make * – Tangential complex. * * – Clustering. + * + * \section Contributions Contributions + * Gudhi is opened to external contributions. If you just want to report bugs, feel free to contact us. + * \verbatim Contact: gudhi-users@lists.gforge.inria.fr \endverbatim + * + * If you want to join our development team, you will have to create an accout on the + * INRIA forge and ask to join the GUDHI project. + * + * Your development will have to follow our + * submitting + * process (code, documentation, and unitary tests review) and not to break the existing + * test suite. */ -- cgit v1.2.3 From d60a8b6f8f09f377c425c02b6b9e602c188d51eb Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Sat, 24 Oct 2015 07:46:21 +0000 Subject: target="_blank" for external websites. git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@874 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 17b1803f2eaae3052d65a8d02a7bec3c9473e9cd --- src/common/doc/main_page.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'src/common') diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 1aea2716..ce6ef96a 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -27,7 +27,7 @@ Examples of Gudhi headers inclusion can be found in \ref demos. \section compiling Compiling -The library uses c++11 and requires Boost with version 1.48.0 or more recent. +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. @@ -35,7 +35,7 @@ It is a multi-platform library and compiles on Linux, Mac OSX and Visual Studio 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) +The following examples require the GNU Multiple Precision Arithmetic Library (GMP) and will not be built if GMP is not installed: - Persistent_cohomology/rips_multifield_persistence @@ -44,7 +44,7 @@ Having GMP version 4.2 or higher installed is recommended. \subsection cgal CGAL: CGAL is a C++ library which provides easy access to efficient and reliable geometric algorithms. -The following example requires the Computational Geometry Algorithms Library (CGAL) +The following example requires the Computational Geometry Algorithms Library (CGAL) and will not be built if CGAL is not installed: - GudhUI - Persistent_cohomology/alpha_shapes_persistence @@ -86,8 +86,8 @@ make * – Simplification methods via implicit representations. * * - * The library is available here and the documentation is - * available at this webpage. + * The library is available here and the documentation is + * available at this webpage. * * \section ReleaseHistory Release history * @@ -125,10 +125,10 @@ make * \verbatim Contact: gudhi-users@lists.gforge.inria.fr \endverbatim * * If you want to join our development team, you will have to create an accout on the - * INRIA forge and ask to join the GUDHI project. + * INRIA forge and ask to join the GUDHI project. * * Your development will have to follow our - * submitting + * submitting * process (code, documentation, and unitary tests review) and not to break the existing - * test suite. + * test suite. */ -- cgit v1.2.3 From 6b9fa936e42bd0c48f9320716937294dbcd7a21b Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Tue, 3 Nov 2015 10:50:47 +0000 Subject: Fix doxygen after doc review for 1.2.0 git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@881 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: cffd514dde3fd716bac3768c4af56d3ff5777931 --- biblio/how_to_cite_gudhi.bib | 44 +++++++++++++++++ src/Doxyfile | 5 +- src/common/doc/main_page.h | 109 ++++++++++++++++++++++++++----------------- 3 files changed, 112 insertions(+), 46 deletions(-) create mode 100644 biblio/how_to_cite_gudhi.bib (limited to 'src/common') diff --git a/biblio/how_to_cite_gudhi.bib b/biblio/how_to_cite_gudhi.bib new file mode 100644 index 00000000..851dd5d9 --- /dev/null +++ b/biblio/how_to_cite_gudhi.bib @@ -0,0 +1,44 @@ +@book{gudhi:urm +, title = "{GUDHI} User and Reference Manual" +, author = "{The GUDHI Project}" +, publisher = "{GUDHI Editorial Board}" +, year = 2015 +, url = "http://gudhi.gforge.inria.fr/doc/latest/" +} + +@incollection{gudhi:FilteredComplexes +, author = "Cl\'ement Maria" +, title = "Filtered Complexes" +, publisher = "{GUDHI Editorial Board}" +, booktitle = "{GUDHI} User and Reference Manual" +, url = "http://gudhi.gforge.inria.fr/doc/latest/group__simplex__tree.html" +, year = 2015 +} + +@incollection{gudhi:PersistentCohomology +, author = "Cl\'ement Maria" +, title = "Persistent Cohomology" +, publisher = "{GUDHI Editorial Board}" +, booktitle = "{GUDHI} User and Reference Manual" +, url = "http://gudhi.gforge.inria.fr/doc/latest/group__persistent__cohomology.html" +, year = 2015 +} + +@incollection{gudhi:Contraction +, author = "David Salinas" +, title = "Contraction" +, publisher = "{GUDHI Editorial Board}" +, booktitle = "{GUDHI} User and Reference Manual" +, url = "http://gudhi.gforge.inria.fr/doc/latest/group__contr.html" +, year = 2015 +} + +@incollection{gudhi:Skeleton-Blocker +, author = "David Salinas" +, title = "Skeleton-Blocker" +, publisher = "{GUDHI Editorial Board}" +, booktitle = "{GUDHI} User and Reference Manual" +, url = "http://gudhi.gforge.inria.fr/doc/latest/group__skbl.html" +, year = 2015 +} + diff --git a/src/Doxyfile b/src/Doxyfile index 084a9abb..faa0d3fe 100644 --- a/src/Doxyfile +++ b/src/Doxyfile @@ -672,7 +672,8 @@ LAYOUT_FILE = # search path. Do not use file names with spaces, bibtex cannot handle them. See # also \cite for info how to create references. -CITE_BIB_FILES = biblio/bibliography.bib +CITE_BIB_FILES = biblio/bibliography.bib \ + biblio/how_to_cite_gudhi.bib #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages @@ -811,7 +812,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = +EXAMPLE_PATH = biblio/ # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index ce6ef96a..43297b45 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -65,6 +65,14 @@ cmake .. make \endverbatim +\subsection testsuites Test suites + +To test your build, run the following command in a terminal: + +\verbatim +make test +\endverbatim + \details \copyright GNU General Public License v3. @@ -75,60 +83,73 @@ make /*! \page Software Software * \tableofcontents * \section SoftwareIntroduction Introduction - * The GUDHI open source library will provide the central data structures and algorithms that underly applications in geometry understanding in higher dimensions. It is intended to both help the development of new algorithmic solutions inside and outside the project, and to facilitate the transfer of results in applied fields. - * - * The current release of the GUDHI library includes: + * The GUDHI library is a C++ open source library **intended to provide** the central data structures and algorithms + * that underly applications in Geometric and Topological Data Analysis + * (TDA). The GUDHI + * library is developed as part of the GUDHI + * project supported by the European Research Council. The GUDHI library can both help the development of new + * algorithmic solutions and to facilitate the transfer of state of the art results and new applications of TDA. * - * – Data structures to represent, construct and manipulate simplicial complexes. - * - * – Algorithms to compute persistent homology and multi-field persistent homology. + * The current release of the GUDHI library includes: * - * – Simplification methods via implicit representations. + * \li Data structures to represent, construct and manipulate simplicial complexes. + * \li Algorithms to compute persistent homology and multi-field persistent homology. + * \li Simplification methods via implicit representations. * * - * The library is available here and the documentation is - * available at this webpage. + * The library is available here + * and the documentation is available at this + * webpage. * - * \section ReleaseHistory Release history - * - * – 24-10-2015; release v.1.2.0, GudhUI (Gudhi Qt demo), Simplex tree coface function, Clang build issue fix. - * - * – 12-18-2014; release v.1.1, Skeleton-Blocker data-structure, simplification package, additional examples for topological persistence. - * - * – 08-12-2014; release v. 1.0.2, initialize simplex keys in initialize_filtration in Simplex_tree - * - * – 07-11-2014: release v. 1.0.1, bug fix in summing columns in Persistent_cohomology - * - * – 06-23-2014: release v. 1.0 + * The library comes with data sets, \ref demos and \ref testsuites. * - * \section Citation How to cite Gudhi - * Each Gudhi module (either data structures or algorithms) has an author section. + * \subsection People People * - * Thank you to refer to this section, and to cite the author(s) of all the module you are using. + * The development of the GUDHI library is steered by an Editorial Board, which is responsible for guiding the + * development of the library, developers, and the user community. * - * \section Upcoming Upcoming - * - * – Alpha complex. - * - * – Bottleneck distance. - * - * – Zig zag persistence. - * - * – Witness complex. - * - * – Tangential complex. - * - * – Clustering. + * The Editorial board is composed of: + * + * \li + * Jean-Daniel Boissonnat | INRIA Sophia Antipolis - Méditerranée + * \li Marc Glisse | INRIA Saclay - Ile de France + * \li Clément Jamin | INRIA Sophia Antipolis - Méditerranée + * \li Vincent Rouvreau | INRIA Saclay - Ile de France * - * \section Contributions Contributions - * Gudhi is opened to external contributions. If you just want to report bugs, feel free to contact us. + * \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 * - * If you want to join our development team, you will have to create an accout on the - * INRIA forge and ask to join the GUDHI project. + * Gudhi is **open** to external contributions. If you want to join our development team, please contact us. + * + * + * \section ReleaseHistory Release history + * + * \li 24-10-2015; release v.1.2.0, GudhUI (Gudhi Qt demo), Simplex tree coface function, Clang build issue fix. + * \li 18-12-2014; release v.1.1, Skeleton-Blocker data-structure, simplification package, additional examples for topological persistence. + * \li 08-12-2014; release v. 1.0.2, initialize simplex keys in initialize_filtration in Simplex_tree + * \li 07-11-2014: release v. 1.0.1, bug fix in summing columns in Persistent_cohomology + * \li 23-06-2014: release v. 1.0 + * + * \section Upcoming Upcoming + * + * The library is under active development. New packages to be released next include: + * \li Alpha complex. + * \li Bottleneck distance. + * \li Zig zag persistence. + * \li Witness complex. + * \li Tangential complex. + * \li Clustering. +*/ + +/*! \page Citation Acknowledging the GUDHI library + * We kindly ask users to cite the GUDHI library as appropriately as possible in their papers, and to mention the use + * of the GUDHI library on the web pages of their projects using GUDHI and provide us with links to these web pages. + * Feel free to contact us in case you have any question or remark on this topic. * - * Your development will have to follow our - * submitting - * process (code, documentation, and unitary tests review) and not to break the existing - * test suite. + * We provide \ref GudhiBibtex entries for the modules of the User and Reference Manual, as well as for publications + * directly related to the GUDHI library. + * \section GudhiBibtex GUDHI bibtex + * \verbinclude biblio/how_to_cite_gudhi.bib */ + -- cgit v1.2.3 From 393daefc5078498b472a28ed0763c34b8351ba87 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Tue, 3 Nov 2015 15:39:42 +0000 Subject: Doxygen fix after doc review git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@882 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: e702746a6f8bdc7bb06bee2710ebe60dff504c69 --- src/Contraction/include/gudhi/Edge_contraction.h | 2 +- src/common/doc/main_page.h | 175 +++++++++-------------- 2 files changed, 71 insertions(+), 106 deletions(-) (limited to 'src/common') diff --git a/src/Contraction/include/gudhi/Edge_contraction.h b/src/Contraction/include/gudhi/Edge_contraction.h index f3076057..349bb7d8 100644 --- a/src/Contraction/include/gudhi/Edge_contraction.h +++ b/src/Contraction/include/gudhi/Edge_contraction.h @@ -37,7 +37,7 @@ namespace Gudhi { namespace contraction { -/** \defgroup contr Contraction +/** \defgroup contr Edge contraction \author David Salinas diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 43297b45..730b74df 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -1,101 +1,24 @@ -/** -\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. -This library is part of the Gudhi project. - -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 installation 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 \ref demos. - - -\section compiling 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. - - -\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) -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. - -\subsection cgal CGAL: -CGAL is a C++ library which provides easy access to efficient and reliable geometric algorithms. - -The following example requires 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 - -\subsection demos Demos and examples - -To build the demos and libraries, run the following commands in a terminal: - -\verbatim -cd /path-to-gudhi/ -mkdir build -cd build/ -cmake .. -make -\endverbatim - -\subsection testsuites Test suites - -To test your build, run the following command in a terminal: - -\verbatim -make test -\endverbatim - -\details - -\copyright GNU General Public License v3. -\verbatim Contact: gudhi-users@lists.gforge.inria.fr \endverbatim - -*/ - -/*! \page Software Software - * \tableofcontents - * \section SoftwareIntroduction Introduction - * The GUDHI library is a C++ open source library **intended to provide** the central data structures and algorithms - * that underly applications in Geometric and Topological Data Analysis - * (TDA). The GUDHI - * library is developed as part of the GUDHI - * project supported by the European Research Council. The GUDHI library can both help the development of new - * algorithmic solutions and to facilitate the transfer of state of the art results and new applications of TDA. +/*! \mainpage + * \image html "Gudhi_banner.jpg" "" width=20cm + * + * \section Introduction Introduction + * The Gudhi library (Geometric Understanding in Higher Dimensions) is a generic open source C++ library for + * Computational Topology and Topological Data Analysis + * (TDA). + * The GUDHI library is developed as part of the + * GUDHI project supported by the European + * Research Council. The GUDHI library intends to help the development of new algorithmic solutions in TDA and their + * transfer to applications. It provides robust, efficient, flexible and easy to use implementations of + * state-of-the-art algorithms and data structures. * * The current release of the GUDHI library includes: * * \li Data structures to represent, construct and manipulate simplicial complexes. * \li Algorithms to compute persistent homology and multi-field persistent homology. - * \li Simplification methods via implicit representations. + * \li Simplication of simplicial complexes by edge contraction. * + * All data-structures are generic and several of their aspects can be parameterized via template classes. + * We refer to \cite gudhilibrary_ICMS14 for a detailed description of the design of the library. * * The library is available here * and the documentation is available at this @@ -103,9 +26,11 @@ make test * * The library comes with data sets, \ref demos and \ref testsuites. * - * \subsection People People + * Gudhi is also accessible though the + * R package TDA + * (Statistical Tools for Topological Data Analysis). * - * The development of the GUDHI library is steered by an Editorial Board, which is responsible for guiding the + * The development of the GUDHI library is steered by an Editorial Board, who is responsible for guiding the * development of the library, developers, and the user community. * * The Editorial board is composed of: @@ -116,22 +41,62 @@ make test * \li Clément Jamin | INRIA Sophia Antipolis - Méditerranée * \li Vincent Rouvreau | INRIA Saclay - Ile de France * +*/ + +/*! \page installation 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 \ref demos. + * + * \section compiling 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. + * + * \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 example requires the GNU Multiple Precision Arithmetic + * Library (GMP) and will not be built if GMP is not installed: + * \li Persistent_cohomology/rips_multifield_persistence + * Having GMP version 4.2 or higher installed is recommended. + * + * \subsection cgal 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: + * \li GudhUI + * \li Persistent_cohomology/alpha_shapes_persistence + * \li 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 + * + * \subsection demos Demos and examples + * To build the demos and libraries, run the following commands in a terminal: + * \verbatim + * cd /path-to-gudhi/ + * mkdir build + * cd build/ + * cmake .. + * make + * \endverbatim + * + * \subsection testsuites Test suites + * To test your build, run the following command in a terminal: + * \verbatim + * make test + * \endverbatim + * * \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 * - * 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 contact us. * - * - * \section ReleaseHistory Release history - * - * \li 24-10-2015; release v.1.2.0, GudhUI (Gudhi Qt demo), Simplex tree coface function, Clang build issue fix. - * \li 18-12-2014; release v.1.1, Skeleton-Blocker data-structure, simplification package, additional examples for topological persistence. - * \li 08-12-2014; release v. 1.0.2, initialize simplex keys in initialize_filtration in Simplex_tree - * \li 07-11-2014: release v. 1.0.1, bug fix in summing columns in Persistent_cohomology - * \li 23-06-2014: release v. 1.0 - * - * \section Upcoming Upcoming +*/ + +/*! \page Upcoming Upcoming * * The library is under active development. New packages to be released next include: * \li Alpha complex. -- cgit v1.2.3 From f958607003d8c36902cc7eb856b9e75d6752077a Mon Sep 17 00:00:00 2001 From: glisse Date: Tue, 3 Nov 2015 16:03:09 +0000 Subject: Lien vers ma page web. git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@883 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 28883bac2ff28977b30615bedd4f7d33b41d07c3 --- src/common/doc/main_page.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/common') diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 730b74df..8b07bb18 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -37,7 +37,7 @@ * * \li * Jean-Daniel Boissonnat | INRIA Sophia Antipolis - Méditerranée - * \li Marc Glisse | INRIA Saclay - Ile de France + * \li Marc Glisse | INRIA Saclay - Ile de France * \li Clément Jamin | INRIA Sophia Antipolis - Méditerranée * \li Vincent Rouvreau | INRIA Saclay - Ile de France * -- cgit v1.2.3 From a8d0580ab66f309056dcfbfb33f581cd2cbaba5e Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Wed, 4 Nov 2015 06:50:52 +0000 Subject: Missing a space for not to be on the same line git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@884 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 28ce24bf496e1df4360845dffe1c8ec70c1da72a --- src/common/doc/main_page.h | 1 + 1 file changed, 1 insertion(+) (limited to 'src/common') diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 8b07bb18..ee8e1008 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -69,6 +69,7 @@ * \li GudhUI * \li Persistent_cohomology/alpha_shapes_persistence * \li 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 * -- cgit v1.2.3 From 72f647ad4b802d08072925a374324e7ace4b2c4d Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Wed, 4 Nov 2015 08:21:19 +0000 Subject: doc review git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@886 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: a1729600550c0065173364d50775ce15d40dd026 --- src/common/doc/main_page.h | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) (limited to 'src/common') diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index ee8e1008..689e7a4d 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -30,10 +30,7 @@ * R package TDA * (Statistical Tools for Topological Data Analysis). * - * The development of the GUDHI library is steered by an Editorial Board, who is responsible for guiding the - * development of the library, developers, and the user community. - * - * The Editorial board is composed of: + * The development of the GUDHI library is steered by an Editorial Board composed of: * * \li * Jean-Daniel Boissonnat | INRIA Sophia Antipolis - Méditerranée -- cgit v1.2.3