From 5463262c6a5bca5748b940670eedc8f226ce4503 Mon Sep 17 00:00:00 2001 From: Gard Spreemann Date: Mon, 19 Sep 2022 17:16:54 +0200 Subject: Replace raw man pages with more maintainable ones generated by scdoc --- debian/control | 3 ++- debian/ripser-coeff.1 | 42 ------------------------------------------ debian/ripser-coeff.1.scd | 38 ++++++++++++++++++++++++++++++++++++++ debian/ripser.1 | 37 ------------------------------------- debian/ripser.1.scd | 35 +++++++++++++++++++++++++++++++++++ debian/ripser.manpages | 4 ++-- debian/rules | 2 ++ 7 files changed, 79 insertions(+), 82 deletions(-) delete mode 100644 debian/ripser-coeff.1 create mode 100644 debian/ripser-coeff.1.scd delete mode 100644 debian/ripser.1 create mode 100644 debian/ripser.1.scd diff --git a/debian/control b/debian/control index 47ad092..5b96f3c 100644 --- a/debian/control +++ b/debian/control @@ -3,7 +3,8 @@ Section: math Priority: optional Maintainer: Gard Spreemann Build-Depends: - debhelper-compat (= 13) + debhelper-compat (= 13), + scdoc Standards-Version: 4.6.1 Rules-Requires-Root: no Homepage: http://ripser.org diff --git a/debian/ripser-coeff.1 b/debian/ripser-coeff.1 deleted file mode 100644 index 3d94831..0000000 --- a/debian/ripser-coeff.1 +++ /dev/null @@ -1,42 +0,0 @@ -.TH RIPSER-COEFF 1 -.SH NAME -ripser-coeff \- fast computation of persistent homology of flag complexes -.SH SYNOPSIS -.B ripser-coeff -[\fB\-\-help\fR] -[\fB\-\-format\fR \fIformat\fR] -[\fB\-\-dim \fIk\fR] -[\fB\-\-threshold \fIt\fR] -[\fB\-\-ratio \fIr\fR] -[\fB\-\-modulus \fIp\fR] -[\fIfilename\fR] -.SH DESCRIPTION -.B ripser-coeff -computes persistent homology of flag complexes (such as Vietoris-Rips -complexes) only, allowing significant gains in computation time and -memory usage over the general situation. Unlike \fBripser\fR, it -computes over an arbitrary finite field. - -See https://arxiv.org/abs/1908.02518 for details. -.SH OPTIONS -.TP -\fB\-\-help\fR -Display help. -.TP -\fB\-\-format\fR \fIformat\fR -Specify input format. See \fB\-\-help\fR for a full list. -.TP -\fB\-\-dim \fIk\fR -Compute persistent homology up to dimension \fIk\fR. -.TP -\fB\-\-threshold \fIt\fR -Compute Rips complexes up to diameter \fIt\fR. -.TP -\fB\-\-ratio \fIr\fR -Only show persistence pairs with death/birth ratio > \fIr\fR. -.TP -\fB\-\-modulus \fIp\fR -Compute homology with coefficients in the prime field Z/\fIp\fRZ. -.TP -\fIfilename\fR -Read input from this file. Uses stdin if not present. diff --git a/debian/ripser-coeff.1.scd b/debian/ripser-coeff.1.scd new file mode 100644 index 0000000..5a8a393 --- /dev/null +++ b/debian/ripser-coeff.1.scd @@ -0,0 +1,38 @@ +ripser-coeff(1) + +# NAME + +ripser-coeff - fast computation of persistent homology of flag +complexes, with coefficients in chosen field + +# SYNOPSIS + +*ripser-coeff* [options...] [filename] + +# OPTIONS + +*--help* + Show help message and quit. + +*--format* + Use the specified file format for the input. Options are: + - lower-distance (lower triangular distance matrix; default) + - upper-distance (upper triangular distance matrix) + - distance (full distance matrix) + - point-cloud (point cloud in Euclidean space) + - dipha (distance matrix in DIPHA file format) + - sparse (sparse distance matrix in sparse triplet format) + - binary (lower triangular distance matrix in binary format) + +*--dim* + Compute persistent homology up to dimension k +*--threshold * + Compute Rips complexes up to diameter t +*--modulus

