[GRASS-SVN] r74377 - grass-addons/grass7/raster/r.sim.terrain

[svn_grass at osgeo.org]

Author: baharmon
Date: 2019-04-14 19:49:11 -0700 (Sun, 14 Apr 2019)
New Revision: 74377

Modified:
   grass-addons/grass7/raster/r.sim.terrain/r.sim.terrain.html
   grass-addons/grass7/raster/r.sim.terrain/r.sim.terrain.py
Log:
updated documentation

Modified: grass-addons/grass7/raster/r.sim.terrain/r.sim.terrain.html
===================================================================
--- grass-addons/grass7/raster/r.sim.terrain/r.sim.terrain.html	2019-04-15 02:02:05 UTC (rev 74376)
+++ grass-addons/grass7/raster/r.sim.terrain/r.sim.terrain.html	2019-04-15 02:49:11 UTC (rev 74377)
@@ -19,12 +19,47 @@
 
 <h2>EXAMPLES</h2>
 
+<p><b>Basic instructions</b></p>
+A basic example for the
+<a href="https://grass.osgeo.org/download/sample-data/">North Carolina sample dataset</a>.
+Install the add-on module <i>r.sim.terrain</i>.
+Copy the raster elevation map <i>elev_lid792_1m</i> from the PERMANENT mapset
+to the current mapset.
+Set the region to this elevation map at 1 meter resolution.
+Run <i>r.sim.terrain</i> with the RUSLE model
+for a 120 min event with a rainfall intensity of 50 mm/hr
+at a 3 minute interval.
+Set the empirical coefficients m and n to 0.4 and 1.3 respectively.
+Use the `-f` flag to fill depressions
+in order to reduce the effect of positive feedback loops.
+
+
+<div class="code"><pre>
+g.extension  extension=r.sim.terrain
+g.copy raster=elev_lid792_1m at PERMANENT,elevation
+g.region raster=elev_lid792_1m res=1
+r.sim.terrain -f elevation=elevation runs=event mode=rusle_mode rain_intensity=50.0 rain_duration=120 rain_interval=3 m=0.4 n=1.3
+</pre></div>
+
+<div align="center" style="margin: 10px">
+<a href="r_sim_terrain_rusle.png">
+<img src="r_sim_terrain_rusle.png" width="600" height="600" alt="r.sim.terrain basic example" border="0">
+</a><br>
+<i>Figure: Net difference (m) for a dynamic RUSLE simulation
+of a 120 min event with a rainfall intensity of 50 mm/hr with a 3 minute interval.</i>
+</div>
+
+<p><b>Spatially variable soil and landcover</b></p>
+
+<p>
 Clone or download the
-<a href="https://github.com/baharmon/landscape_evolution_dataset">sample dataset</a>
+<a href="https://github.com/baharmon/landscape_evolution_dataset">landscape evolution sample dataset</a>
 with a time series of lidar-based digital elevation models and orthoimagery
 for a highly eroded subwatershed of Patterson Branch Creek,
 Fort Bragg, NC, USA.
+</p>
 
+<p>
 Run <i>r.sim.terrain</i> with the simwe model
 for a 120 min event with a rainfall intensity of 50 mm/hr.
 Use a transport value lower than the detachment value
@@ -31,19 +66,21 @@
 to trigger a transport limited erosion regime.
 Use the -f flag to fill depressions
 in order to reduce the effect of positive feedback loops.
+</p>
 
 <div class="code"><pre>
 g.mapset -c mapset=transport location=nc_spm_evolution
-g.region region=region res=0.3
+g.region region=region res=1
 r.mask vector=watershed
-r.sim.terrain -f runs=event mode=simwe_mode rain_intensity=50.0 rain_interval=120 rain_duration=10 \
-walkers=1000000 detachment_value=0.01 transport_value=0.0001 manning=mannings runoff=runoff
+g.copy raster=elevation_2016 at PERMANENT,elevation_2016
+r.sim.terrain -f elevation=elevation_2016 runs=event mode=simwe_mode \
+rain_intensity=50.0 rain_interval=120 rain_duration=10 walkers=1000000 \
+detachment_value=0.01 transport_value=0.0001 manning=mannings runoff=runoff
 </pre></div>
 
 <div align="center" style="margin: 10px">
-
 <a href="r_sim_terrain.png">
-<img src="r_sim_terrain.png" width="600" height="600" alt="r.sim.terrain example" border="0">
+<img src="r_sim_terrain.png" width="600" height="600" alt="r.sim.terrain advanced example" border="0">
 </a><br>
 <i>Figure: Net difference (m)
 for a steady state, transport limited SIMWE simulation
@@ -50,7 +87,7 @@
 of a 120 min event with a rainfall intensity of 50 mm/hr.</i>
 </div>
 
-For more examples see this in-depth
+For more detailed instructions and examples see this in-depth
 <a href="https://github.com/baharmon/landscape_evolution/blob/master/tutorial.md">tutorial</a>.
 
 <h2>ERROR MESSAGES</h2>

Modified: grass-addons/grass7/raster/r.sim.terrain/r.sim.terrain.py
===================================================================
--- grass-addons/grass7/raster/r.sim.terrain/r.sim.terrain.py	2019-04-15 02:02:05 UTC (rev 74376)
+++ grass-addons/grass7/raster/r.sim.terrain/r.sim.terrain.py	2019-04-15 02:49:11 UTC (rev 74377)
@@ -34,7 +34,7 @@
 #% type: string
 #% required: yes
 #% multiple: no
-#% answer: series
+#% answer: event
 #% options: event,series
 #% description: Run for a single rainfall event or a series of events
 #% descriptions: event;single rainfall event;series;series of rainfall events
@@ -143,7 +143,6 @@
 #% description: Number of walkers (max = 7000000)
 #% answer: 1000000
 #% multiple: no
-#% required: yes
 #% guisection: Input
 #%end
 
@@ -317,7 +316,7 @@
 #% key: start
 #% type: string
 #% description: Start time in year-month-day hour:minute:second format
-#% answer: 2000-01-01 00:00:00
+#% answer: 2016-01-01 00:00:00
 #% multiple: no
 #% required: yes
 #% guisection: Temporal