Créer des profils du manteau neigeux - retour accueil
git clone git://bebou.netlib.re/gelinive
Log | Files | Refs | README |
commit cca7c2acdd91b697536b054e946ba39df11c1db8 parent d19466614de4033db06645e0c83636db99758e88 Auterice: Arthur Pons <arthur.pons@unistra.fr> Date: Mon, 11 Mar 2024 19:21:11 +0100 Retrait sources md page de man, ajout page de man C'est bête d'avoir lowdown comme dépendance d'un projet comme celui-ci Diffstat:
| M | .gitignore | | | 2 | +- |
| M | README.md | | | 5 | ++--- |
| A | gelinive.1 | | | 61 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| D | gelinive.1.md | | | 52 | ---------------------------------------------------- |
| A | gelinive.5 | | | 63 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| D | gelinive.5.md | | | 39 | --------------------------------------- |
| M | makefile | | | 7 | +------ |
7 files changed, 128 insertions(+), 101 deletions(-)
diff --git a/.gitignore b/.gitignore @@ -10,5 +10,5 @@ !tests/intermediairedata !tests/tests !README.md -!gelinive.?.md +!gelinive.? !geliniveplot diff --git a/README.md b/README.md @@ -21,9 +21,8 @@ Les dépendances notables sont : * dash * ImageMagick (convert et compare pour les tests) -Pour installer le logiciel faire +Pour tester le logiciel faire - make make test Si les tests passent alors on peut installer : @@ -58,7 +57,7 @@ de la commande et le manuel du format : * mail : le mail initiant la demande * makefile : le makefile pour générer le manuel, lancer les tests et installer le script/le man - * gelinive.?.md : les sources du manuel + * gelinive.? : les pages du manuel * tests/test : le script lançant les tests * tests/data : le jeu de donnée de tests * tests/intermediairedata : le jeu de donnée contre lequel vérifier le bon calcul de R et e diff --git a/gelinive.1 b/gelinive.1 @@ -0,0 +1,61 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.TH "GELINIVE" "1" "" +.SS +NOM +.LP +gelinive - calcul la résistance au battage +.SS +SYNOPSIS +.LP +[< \fIENTREE\fR] \fBgelinive\fR [\fIINTERMEDIAIRE\fR] +.SS +DESCRIPTION +.LP +Calcul la résistance au battaque et l\(cqenfoncement total d\(cqune sonde dans la +neige. En fait un graphique png à l\(cqaide de geliniveplot. +Pour le format en entrée et celui du fichier intermédiaire voir gelinive(5). +.SS +UTILISATION ET EXAMPLES +.LP +On peut rentrer les données au format gelinive(5) au clavier : +.LP +.EX +gelinive +.EE +.PP +Ou lire données depuis un fichier : +.LP +.EX +< data gelinive +.EE +.PP +On peut rediriger la sortie vers un fichier : +.LP +.EX +< data gelinive > image.png +.EE +.PP +Ou les piper directement dans un visionneur d\(cqimage : +.LP +.EX +< data gelinive | feh -. - +.EE +.PP +Si l\(cqon renseigne un chemin à la place de INTERMEDIAIRE alors un +fichier sera créé à ce chemin avec les données calculées de résistance au +battage et d\(cqenfoncement total de la sonde. +.LP +.EX +< data gelinive data_with_Re > image.png +.EE +.PP +Si l\(cqon ne renseigne pas INTERMEDIAIRE aucun fichier intermédiaire +ne sera créé. +.SS +VOIR AUSSI +.LP +gelinive(5) +.SS +AUTEURICE +.LP +Arthur Pons \fIarthur.pons@unistra.fr\fR diff --git a/gelinive.1.md b/gelinive.1.md @@ -1,52 +0,0 @@ -title: GELINIVE -section: 1 - -## NOM - -gelinive - calcul la résistance au battage - -## SYNOPSIS - -[< _ENTREE_] **gelinive** [_INTERMEDIAIRE_] - -## DESCRIPTION - -Calcul la résistance au battaque et l'enfoncement total d'une sonde dans la -neige. En fait un graphique png à l'aide de geliniveplot. -Pour le format en entrée et celui du fichier intermédiaire voir gelinive(5). - -## UTILISATION ET EXAMPLES - -On peut rentrer les données au format gelinive(5) au clavier : - - gelinive - -Ou lire données depuis un fichier : - - < data gelinive - -On peut rediriger la sortie vers un fichier : - - < data gelinive > image.png - -Ou les piper directement dans un visionneur d'image : - - < data gelinive | feh -. - - -Si l'on renseigne un chemin à la place de INTERMEDIAIRE alors un -fichier sera créé à ce chemin avec les données calculées de résistance au -battage et d'enfoncement total de la sonde. - - < data gelinive data_with_Re > image.png - -Si l'on ne renseigne pas INTERMEDIAIRE aucun fichier intermédiaire -ne sera créé. - -## VOIR AUSSI - -gelinive(5) - -## AUTEURICE - -Arthur Pons <arthur.pons@unistra.fr> - diff --git a/gelinive.5 b/gelinive.5 @@ -0,0 +1,63 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.TH "GELINIVE" "5" "" +.SS +NAME +.LP +gelinive - format des sondages par battage +.SS +SYNOPSIS +.LP +gelinive +.SS +DESCRIPTION +.LP +gelinive(1) prend en entrée des données concernant le manteau neigeux sous un certain format. +.SS +CHAMPS SÉPARÉS PAR DES TABULATIONs +.LP +L\(cqordre et le contenu des champs sont : +.IP "1. " +q le nombre de tubes +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "2. " +P le poids mobile (1 kg) +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "3. " +n le nombre de coups +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "4. " +h la hauteur de chute (cm) +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "5. " +d l\(cqenfoncement pour n coups (cm) +.LP +Si gelinive(1) est appelé avec un chemin en argument il créera un +fichier en calculant et ajoutant aux cinq précédents les deux éléments suivants : +.IP "6. " +R la résistance au battage +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "7. " +e l\(cqenfoncement total de la sonde (cm) +.SS +VOIR AUSSI +.LP +gelinive(1) +.SS +AUTEURICE +.LP +Arthur Pons \fIarthur.pons@unistra.fr\fR diff --git a/gelinive.5.md b/gelinive.5.md @@ -1,39 +0,0 @@ -title: GELINIVE -section: 5 - -## NAME - -gelinive - format des sondages par battage - -## SYNOPSIS - -gelinive - -## DESCRIPTION - -gelinive(1) prend en entrée des données concernant le manteau neigeux sous un certain format. - -## CHAMPS SÉPARÉS PAR DES TABULATIONs - -L'ordre et le contenu des champs sont : - - 1. q le nombre de tubes - 2. P le poids mobile (1 kg) - 3. n le nombre de coups - 4. h la hauteur de chute (cm) - 5. d l'enfoncement pour n coups (cm) - -Si gelinive(1) est appelé avec un chemin en argument il créera un -fichier en calculant et ajoutant aux cinq précédents les deux éléments suivants : - - 6. R la résistance au battage - 7. e l'enfoncement total de la sonde (cm) - -## VOIR AUSSI - -gelinive(1) - -## AUTEURICE - -Arthur Pons <arthur.pons@unistra.fr> - diff --git a/makefile b/makefile @@ -1,6 +1,6 @@ PREFIX = /usr/local -all: gelinive.1 gelinive.5 +all: test:;tests/test @@ -13,8 +13,3 @@ install: cp gelinive.1 ${PREFIX}/man/man1 cp gelinive.5 ${PREFIX}/man/man5 -gelinive.1: gelinive.1.md - lowdown -stman $< > $@ - -gelinive.5: gelinive.5.md - lowdown -stman $< > $@