diff options
| author | Marc Glisse <marc.glisse@inria.fr> | 2020-01-20 18:20:45 +0100 |
|---|---|---|
| committer | Marc Glisse <marc.glisse@inria.fr> | 2020-01-20 18:20:45 +0100 |
| commit | a02397ba04d707dc79736ce2f598ebb74459bf90 (patch) | |
| tree | c9fb7d097fc91b72b12da472f3926c0cba3c78c5 /README.md | |
| parent | 1783c047302414bbcd6ff4f7c73dcc5a6501fd81 (diff) | |
Mention submodules in README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 9 |
1 files changed, 9 insertions, 0 deletions
@@ -10,6 +10,15 @@ The GUDHI library is a generic open source C++ library, with a Python interface, for Topological Data Analysis (TDA) and Higher Dimensional Geometry Understanding. The library offers state-of-the-art data structures and algorithms to construct simplicial complexes and compute persistent homology. +# Source code + +We recommend that users get official releases from [the GUDHI website](https://gudhi.inria.fr/). + +For potential contributors, to fully checkout GUDHI, after cloning the git repository, you may also need to checkout its submodules using +```sh +git submodule update --init +``` + # Compilation and installation To install GUDHI, you can follow the [C++ compilation procedure](https://gudhi.inria.fr/doc/latest/installation.html), the [Python compilation procedure](https://gudhi.inria.fr/python/latest/installation.html), use our [conda-forge package](https://gudhi.inria.fr/conda/), or [go with Docker](https://gudhi.inria.fr/dockerfile/). |