Earthwork tutorials: update for compatibility with new version of r.earthworks (#90)

Author: baharmon

content/tutorials/earthworks/basics.ipynb

@@ -176,7 +176,8 @@
     "and y-coordinates. Use the `z` parameter to set a z-coordinate for the\n",
     "top of the peak. Optionally use the `flat` parameter to create a plateau\n",
     "at the top of the peak. Using the default linear growth and decay\n",
-    "function $z = z_0 - r \\sqrt{\\Delta x^2 + \\Delta y^2}$, set the `rate` to\n",
+    "function $z = z_0 - r \\sqrt{\\Delta x^2 + \\Delta y^2}$, \n",
+    "set the `linear` slope parameter to\n",
     "0.5 to model a 50 percent slope."
    ]
   },
@@ -196,7 +197,7 @@
     "    coordinates=[400, 100],\n",
     "    z=25,\n",
     "    flat=25,\n",
-    "    rate=0.5\n",
+    "    linear=0.5\n",
     "    )\n",
     "\n",
     "# Visualize\n",
@@ -248,7 +249,7 @@
     "    coordinates=[400, 100],\n",
     "    z=-25,\n",
     "    flat=25,\n",
-    "    rate=0.5\n",
+    "    linear=0.5\n",
     "    )\n",
     "\n",
     "# Visualize\n",
@@ -298,7 +299,7 @@
     "    coordinates=[350, 100, 450, 100],\n",
     "    z=[-25, 25],\n",
     "    flat=25,\n",
-    "    rate=0.5\n",
+    "    linear=0.5\n",
     "    )\n",
     "\n",
     "# Visualize\n",
@@ -365,7 +366,7 @@
     "    earthworks=\"earthworks\",\n",
     "    operation=\"fill\",\n",
     "    raster=\"random\",\n",
-    "    rate=0.25,\n",
+    "    linear=0.25,\n",
     "    flat=25\n",
     "    )\n",
     "\n",

content/tutorials/earthworks/basics.qmd

@@ -187,14 +187,15 @@ Use the `z` parameter to set a z-coordinate for the top of the peak.
 Optionally use the `flat` parameter to create a plateau at the top of the peak.
 Using the default linear growth and decay function
 $z = z_0 - r \sqrt{\Delta x^2 + \Delta y^2}$,
-set the `rate` to 0.5 to model a 50 percent slope. 
+set the `linear` slope parameter to 0.5 
+to model a 50 percent slope. 
 
 ::: {.panel-tabset group="language"}
 
 ## Command line
 
 ```{bash}
-r.earthworks elevation=elevation earthworks=peak operation=fill coordinates=400,100 z=25 flat=25 rate=0.5
+r.earthworks elevation=elevation earthworks=peak operation=fill function=linear linear=0.5 coordinates=400,100 z=25 flat=25
 ```
 
 ## Python
@@ -206,10 +207,11 @@ gs.run_command(
     elevation="elevation",
     earthworks="peak",
     operation="fill",
+    function="linear",
+    linear=0.5,
     coordinates=[400, 100],
     z=25,
-    flat=25,
-    rate=0.5
+    flat=25
     )
 
 # Visualize
@@ -239,7 +241,7 @@ then the slopes will climb at a given rate of growth.
 ## Command line
 
 ```{bash}
-r.earthworks elevation=elevation earthworks=pit operation=cut coordinates=400,100 z=-25 flat=25 rate=0.5
+r.earthworks elevation=elevation earthworks=pit operation=cut function=linear linear=0.5 coordinates=400,100 z=-25 flat=25
 ```
 
 ## Python
@@ -251,10 +253,11 @@ gs.run_command(
     elevation="elevation",
     earthworks="pit",
     operation="cut",
+    function="linear",
+    linear=0.5,
     coordinates=[400, 100],
     z=-25,
-    flat=25,
-    rate=0.5
+    flat=25
     )
 
 # Visualize
@@ -281,7 +284,7 @@ and another z-coordinate for the top of the peak.
 ## Command line
 
 ```{bash}
-r.earthworks elevation=elevation earthworks=pit_and_peak operation=cutfill coordinates=350,100,450,100 z=-25,25 flat=25 rate=0.5
+r.earthworks elevation=elevation earthworks=pit_and_peak operation=cutfill function=linear linear=0.5 coordinates=350,100,450,100 z=-25,25 flat=25
 ```
 
 ## Python
