From c2d46e0e6cfea1927875219bd5e03962cef7b010 Mon Sep 17 00:00:00 2001
From: vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>
Date: Mon, 29 Jan 2018 16:31:18 +0000
Subject: Fix doc issue for utilities part on the web site

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@3176 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: 3bafd9e13a5646ca93023144705d3ac7ed7c9b3a
---
 src/Rips_complex/utilities/README | 67 ++++++++++++++++-----------------------
 1 file changed, 27 insertions(+), 40 deletions(-)

(limited to 'src/Rips_complex')

diff --git a/src/Rips_complex/utilities/README b/src/Rips_complex/utilities/README
index 4d20c806..44a37543 100644
--- a/src/Rips_complex/utilities/README
+++ b/src/Rips_complex/utilities/README
@@ -1,6 +1,20 @@
-# Rips_complex #
-
-## `rips_persistence` ##
+---
+layout: page
+title: "Rips complex"
+meta_title: "ripscomplex"
+subheadline: ""
+teaser: ""
+permalink: "/ripscomplex/"
+---
+{::comment}
+These flags above are here for web site generation, please let them.
+cf. https://gitlab.inria.fr/GUDHI/website
+Must be in conformity with _data/navigation.yml
+{:/comment}
+
+
+
+## rips_persistence ##
 This program computes the persistent homology with coefficient field *Z/pZ* of a Rips complex defined on a set of input points. The output diagram contains one bar per line, written with the convention:
 
 `p dim birth death`
@@ -8,6 +22,7 @@ This program computes the persistent homology with coefficient field *Z/pZ* of a
 where `dim` is the dimension of the homological feature, `birth` and `death` are respectively the birth and death of the feature, and `p` is the characteristic of the field *Z/pZ* used for homology coefficients (`p` must be a prime number).
 
 **Usage**
+
 `rips_persistence [options] <OFF input file>`
 
 **Allowed options**
@@ -22,53 +37,25 @@ where `dim` is the dimension of the homological feature, `birth` and `death` are
 Beware: this program may use a lot of RAM and take a lot of time if `max-edge-length` is set to a large value.
 
 **Example 1 with Z/2Z coefficients**
-`rips_persistence ../../data/points/tore3D_1307.off -r 0.25 -m 0.5 -d 3 -p 2`
 
-outputs:
-```
-2  0 0 inf
-2  1 0.0983494 inf 
-2  1 0.104347 inf 
-2  2 0.138335 inf 
-```
+`rips_persistence ../../data/points/tore3D_1307.off -r 0.25 -m 0.5 -d 3 -p 2`
 
 **Example 2 with Z/3Z coefficients**
 
-rips_persistence ../../data/points/tore3D_1307.off -r 0.25 -m 0.5 -d 3 -p 3
-
-outputs:
-```
-3  0 0 inf
-3  1 0.0983494 inf
-3  1 0.104347 inf
-3  2 0.138335 inf
-```
+`rips_persistence ../../data/points/tore3D_1307.off -r 0.25 -m 0.5 -d 3 -p 3`
 
 
+## rips_distance_matrix_persistence ##
 
+Same as `rips_persistence` but taking a distance matrix as input.
 
-## `rips_distance_matrix_persistence` ##
-Same as `rips_persistence` but taking a distance matrix as input. 
-
 **Usage**
-`rips_persistence [options] <CSV input file>`
-where
+
+`rips_persistence [options] <CSV input file>`
+
+where
 `<CSV input file>` is the path to the file containing a distance matrix. Can be square or lower triangular matrix. Separator is ';'.
 
 **Example**
-`rips_distance_matrix_persistence data/distance_matrix/full_square_distance_matrix.csv -r 15 -d 3 -p 3 -m 0`
 
-outputs:
-```
-The complex contains 46 simplices 
-   and has dimension 3 
-3  0 0 inf 
-3  0 0 8.94427 
-3  0 0 7.28011 
-3  0 0 6.08276 
-3  0 0 5.83095 
-3  0 0 5.38516 
-3  0 0 5 
-3  1 11 12.0416 
-3  1 6.32456 6.7082 
-```
+`rips_distance_matrix_persistence data/distance_matrix/full_square_distance_matrix.csv -r 15 -d 3 -p 3 -m 0`
-- 
cgit v1.2.3