Merge pull request #1716 from davemfish/bugfix/1693-documentation

Corrections to args spec regarding evapotranspiration and preciptation
natcap · Dec 17, 2024 · f3c2a55 · f3c2a55
2 parents 3b9b2d1 + 8850bc4
commit f3c2a55
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/src/natcap/invest/seasonal_water_yield/seasonal_water_yield.py b/src/natcap/invest/seasonal_water_yield/seasonal_water_yield.py
@@ -49,7 +49,14 @@
             "contents": {
                 # monthly et0 maps, each file ending in a number 1-12
                 "[MONTH]": {
-                    **spec_utils.ET0,
+                    "name": gettext("reference evapotranspiration"),
+                    "type": "raster",
+                    "bands": {
+                        1: {
+                            "type": "number",
+                            "units": u.millimeter/u.month
+                        }
+                    },
                     "about": gettext(
                         "Twelve files, one for each month. File names must "
                         "end with the month number (1-12). For example, "
@@ -62,7 +69,8 @@
             "about": gettext(
                 "Directory containing maps of reference evapotranspiration "
                 "for each month. Only .tif files should be in this folder "
-                "(no .tfw, .xml, etc files)."),
+                "(no .tfw, .xml, etc files). Required if User-Defined Local "
+                "Recharge is not selected."),
             "name": gettext("ET0 directory")
         },
         "precip_dir": {
@@ -89,7 +97,8 @@
             "about": gettext(
                 "Directory containing maps of monthly precipitation for each "
                 "month. Only .tif files should be in this folder (no .tfw, "
-                ".xml, etc files)."),
+                ".xml, etc files). Required if User-Defined Local Recharge is "
+                "not selected."),
             "name": gettext("precipitation directory")
         },
         "dem_raster_path": {

diff --git a/src/natcap/invest/spec_utils.py b/src/natcap/invest/spec_utils.py
@@ -93,15 +93,15 @@
     "name": gettext("precipitation")
 }
 ET0 = {
-    "name": gettext("evapotranspiration"),
+    "name": gettext("reference evapotranspiration"),
     "type": "raster",
     "bands": {
         1: {
             "type": "number",
             "units": u.millimeter
         }
     },
-    "about": gettext("Map of evapotranspiration values.")
+    "about": gettext("Map of reference evapotranspiration values.")
 }
 SOIL_GROUP = {
     "type": "raster",