Add description field in algorithms/ YAML files

Author: sebmestrallet

algorithms/AlgoHex.yml

@@ -1,3 +1,5 @@
+description: |
+  See https://github.com/cgg-bern/AlgoHex
 tet-mesh: { # case of 'AlgoHex' applied on a 'tet-mesh' subfolder
   executable: {
     path: AlgoHex,

algorithms/Gmsh.yml

@@ -1,3 +1,5 @@
+description: |
+  See default tetrehedrization of gmsh.info
 STEP: { # case of 'Gmsh' applied on a 'STEP' subfolder
   #
   # input                               output

algorithms/HexBox.yml

@@ -1,3 +1,5 @@
+description:
+  See https://github.com/cg3hci/HexBox
 tet-mesh: { # case of 'HexBox' applied on a 'tet-mesh' subfolder
   executable: {
     path: HexBox,

algorithms/MEDIT_to_VTKv2.yml

@@ -1,3 +1,5 @@
+description: |
+  Convert a tetrahedral mesh from the MEDIT format (.mesh) to the VTK data file v2.0 format (.vtk)
 tet-mesh: { # case of 'MEDIT_to_VTKv2' applied on a 'tet-mesh' subfolder
   executable: {
     path: Gmsh,

algorithms/OVM_to_MEDIT.yml

@@ -1,3 +1,5 @@
+description: |
+  Convert a hexahedral mesh from the OpenVolumeMesh format (.ovm) to the MEDIT format (.mesh)
 hex-mesh: { # case of 'OVM_to_MEDIT' applied on a 'hex-mesh' subfolder
   executable: {
     path: ovm.io,

algorithms/README.md

@@ -5,6 +5,9 @@ They are not parsed for now, it is a prospective study for the architecture revi
 
 Template :
 ```yaml
+description: |
+    Description textuelle
+    de l'algorithme
 input_type: {
     executable: {
         path: , # an entry of settings.json/paths for now. Maybe this will become a paths.yml

algorithms/automatic_polycube.yml

@@ -1,3 +1,5 @@
+description: |
+  See main app of https://github.com/LIHPC-Computational-Geometry/automatic_polycube
 tet-mesh: { # case of 'automatic_polycube' applied on a 'tet-mesh' subfolder
   executable: {
     path: automatic_polycube,

algorithms/automatic_polycube_gui.yml

@@ -1,3 +1,5 @@
+description: |
+  See main app of https://github.com/LIHPC-Computational-Geometry/automatic_polycube
 tet-mesh: { # case of 'automatic_polycube_gui' applied on a 'tet-mesh' subfolder
   executable: {
     path: automatic_polycube,

algorithms/evocube.yml

@@ -1,3 +1,5 @@
+description: |
+  See https://github.com/LIHPC-Computational-Geometry/evocube
 tet-mesh: { # case of 'evocube' applied on a 'tet-mesh' subfolder
   executable: {
     path: evocube,

algorithms/extract_surface.yml

@@ -1,3 +1,5 @@
+description: |
+  Extract the surface triangle mesh of a tetrahedral mesh
 tet-mesh: { # case of 'extract_surface' applied on a 'tet-mesh' subfolder
   executable: {
     path: automatic_polycube,

algorithms/fastbndpolycube.yml

@@ -1,3 +1,5 @@
+description: |
+  See https://github.com/fprotais/fastbndpolycube
 labeling: { # case of 'fastbndpolycube' applied on a 'labeling' subfolder
   executable: {
     path: fastbndpolycube,

algorithms/global_padding.yml

@@ -1,3 +1,5 @@
+description: |
+  See the post-processing stage of https://github.com/fprotais/robustPolycube
 hex-mesh: { # case of 'global_padding' applied on a 'hex-mesh' subfolder
   executable: {
     path: robustPolycube,

algorithms/graphcut_labeling_gui.yml

@@ -1,3 +1,5 @@
+description: |
+  Labeling generation with Graph-Cuts Optimisation
 tet-mesh: { # case of 'graphcut_labeling' applied on a 'tet-mesh' subfolder
   executable: {
     path: automatic_polycube,

algorithms/gridgenerator.yml

@@ -1,3 +1,5 @@
+description: |
+  3D grid generation inside the bounding box of the mesh
 tet-mesh: { # case of 'gridgenerator' applied on a 'tet-mesh' subfolder
   executable: {
     path: marchinghex,

algorithms/hex_mesh_stats.yml

@@ -1,3 +1,5 @@
+description: |
+  Compute mesh statistics on a hexahedral mesh
 hex-mesh: { # case of 'hex_mesh_stats' applied on a 'hex-mesh' subfolder
   executable: {
     path: automatic_polycube,

algorithms/labeling_painter.yml

@@ -1,3 +1,5 @@
+description: |
+  Manual labeling modification
 tet-mesh: { # case of 'labeling_painter' applied on a 'tet-mesh' subfolder
   executable: {
     path: automatic_polycube,

algorithms/labeling_stats.yml

@@ -1,3 +1,5 @@
+description: |
+  Compute statistics of a labeling
 labeling: { # case of 'write_polycube_as_geogram' applied on a 'labeling' subfolder
   executable: {
     path: automatic_polycube,

algorithms/marchinghex.yml

@@ -1,3 +1,5 @@
+description: |
+  See https://github.com/fprotais/marchinghex
 marchinghex_grid: { # case of 'marchinghex' applied on a 'marchinghex_grid' subfolder
   executable: {
     path: marchinghex,

algorithms/naive_labeling.yml

@@ -1,3 +1,5 @@
+description: |
+  Compute the naive labeling (nearest signed principal axis of each facet normal)
 tet-mesh: { # case of 'naive_labeling' applied on a 'tet-mesh' subfolder
   executable: {
     path: automatic_polycube,

algorithms/polycube_withHexEx.yml

@@ -1,3 +1,5 @@
+description: |
+  See https://github.com/fprotais/polycube_withHexEx
 labeling: { # case of 'polycube_withHexEx' applied on a 'labeling' subfolder
   executable: {
     path: polycube_withHexEx,

algorithms/rb_generate_deformation.yml

@@ -1,4 +1,6 @@
 # TODO pre-processing to skip execution if output files already exists?
+description: |
+  See the pre-processing stage of https://github.com/fprotais/robustPolycube
 labeling: { # case of 'rb_generate_deformation' applied on a 'labeling' subfolder
   executable: {
     path: robustPolycube,

algorithms/rb_generate_quantization.yml

@@ -1,3 +1,5 @@
+description: |
+  See the main app of https://github.com/fprotais/robustPolycube
 labeling: { # case of 'rb_generate_quantization' applied on a 'labeling' subfolder
   executable: {
     path: robustPolycube,

algorithms/surface_mesh_stats.yml

@@ -1,3 +1,5 @@
+description: |
+  Compute statistics on the surface mesh
 tet-mesh: { # case of 'surface_mesh_stats' applied on a 'tet-mesh' subfolder
   executable: {
     path: automatic_polycube,

algorithms/tet_mesh_stats.yml

@@ -1,3 +1,5 @@
+description: |
+  Compute statistics on the tetrahedral mesh
 tet-mesh: { # case of 'tet_mesh_stats' applied on a 'tet-mesh' subfolder
   executable: {
     path: automatic_polycube,

algorithms/volume_labeling.yml

@@ -1,3 +1,5 @@
+description:
+  Compute the volume labeling (per tetra facets) from the surface labeling (per surface facets)
 labeling: { # case of 'volume_labeling' applied on a 'labeling' subfolder
   executable: {
     path: automatic_polycube,

algorithms/write_glb.yml

@@ -1,3 +1,5 @@
+description:
+  Export a 3D model as glTF 2.0
 tet-mesh: { # case of 'write_glb' applied on a 'tet-mesh' subfolder
   executable: {
     path: automatic_polycube,

algorithms/write_labeling_as_geogram.yml

@@ -1,3 +1,5 @@
+description: |
+  Convert a surface mesh and a labeling as .geogram mesh containing the labeling as facet attribute
 labeling: { # case of 'write_labeling_as_geogram' applied on a 'labeling' subfolder
   executable: {
     path: automatic_polycube,

algorithms/write_polycube_as_geogram.yml

@@ -1,3 +1,5 @@
+description: |
+  Convert a polycube mesh and a labeling as .geogram mesh containing the labeling as facet attribute
 labeling: { # case of 'write_polycube_as_geogram' applied on a 'labeling' subfolder
   executable: {
     path: automatic_polycube,