From 0c17d3a76ee971324ff0cbaa8d190f2ad88ba8db Mon Sep 17 00:00:00 2001 From: ar-siddiqui Date: Tue, 16 Apr 2024 21:31:29 -0400 Subject: [PATCH] Update help docs for different tools --- .../algorithms/conus_nlcd_ssurgo/conus_nlcd_ssurgo.py | 6 +++--- .../processing/algorithms/custom/custom.py | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/curve_number_generator/processing/algorithms/conus_nlcd_ssurgo/conus_nlcd_ssurgo.py b/curve_number_generator/processing/algorithms/conus_nlcd_ssurgo/conus_nlcd_ssurgo.py index ad7acfb..e54c1f0 100644 --- a/curve_number_generator/processing/algorithms/conus_nlcd_ssurgo/conus_nlcd_ssurgo.py +++ b/curve_number_generator/processing/algorithms/conus_nlcd_ssurgo/conus_nlcd_ssurgo.py @@ -469,9 +469,9 @@ def shortHelpString(self):

This algorithm generates Curve Number layer for the given Area of Interest within the contiguous United States. It can also download Soil, Land Cover, and Impervious Surface datasets for the same area.

Input parameters

Area of Interest

-

Polygon layer representing area of interest

+

Polygon layer representing area of interest.

Lookup Table [optional]

-

Optional Table to relate NLCD Land Use Value and HSG Value to a particular curve number. By default the algorithm uses pre defined table. The table must have two columns 'grid_code' and 'cn'. grid_code is concatenation of NLCD Land Use code and Hydrologic Soil Group. Template csv file to create custom table (add an optional `.csvt` file to control column data types).

+

Optional Table to relate NLCD Land Cover Value and HSG Value to a particular curve number. By default the algorithm uses pre defined table. The table must have two columns 'grid_code' and 'cn'. grid_code is concatenation of NLCD Land Use code and Hydrologic Soil Group (HSG). Template csv file to create custom table (add an optional `.csvt` file to control column data types).

Drained Soils? [leave unchecked if not sure]

Certain Soils are categorized as dual category in SSURGO dataset. They have Hydrologic Soil Group D for Undrained Conditions and Hydrologic Soil Group A/B/C for Drained Conditions. @@ -486,7 +486,7 @@ def shortHelpString(self):

Soils

SSURGO Extended Soil Dataset

Curve Number

-

Generated Curve Number Layer based on Land Cover and HSG values.

+

Generated Curve Number layer based on Land Cover and HSG values.


Algorithm author: Abdul Raheem Siddiqui

Help author: Abdul Raheem Siddiqui

Algorithm version: {PLUGIN_VERSION}

Contact email: ars.work.ce@gmail.com

Disclaimer: The curve numbers generated with this algorithm are high level estimates and should be reviewed in detail before being used for detailed modeling or construction projects.

""" ) diff --git a/curve_number_generator/processing/algorithms/custom/custom.py b/curve_number_generator/processing/algorithms/custom/custom.py index d53e101..d945f46 100644 --- a/curve_number_generator/processing/algorithms/custom/custom.py +++ b/curve_number_generator/processing/algorithms/custom/custom.py @@ -208,12 +208,12 @@ def shortHelpString(self): return ( msg - + f"""Video Tutorial + + f"""

Algorithm description

This algorithm generates Curve Number layer for the given Area of Interest given a Land Cover Raster, Soil Layer, and a Lookup Table.

Input parameters

Area of Interest

-

Polygon layer representing area of interest

+

Polygon layer representing area of interest.

Land Cover Raster

Raster representing land cover values of the AOI

Soils Layer