diff options
author | Ulrich Bauer <ulrich.bauer@tum.de> | 2016-07-17 16:52:51 +0200 |
---|---|---|
committer | Ulrich Bauer <ulrich.bauer@tum.de> | 2016-07-17 16:55:23 +0200 |
commit | 9b10968b4d31345246ca8583454de82bd462ef59 (patch) | |
tree | d67aba3b4f3ea34c6751e1405cf1438164ea18d5 /README.md | |
parent | 6765b225ea83ab7fbba32cddff6e92012fbd833d (diff) |
updated readme
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 28 |
1 files changed, 18 insertions, 10 deletions
@@ -1,6 +1,7 @@ # Ripser
Copyright © 2015–2016 [Ulrich Bauer].
+ ### Description
@@ -32,21 +33,23 @@ Ripser's efficiency is based on a few important concepts and principles: ### Version
[Latest release][latest-release]: 1.0 (July 2016)
+ ### Building
-Ripser requires a C++11 compiler.
+Ripser requires a C++11 compiler. Here is how to obtain, build, and run Ripser:
```sh
-$ git clone https://github.com/Ripser/ripser.git
-$ cd ripser
-$ make
-$ ./ripser examples/sphere_3_192.lower_distance_matrix
+git clone https://github.com/Ripser/ripser.git
+cd ripser
+make
+./ripser examples/sphere_3_192.lower_distance_matrix
```
+ ### Options
-Ripser supports several compile-time options. They are switched on by defining the C preprocessor macros listed below, either using `#define` in the code or by passing an argument to the compiler. The follwoing options are supported:
+Ripser supports several compile-time options. They are switched on by defining the C preprocessor macros listed below, either using `#define` in the code or by passing an argument to the compiler. The following options are supported:
- `ASSEMBLE_REDUCTION_MATRIX`: store the reduction matrix; may speed up computation but will also increase memory usage
- `USE_COEFFICIENTS`: enable support for coeffitients in a prime field
@@ -54,7 +57,6 @@ Ripser supports several compile-time options. They are switched on by defining t - `PRINT_PERSISTENCE_PAIRS`: output the computed persistence pairs (enabled by default)
- `USE_GOOGLE_HASHMAP`: enable support for Google's [sparsehash] data structure; may further reducue memory footprint
-
Furthermore, one of the following options needs to be chosen to specify the format for the input files:
- `FILE_FORMAT_LOWER_TRIANGULAR_CSV`: lower triangular distance matrix; a comma separated list of the distance matrix entries below the diagonal, sorted lexicographically by row index and column index
@@ -65,8 +67,14 @@ For example, to build with support for coefficients: ```sh
$ c++ -std=c++11 ripser.cpp -o ripser -Ofast -D NDEBUG -D FILE_FORMAT_LOWER_TRIANGULAR_CSV -D USE_COEFFICIENTS
-```
-
+``` + +The following options are supported at the command line: + + - `--top_dim k`: compute persistent homology up to dimension *k* + - `--threshold t`: compute Rips complexes up to diameter *t* + - `--modulus p`: compute homology with coefficients in the prime field Z/*p*Z (only available when build with the option `USE_COEFFICIENTS`) + ### Planned features
@@ -75,10 +83,10 @@ The following features are currently planned for future versions: - support for point clouds
- computation of representative cycles for persistent homology (currenly only *co*cycles are computed)
- support for sparse distance matrices
+ ### License
-
[LGPL] 3.0
|