Merge pull request #58 from ar-siddiqui/release/2.2.0

Draft a new release

curve_number_generator/metadata.txt

@@ -6,7 +6,7 @@
 name=Curve Number Generator
 qgisMinimumVersion=3.18
 description=Curve Number Generator plugin has multiple algorithms to generate the curve number layer for any area of interest using different datasets.
-version=2.1.3
+version=2.2.0
 author=Abdul Raheem Siddiqui
 [email protected]
 
@@ -21,7 +21,9 @@ repository=https://github.com/ar-siddiqui/curve_number_generator
 
 hasProcessingProvider=yes
 # Uncomment the following line and add your changelog:
-changelog= Version 2.1.3 - 2023-10-17
+changelog= Version 2.2.0 - 2024-04-16
+	- Add a new global algorithm utilizing ESA and ISRIC datasets
+	Version 2.1.3 - 2023-10-17
 	- Change NLCD Land Cover and Impervious layer to 2021 dataset
     Version 2.1.2 - 2023-05-24
 	- conus_nlcd_ssurgo: Fix missing data on corners of a rectangle AOI
@@ -44,7 +46,7 @@ homepage=https://github.com/ar-siddiqui/curve_number_generator
 category=Analysis
 icon=icon.png
 # experimental flag
-experimental=False
+experimental=True
 
 # deprecated flag (applies to the whole plugin, not just a single version)
 deprecated=False

curve_number_generator/processing/algorithms/conus_nlcd_ssurgo/conus_nlcd_ssurgo.py

@@ -469,9 +469,9 @@ def shortHelpString(self):
 <p>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.</p>
 <h2>Input parameters</h2>
 <h3>Area of Interest</h3>
-<p>Polygon layer representing area of interest</p>
+<p>Polygon layer representing area of interest.</p>
 <h3>Lookup Table [optional]</h3>
-<p>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. <a href="https://raw.githubusercontent.com/ar-siddiqui/curve_number_generator/v{PLUGIN_VERSION}/curve_number_generator/processing/algorithms/conus_nlcd_ssurgo/default_lookup.csv">Template csv file to create custom table</a> (add an optional <a href="https://raw.githubusercontent.com/ar-siddiqui/curve_number_generator/v{PLUGIN_VERSION}/curve_number_generator/processing/algorithms/conus_nlcd_ssurgo/default_lookup.csvt">`.csvt`</a> file to control column data types).</p>
+<p>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). <a href="https://raw.githubusercontent.com/ar-siddiqui/curve_number_generator/v{PLUGIN_VERSION}/curve_number_generator/processing/algorithms/conus_nlcd_ssurgo/default_lookup.csv">Template csv file to create custom table</a> (add an optional <a href="https://raw.githubusercontent.com/ar-siddiqui/curve_number_generator/v{PLUGIN_VERSION}/curve_number_generator/processing/algorithms/conus_nlcd_ssurgo/default_lookup.csvt">`.csvt`</a> file to control column data types).</p>
 <h3>Drained Soils? [leave unchecked if not sure]</h3>
 <p>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):
 <h3>Soils</h3>
 <p>SSURGO Extended Soil Dataset </p>
 <h3>Curve Number</h3>
-<p>Generated Curve Number Layer based on Land Cover and HSG values.</p>
+<p>Generated Curve Number layer based on Land Cover and HSG values.</p>
 <br><p align="right">Algorithm author: Abdul Raheem Siddiqui</p><p align="right">Help author: Abdul Raheem Siddiqui</p><p align="right">Algorithm version: {PLUGIN_VERSION}</p><p align="right">Contact email: [email protected]</p><p>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.</p></body></html>"""
         )
 

curve_number_generator/processing/algorithms/custom/custom.py

@@ -208,12 +208,12 @@ def shortHelpString(self):
 
         return (
             msg
-            + f"""<html><body><a "href"="https://github.com/ar-siddiqui/curve_number_generator/wiki/Tutorials#curve-number-generator-custom">Video Tutorial</a></h3>
+            + f"""<html><body>
 <h2>Algorithm description</h2>
 <p>This algorithm generates Curve Number layer for the given Area of Interest given a Land Cover Raster, Soil Layer, and a Lookup Table.</p>
 <h2>Input parameters</h2>
 <h3>Area of Interest</h3>
-<p>Polygon layer representing area of interest</p>
+<p>Polygon layer representing area of interest.</p>
 <h3>Land Cover Raster</h3>
 <p>Raster representing land cover values of the AOI</p>
 <h3>Soils Layer</h3>

curve_number_generator/processing/config.py

@@ -1,7 +1,9 @@
 # Constants
-PLUGIN_VERSION = "2.1.3"
+PLUGIN_VERSION = "2.2.0"
 
-REGISTRATION_FORM_LINK = "https://docs.google.com/forms/d/e/1FAIpQLSe-X-OR6tFvULP6oiiPK3M49-v07sjtxTu8md9XAuBOwxk7Xg/formResponse"
+REGISTRATION_FORM_LINK = (
+    "https://docs.google.com/forms/d/e/1FAIpQLSe-X-OR6tFvULP6oiiPK3M49-v07sjtxTu8md9XAuBOwxk7Xg/formResponse"
+)
 
 REGISTRATION_FORM_ENRIES = {
     "name": "entry.1135373624",
@@ -19,9 +21,7 @@
     "SSURGO_Soil": "https://sdmdataaccess.sc.egov.usda.gov/Spatial/SDMWGS84GEOGRAPHIC.wfs?SERVICE=WFS&VERSION=1.1.0&REQUEST=GetFeature&TYPENAME=mapunitpolyextended&SRSNAME=EPSG:4326&BBOX={}",
 }
 
-GLOBAL_ESA_ISRIC = {
-    "ISRIC_CLAY": "/vsicurl/https://files.isric.org/soilgrids/latest/data/clay/clay_0-5cm_mean.vrt"
-}
+GLOBAL_ESA_ISRIC = {"ISRIC_CLAY": "/vsicurl/https://files.isric.org/soilgrids/latest/data/clay/clay_0-5cm_mean.vrt"}
 
 MESSAGE_URL = "https://gist.githubusercontent.com/ar-siddiqui/2260461cfd0107150840ab6fb4f83516/raw"