Créer des profils du manteau neigeux - retour accueil
git clone git://bebou.netlib.re/gelinive
Log | Files | Refs | README |
commit 16ee79ad990f0be0041338984d6fa8cc1c42dbd3 parent 06b55138f0b84c24a4d75794df4977fdf7adaf8a Auterice: Arthur Pons <arthur.pons@unistra.fr> Date: Tue, 19 Mar 2024 13:25:24 +0100 Documentation Modification du -h, du man et le readme pour documenter le nouveau format des arguments. Diffstat:
| M | README.md | | | 4 | ++-- |
| M | gelinive.1 | | | 34 | ++++++++++++++++++++++------------ |
| M | gelinivetest | | | 24 | +++++++++--------------- |
3 files changed, 33 insertions(+), 29 deletions(-)
diff --git a/README.md b/README.md @@ -32,7 +32,7 @@ probable que les images que votre système génèrera soit strictement identique n'est pas correct pour autant. Il est donc préférable de tester si tout fonctionne correctement en comparant de visu les images de test et une générée avec : - ./genilivetest tests/[lieu] "Fichier de test\n[lieu]" tests/[lieu]tab tests/[lieu]temp > [lieu].png + < tests/[lieu] ./genilivetest -t "Fichier de test\n[lieu]" -f tests/[lieu]tab -c tests/[lieu]temp > [lieu].png Si le résultat est cohérent, et il devrait l'être à partir du moment où le test pour le tableau est passé avec succès, l'erreur peut être ignorée. Alternativement @@ -73,7 +73,7 @@ Depuis apt : L'exemple le plus typique serait : - gelinive profil "Titre" tableau temperature > image.png + < profil gelinive -t "Titre" -f tableau -c temperature > image.png Avec `profil` étant un fichier texte contenant les données du sondage par battage selon un certain format, tableau un chemin optionnel pour sauvegarder diff --git a/gelinive.1 b/gelinive.1 @@ -7,14 +7,32 @@ gelinive - produire des graphiques de profils stratigraphiques du manteau neigeu .SS SYNOPSIS .LP -[< \fIPROFIL\fR] \fBgelinive\fR [\fIPROFIL\fR [\fITITRE\fR [\fITABLEAU\fR [\fITEMPERATURE\fR]]]] +[< \fIPROFIL\fR] \fBgelinive\fR [-t \fITITRE\fR] [-f \fITABLEAU\fR] [-c \fITEMPERATURE\fR] .SS DESCRIPTION .LP Calcul la résistance au battage et l\(cqenfoncement total d\(cqune sonde dans la neige. En fait un graphique png en y ajoutant optionnellement la température -des couche. Pour le format en entrée, celui du tableau éventuellement produit +des couches. Pour le format en entrée, celui du tableau éventuellement produit et le format des relevés de température voir gelinive(5). +.PP +\fIPROFIL\fR, seule donnée nécessaire pour que gelinive produise un +graphique, doit être passé via stdin. Si aucun fichier n\(cqest donné gelinive +lira les données entrées au clavier. +.PP +\fITEMPERATURE\fR est un chemin vers un fichier contenant les termpératures des +couches de neige. S\(cqil_ est omis le grah généré n\(cqaura pas de courbe de +température. +.PP +\fITITRE\fR est une chaîne de caractère. Si elle est omise le graph généré aura +pour titre la date du jour sous le format \(lqjour\fIde\fRla_semaine dd/mm/yyyy\(rq. +.PP +\fITABLEAU\fR est le chemin du fichier à créer contenant les données d\(cqentrée +complétées de l\(cqenfoncement après n coups, de la résistance au battage et de la +hauteur au-dessus du sol. S\(cqil n\(cqexiste pas aucun fichier ne sera créé. +.PP +Toutes les options sont optionnelles, elles peuvent être renseignées dans +n\(cqimporte quel ordre. .SS UTILISATION ET EXEMPLES .LP @@ -47,24 +65,16 @@ un titre de graph, le chemin vers un tableau complet à créer et le chemin vers un fichier avec les données de températures : .LP .EX -gelinive profil \(dqTitre\(dq tableau temperature +gelinive profil -t \(dqTitre\(dq -f tableau -c temperature .EE .PP Finalement pour l\(cq\fIexemple le plus typique\fR, on peut rediriger la sortie pour créer une image : .LP .EX -gelinive profil \(dqTitre\(dq tableau temperature > image.png +gelinive profil -t \(dqTitre\(dq -f tableau -c temperature > image.png .EE .SS -BUGS ET AMELIORATIONS -.LP -Pour l\(cqinstant et pour faciliter le développement, chaque argument optionnel -nécessite l\(cqexistance du précédent pour être pris en compte. Pour afficher une -courbe de température il faut donc créer un fichier de tableau et donner un -titre au graph. Il ne sera pas possible de créer un graph avec une courbe de -température mais sans titre par exemple. -.SS VOIR AUSSI .LP gelinive(5), geliniveplot(1) diff --git a/gelinivetest b/gelinivetest @@ -14,27 +14,21 @@ done if [ $help = "yes" ] then <<. cat -Utilisation : [< fichier_profil] gelinive [fichier_profil [titre_du_graph [fichier_tableau [fichier_température]]] +Utilisation : [< fichier_profil] gelinive [-t titre_du_graph] [-f fichier_tableau] [-c fichier_température] Le fichier_profil, seule donnée nécessaire pour que gelinive produise un -graphique, peut être passé via stdin ou en premier argument à la commande. +graphique, doit être passé via stdin. Si aucun fichier n'est donné gelinive +lira les données entrées au clavier. Si fichier_température est omis le grah généré n'aura pas de courbe de température. -Si titre_du_graph est omis le graph généré n'aura pas de titre. +Si titre_du_graph est omis le graph généré aura pour titre la date du jour sous +le format "jour_de_la_semaine dd/mm/yyyy". -fichier_tableau est le chemin du fichier à créer contenant les données -d'entrée complétées de l'enfoncement après n coups, de la résistance au -battage et de la hauteur au-dessus du sol. Cet argument est optionel, s'il -n'existe pas aucun fichier ne sera créé. - -A noter qu'en l'état, pour faciliter le développement de l'outil, chaque -argument optionnel nécessite l'existance du précédent pour être accepté. -Autrement dit, si vous voulez mettre une courbe de température au graph il -faudra donner le chemin vers le fichier de tableau à créer, un titre au graph -et et avoir passé un fichier de profil en argument. Ce souci peut être résolu -en intégrant une vraie gestion des arguments avec des options. +fichier_tableau est le chemin du fichier à créer contenant les données d'entrée +complétées de l'enfoncement après n coups, de la résistance au battage et de la +hauteur au-dessus du sol. S'il n'existe pas aucun fichier ne sera créé. . exit 0 fi @@ -57,5 +51,5 @@ cat > $tempdir/profil # On stocke les données dans un f topheight=$(tail -n1 $tempdir/profil | cut -f5) # On récupère le dernier champ de la dernière ligne < $tempdir/profil calc_R_e_H $topheight | # On met dans stdin de la fonction les données, en argument la hauteur tee "$f" 2> /dev/null | # On stocke le résultat dans un fichier, si l'argument existe - ./geliniveplot "$t" "$c" 2> /dev/null # On créé le graph, premier arg = fichier temp, second = titre + ./geliniveplot "$t" "$c" 2> /dev/null # On créé le graph