@@ -293,10 +296,11 @@ gs.run_command(
     elevation="elevation",
     earthworks="pit_and_peak",
     operation="cutfill",
+    function="linear",
+    linear=0.5,
     coordinates=[350, 100, 450, 100],
     z=[-25, 25],
-    flat=25,
-    rate=0.5
+    flat=25
     )
 
 # Visualize
@@ -335,7 +339,7 @@ Set input raster to the random cells.
 ```{bash}
 r.surf.random out=surface min=0 max=25 seed=2
 r.random input=surface npoints=50 raster=random seed=7
-r.earthworks elevation=elevation earthworks=earthworks operation=fill raster=random rate=0.25 flat=25
+r.earthworks elevation=elevation earthworks=earthworks operation=fill raster=random function=linear linear=0.25 flat=25
 ```
 
 ## Python
@@ -360,7 +364,8 @@ gs.run_command(
     earthworks="earthworks",
     operation="fill",
     raster="random",
-    rate=0.25,
+    function="linear",
+    linear=0.25,
     flat=25
     )
 
@@ -401,4 +406,4 @@ m.show()
 
 :::
 
-![Contours](images/basics_06.webp)
+![Contours](images/basics_06.webp)

content/tutorials/earthworks/earthworks.qmd

@@ -22,9 +22,7 @@ execute:
 
 ![Random fill operation with r.earthworks](images/earthworks_01.webp)
 
-Learn how model terrain with {{< meta links.r_earthworks >}}. With this tool you can generate new terrain or modify existing terrain using cut and fill operations inspired by earthworking. The first tutorial on the basics of terrain modeling introduces key concepts such as cut and fill operations. The subsequent tutorials introduce more advanced concepts such as relative operations and growth and decay functions. These tutorials demonstrate how to generate terrain, model natural landforms, and model anthropogenic landforms - i.e. earthworks - such as roads, dams, and levees. Read our [paper](https://raw.githubusercontent.com/baharmon/r.earthworks/main/paper/paper.pdf) to learn more. 
-
-<!-- Update link when paper published -->
+Learn how model terrain with {{< meta links.r_earthworks >}}. With this tool you can generate new terrain or modify existing terrain using cut and fill operations inspired by earthworking. The first tutorial on the basics of terrain modeling introduces key concepts such as cut and fill operations. The subsequent tutorials introduce more advanced concepts such as relative operations and growth and decay functions. These tutorials demonstrate how to generate terrain, model natural landforms, and model anthropogenic landforms - i.e. earthworks - such as roads, dams, and levees. Read our [paper](https://raw.githubusercontent.com/baharmon/r.earthworks/main/paper/paper.pdf) to learn more.
 
 ## Installation
 

content/tutorials/earthworks/gullies.ipynb

@@ -285,7 +285,7 @@
     "and decay function $z = z_0 e^{-\\lambda \\sqrt{\\Delta x^2 + \\Delta y^2}}$\n",
     "to model the steep slopes of the gullies. Set `mode` to relative,\n",
     "`operation` to cut, `function` to exponential, `raster` to the raster\n",
-    "map of gullies, `z` to a negative value, and `rate` $\\lambda$ to a value\n",
+    "map of gullies, `z` to a negative value, and `exponential` $\\lambda$ to a value\n",
     "such as 0.1. Save an output `volume` raster to visualize volumetric\n",
     "change. This may take a minute to run. For faster results, try setting a\n",
     "lower resolution with\n",
@@ -309,7 +309,7 @@
     "    operation=\"cut\",\n",
     "    function=\"exponential\",\n",
     "    raster=\"gullies\",\n",
-    "    rate=0.1\n",
+    "    exponential=0.1\n",
     "    )\n",
     "gs.run_command(\"r.colors\", map=\"volume\", color=\"inferno\")\n",
     "\n",

content/tutorials/earthworks/gullies.qmd

@@ -305,7 +305,7 @@ Set `mode` to relative,
 `operation` to cut,
 `function` to exponential,
 `raster` to the raster map of gullies,
-and `rate` $\lambda$ to a value such as 0.1.
+and `exponential` $\lambda$ to a value such as 0.1.
 Save an output `volume` raster
 to visualize volumetric change.
 This may take a minute to run.
@@ -317,7 +317,7 @@ with {{< meta links.g_region >}}.
 ## Command line
 
 ```{bash}
-r.earthworks elevation=fractal earthworks=gullies volume=volume mode=relative operation=cut function=exponential raster=gullies rate=0.1 --overwrite
+r.earthworks elevation=fractal earthworks=gullies volume=volume mode=relative operation=cut function=exponential raster=gullies exponential=0.1 --overwrite
 r.colors map=volume color=inferno
 ```
 
@@ -334,7 +334,7 @@ gs.run_command(
     operation="cut",
     function="exponential",
     raster="gullies",
-    rate=0.1
+    exponential=0.1
     )
 gs.run_command("r.colors", map="volume", color="inferno")
 
@@ -355,4 +355,4 @@ m.show()
 
 ![Gullies](images/gullies_03.webp)
 
-![Volumetric change](images/gullies_04.webp)
+![Volumetric change](images/gullies_04.webp)

content/tutorials/earthworks/levees.ipynb

@@ -376,7 +376,7 @@
     "north. Then use a cut operation with\n",
     "[r.earthworks](https://grass.osgeo.org/grass-stable/manuals/addons/r.earthworks.html)\n",
     "to model the borrow area. Set `elevation` to the elevation raster,\n",
-    "`lines` to the borrow vector, `z` to -1.5, `rate` to 0.2, and `flat` to\n",
+    "`lines` to the borrow vector, `z` to -1.5, `linear` to 0.2, and `flat` to\n",
     "7.6."
    ]
   },
