Added documentation and Ardeche dataset example

CHANGELOG

+Version 6.1
+===========
+    * Dam and irrigation points management
+
+
 Version 6.0
 ===========
     * Grass7 compatibility
@@ -12,4 +17,4 @@ Version 6.0
     * No more system calls (to awk, grep, sed...) -> code is now full Python3 and portable to Windows
     * Use pipes between grass tools to avoid some hard disk access (avoid writing some intermediate files)
     * Added GNU license and list of author(s)
-    * Added simple tests for config file parameters
\ No newline at end of file
+    * Added simple tests for config file parameters

data_exemple/hrudelin_config.cfg → bin/hrudelin_config.cfg

-
 # -----------
 # environment
 # -----------
 
 [dir_in]
 dir:
-[files_in]
+
+[dem]
 dem:
-gauges:
+
 
 [data]
 hgeo:
 landuse:
 soil:
 
+
+[gauges]
+to_do:
+gauges:
+#for watershed ID, used for identification of watersheds
+gauges_col_name=
+# drained surface
+gauges_area_col_name=
+relocated_gauges=
+
+
 [irrigation]
-irrig_rast:
+to_do:
+irrigation:
+irrig_col_name=
+irrig_col_type=
+#you can indicate a minimum surface value for an HRU to be a GU:
+#minimum surface can be null, global or spatialized
+irrig_surf_min_GU=
+irrig_col_min_GU=
+irrigation_sector:
+irrig_sector_col_name=
+irrig_col_sau_irr=
+irrig_col_dom_sau_irr=
+irrigation_table:
+relocated_irrigation=
+
+[dams]
+to_do:
+dams=
+dams_col_name=
+dams_smax=
+dams_s0=
+#drained surface
+dams_area_col_name=
+relocated_dams=
 
 [dir_out]
 files:
@@ -41,73 +75,72 @@ south:
 # if demfill = yes : depressionless DEM will be generated
 #               no : no action on input DEM 
 #
-demfill:yes
+demfill:
 
 #
 # if rules_auto_* = yes : rules will be calculated by the module
 # if no : fill the corresponding file (reclass_default_rules_*)
 #
 [reclass_dem]
-rules_auto_dem:yes
+rules_auto_dem:
 step_dem:
 
 [reclass_slope]
-rules_auto_slope:yes
+rules_auto_slope:
 
 [reclass_aspect]
-rules_auto_aspect:yes
+rules_auto_aspect:
 
 [basin_min_size]
-# number of pixels
+# minimum size of calculated watersheds (r.watershed)
+# number of pixels 
+#  size = N = SURFACE_km2 / ( RES_km2^2 )
+#  ex: S = 10km2, RES = 200m = 0.2 km  ==> N = 250 pixels
+#      S = 20km2, RES = 90m = 0.09 km ==> N = 2469 pixels
 size=
 
 # ---------------------------
 # 2nd step : hru-delin_basins
 # ---------------------------
+# So it's possible to specify a variable using : or = ???
 [auto_relocation]
-to_do:yes
-#                   first rule
+to_do:
+#          -------- first rule
+# surface is in percent!
+# distance is in pixels: N = D / RES
+# example: for 3km distance with a 50m DEM, the number of pixel is: 3000/50 = 33 pixels
 surface_tolerance_1=
 distance_tolerance_1=
-#                   second rule    
+#          -------- second rule  
+# second rule with a distance tolerance of 6km and a surface tolerance of 30%
 surface_tolerance_2=
-distance_tolerance_2=
-
-# drained surface
-gauge_area_col_name=S_BH
+distance_tolerance_2=120
 
 # unit = 1 : m , = 2 : km
-gauge_area_unit=
+area_unit=
 
 
-relocated_gauges:
 
-[for_watershed_id]
-# column name of the gauge attribute (attribute type must be numeric)
-# used for identification of watersheds
-col_name=
 # ---------------------------
 # 3rd step : hru-delin_hrugen
 # ---------------------------
 
 [hrus_min_surface]
-# 
+# there, this is in pixel so pay attention to the DEM resolution 
+# same as for bassin_min_size: N = SURFACE_km2 / ( RES_km2^2 ) # see 'size' parameter in step 1 for examples
+# 2 km2 = 247 pixels
 surface=
 
-# 
+#
 # MNT-derived layers to be integrated in the overlay operation
 #
 [layer_overlay]
-dem:x
-slope:x
-aspect:x
+dem:
+slope:
+aspect:
 
 # --------------------------------
 # 4th step : hru-delin_parms_J2000
 # --------------------------------
 [topology]
-dissolve_cycle:y
-
-
-
-
+dissolve_cycle:

data_exemple_ardeche/boundaries.cpg

+420
\ No newline at end of file

data_exemple_ardeche/boundaries.prj

+PROJCS["RGF93_Lambert_93",GEOGCS["GCS_RGF93",DATUM["D_RGF_1993",SPHEROID["GRS_1980",6378137,298.257222101]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]],PROJECTION["Lambert_Conformal_Conic"],PARAMETER["standard_parallel_1",49],PARAMETER["standard_parallel_2",44],PARAMETER["latitude_of_origin",46.5],PARAMETER["central_meridian",3],PARAMETER["false_easting",700000],PARAMETER["false_northing",6600000],UNIT["Meter",1]]
\ No newline at end of file

data_exemple_ardeche/dams.prj

+PROJCS["RGF93_Lambert_93",GEOGCS["GCS_RGF93_geographiques_dms",DATUM["D_RGF_1993",SPHEROID["GRS_1980",6378137.0,298.257222101]],PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]],PROJECTION["Lambert_Conformal_Conic"],PARAMETER["False_Easting",700000.0],PARAMETER["False_Northing",6600000.0],PARAMETER["Central_Meridian",3.0],PARAMETER["Standard_Parallel_1",44.0],PARAMETER["Standard_Parallel_2",49.0],PARAMETER["Latitude_Of_Origin",46.5],UNIT["Meter",1.0]]
\ No newline at end of file