* + Compute homology with coefficients in the prime field Z/pZ +*--ratio * + Only show persistence pairs with death/birth ratio > r + +# SEE ALSO + +*ripser*(1) \ No newline at end of file diff --git a/debian/ripser.1 b/debian/ripser.1 deleted file mode 100644 index 9caafee..0000000 --- a/debian/ripser.1 +++ /dev/null @@ -1,37 +0,0 @@ -.TH RIPSER 1 -.SH NAME -ripser \- fast computation of persistent homology of flag complexes -.SH SYNOPSIS -.B ripser -[\fB\-\-help\fR] -[\fB\-\-format\fR \fIformat\fR] -[\fB\-\-dim \fIk\fR] -[\fB\-\-threshold \fIt\fR] -[\fB\-\-ratio \fIr\fR] -[\fIfilename\fR] -.SH DESCRIPTION -.B ripser -computes persistent homology of flag complexes (such as Vietoris-Rips -complexes) only, allowing significant gains in computation time and -memory usage over the general situation. - -See https://arxiv.org/abs/1908.02518 for details. -.SH OPTIONS -.TP -\fB\-\-help\fR -Display help. -.TP -\fB\-\-format\fR \fIformat\fR -Specify input format. See \fB\-\-help\fR for a full list. -.TP -\fB\-\-dim \fIk\fR -Compute persistent homology up to dimension \fIk\fR. -.TP -\fB\-\-threshold \fIt\fR -Compute Rips complexes up to diameter \fIt\fR. -.TP -\fB\-\-ratio \fIr\fR -Only show persistence pairs with death/birth ratio > \fIr\fR. -.TP -\fIfilename\fR -Read input from this file. Uses stdin if not present. diff --git a/debian/ripser.1.scd b/debian/ripser.1.scd new file mode 100644 index 0000000..fcb68cb --- /dev/null +++ b/debian/ripser.1.scd @@ -0,0 +1,35 @@ +ripser(1) + +# NAME + +ripser - fast computation of persistent homology of flag complexes + +# SYNOPSIS + +*ripser* [options...] [filename] + +# OPTIONS + +*--help* + Show help message and quit. + +*--format* + Use the specified file format for the input. Options are: + - lower-distance (lower triangular distance matrix; default) + - upper-distance (upper triangular distance matrix) + - distance (full distance matrix) + - point-cloud (point cloud in Euclidean space) + - dipha (distance matrix in DIPHA file format) + - sparse (sparse distance matrix in sparse triplet format) + - binary (lower triangular distance matrix in binary format) + +*--dim* + Compute persistent homology up to dimension k +*--threshold * + Compute Rips complexes up to diameter t +*--ratio * + Only show persistence pairs with death/birth ratio > r + +# SEE ALSO + +*ripser-coeff*(1) \ No newline at end of file diff --git a/debian/ripser.manpages b/debian/ripser.manpages index 6c82f0f..6da34b8 100644 --- a/debian/ripser.manpages +++ b/debian/ripser.manpages @@ -1,2 +1,2 @@ -debian/ripser.1 -debian/ripser-coeff.1 +build/ripser.1 +build/ripser-coeff.1 diff --git a/debian/rules b/debian/rules index 0150120..4d545d1 100755 --- a/debian/rules +++ b/debian/rules @@ -13,6 +13,8 @@ override_dh_auto_configure: override_dh_auto_build: $(CXX) $(CPPFLAGS) $(CXXFLAGS) $(LDFLAGS) -o build/ripser ripser.cpp $(CXX) $(CPPFLAGS) $(CXXFLAGS) $(LDFLAGS) -DUSE_COEFFICIENTS -o build/ripser-coeff ripser.cpp + scdoc < debian/ripser.1.scd > build/ripser.1 + scdoc < debian/ripser-coeff.1.scd > build/ripser-coeff.1 override_dh_auto_clean: rm -rf build -- cgit v1.2.3