@@ -398,7 +398,7 @@
     "    operation=\"cut\",\n",
     "    lines=\"borrow\",\n",
     "    z=[-1.5],\n",
-    "    rate=0.2,\n",
+    "    linear=0.2,\n",
     "    flat=7.6\n",
     "    )\n",
     "\n",
@@ -430,7 +430,7 @@
     "Use a fill operation with\n",
     "[r.earthworks](https://grass.osgeo.org/grass-stable/manuals/addons/r.earthworks.html)\n",
     "to model the restored ridge. Set `elevation` to the earthworks raster,\n",
-    "`lines` to the ridge vector, `z` to 1.5, `rate` to 0.2, and `flat` to\n",
+    "`lines` to the ridge vector, `z` to 1.5, `linear` to 0.2, and `flat` to\n",
     "7.6."
    ]
   },
@@ -449,7 +449,7 @@
     "    operation=\"fill\",\n",
     "    lines=\"ridges\",\n",
     "    z=1.5,\n",
-    "    rate=0.2,\n",
+    "    linear=0.2,\n",
     "    flat=7.6\n",
     "    )\n",
     "\n",
@@ -485,7 +485,7 @@
     "with a ratio of 10H:1V. For\n",
     "[r.earthworks](https://grass.osgeo.org/grass-stable/manuals/addons/r.earthworks.html)\n",
     "set `elevation` to the earthworks raster, `lines` to the levee vector,\n",
-    "`z` to 5.5, `rate` to 0.1, and `flat` to 1.5."
+    "`z` to 5.5, `linear` to 0.1, and `flat` to 1.5."
    ]
   },
   {
@@ -503,7 +503,7 @@
     "    operation=\"fill\",\n",
     "    lines=\"levees\",\n",
     "    z=5.5,\n",
-    "    rate=0.1,\n",
+    "    linear=0.1,\n",
     "    flat=1.5\n",
     "    )\n",
     "\n",
@@ -539,7 +539,7 @@
     "built from rows of interlocking vertical segments \n",
     "of piles that are driven into the ground. \n",
     "Set `elevation` to the\n",
-    "earthworks raster, `lines` to the gaps vector, `z` to -0.6, `rate` to 1,\n",
+    "earthworks raster, `lines` to the gaps vector, `z` to -0.6, `linear` to 1,\n",
     "and `flat` to 10. The radius of flats should be set to the region\n",
     "resolution to ensure that the gaps are fully closed because we test our\n",
     "design with a flood simulation. To better visualize the results, use\n",
@@ -563,7 +563,7 @@
     "    operation=\"cutfill\",\n",
     "    lines=\"gaps\",\n",
     "    z=-0.6,\n",
-    "    rate=1,\n",
+    "    linear=1,\n",
     "    flat=10\n",
     "    )\n",
     "\n",
@@ -575,7 +575,7 @@
     "    operation=\"cutfill\",\n",
     "    lines=\"closures\",\n",
     "    z=1.37,\n",
-    "    rate=1,\n",
+    "    linear=1,\n",
     "    flat=5\n",
     "    )\n",
     "\n",