Merge pull request #63 from ar-siddiqui/feature/ornl-algorithm

Add ESA ORNL algorithm

Author: ar-siddiqui

curve_number_generator/__init__.py

@@ -8,7 +8,7 @@
                               -------------------
         begin                : 2020-06-06
         copyright            : (C) 2021 by Abdul Raheem Siddiqui
-        email                : mailto:ars.work.ce@gmail.com
+        email                : mailto:ar-siddiqui@outlook.com
  ***************************************************************************/
 
 /***************************************************************************

curve_number_generator/curve_number_generator.py

@@ -9,7 +9,7 @@
                               -------------------
         begin                : 2022-07-22
         copyright            : (C) 2022 by Abdul Raheem Siddiqui
-        email                : mailto:ars.work.ce@gmail.com
+        email                : mailto:ar-siddiqui@outlook.com
  ***************************************************************************/
 
 /***************************************************************************

curve_number_generator/metadata.txt

@@ -6,9 +6,9 @@
 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.2.0
+version=2.2.1
 author=Abdul Raheem Siddiqui
-email=ars.work.ce@gmail.com
+email=ar-siddiqui@outlook.com
 
 about=Curve Number Generator plugin has multiple algorithms to generate the curve number layer for any area of interest using different datasets.
 
@@ -21,7 +21,10 @@ repository=https://github.com/ar-siddiqui/curve_number_generator
 
 hasProcessingProvider=yes
 # Uncomment the following line and add your changelog:
-changelog= Version 2.2.0 - 2024-04-16
+changelog=Version 2.2.1 - 2024-07-21
+	- Add a new global algorithm utilizing ESA Land Cover and ORNL HSG datasets
+	- Deprecate ESA and ISRIL aglorithm
+	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

curve_number_generator/processing/algorithms/__init__.py

@@ -1,4 +1,3 @@
 from .conus_nlcd_ssurgo.conus_nlcd_ssurgo import ConusNlcdSsurgo
 from .custom.custom import Custom
-
-from .global_esa_isric.global_esa_isric import GlobalEsaIsric
+from .global_esa_ornl.global_esa_ornl import GlobalEsaORNL

curve_number_generator/processing/algorithms/conus_nlcd_ssurgo/conus_nlcd_ssurgo.py

@@ -9,7 +9,7 @@
                               -------------------
         begin                : 2022-07-22
         copyright            : (C) 2022 by Abdul Raheem Siddiqui
-        email                : ars.work.ce@gmail.com
+        email                : ar-siddiqui@outlook.com
  ***************************************************************************/
 
 /***************************************************************************
@@ -487,7 +487,7 @@ def shortHelpString(self):
 <p>SSURGO Extended Soil Dataset </p>
 <h3>Curve Number</h3>
 <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: ars.work.ce@gmail.com</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>"""
+<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: ar-siddiqui@outlook.com</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>"""
         )
 
     def createInstance(self):

curve_number_generator/processing/algorithms/custom/custom.py

@@ -9,7 +9,7 @@
                               -------------------
         begin                : 2022-07-22
         copyright            : (C) 2022 by Abdul Raheem Siddiqui
-        email                : mailto:ars.work.ce@gmail.com
+        email                : mailto:ar-siddiqui@outlook.com
  ***************************************************************************/
 
 /***************************************************************************
@@ -226,7 +226,7 @@ def shortHelpString(self):
 <h2>Outputs</h2>
 <h3>Curve Number</h3>
 <p>Generated Curve Number Layer based on Land Cover and Soils.</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: ars.work.ce@gmail.com</p></body></html>"""
+<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: ar-siddiqui@outlook.com</p></body></html>"""
         )
 
     def createInstance(self):

…thms/global_esa_isric/esa_land_cover.qml …ithms/global_esa_ornl/esa_land_cover.qmlcurve_number_generator/processing/algorithms/global_esa_isric/esa_land_cover.qml renamed to curve_number_generator/processing/algorithms/global_esa_ornl/esa_land_cover.qml curve_number_generator/processing/algorithms/global_esa_isric/esa_land_cover.qml renamed to curve_number_generator/processing/algorithms/global_esa_ornl/esa_land_cover.qml

@@ -7,9 +7,9 @@
  This plugin generates a 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.
  Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
                               -------------------
-        begin                : 2022-07-22
-        copyright            : (C) 2022 by Abdul Raheem Siddiqui
-        email                : ars.work.ce@gmail.com
+        begin                : 2024-07-07
+        copyright            : (C) 2024 by Abdul Raheem Siddiqui
+        email                : ar-siddiqui@outlook.com
  ***************************************************************************/
 
 /***************************************************************************
@@ -38,13 +38,15 @@
 )
 from qgis.PyQt.QtGui import QIcon
 
-from curve_number_generator.processing.config import GLOBAL_ESA_ISRIC, PLUGIN_VERSION
+from curve_number_generator.processing.config import GLOBAL_ESA_ORNL, PLUGIN_VERSION
 from curve_number_generator.processing.curve_number_generator_algorithm import (
     CurveNumberGeneratorAlgorithm,
 )
 from curve_number_generator.processing.tools.curve_numper import CurveNumber
 from curve_number_generator.processing.tools.utils import (
     createDefaultLookup,
+    createRequestBBOXDim,
+    downloadFile,
     gdalPolygonize,
     gdalWarp,
     generate_cn_exprs,
@@ -66,7 +68,7 @@
 __revision__ = "$Format:%H$"
 
 
-class GlobalEsaIsric(CurveNumberGeneratorAlgorithm):
+class GlobalEsaORNL(CurveNumberGeneratorAlgorithm):
     # Constants used to refer to parameters and outputs. They will be
     # used when calling the algorithm from another algorithm, or when
     # calling from the QGIS console.
@@ -79,7 +81,7 @@ def initAlgorithm(self, config=None):
         self.hc = ["Poor", "Fair", "Good"]
         self.arc = ["I", "II", "III"]
         self.lc_pixel_size = 0.000083333333333
-        self.soils_pixel_size = 0.0026
+        self.soils_pixel_size = 0.00208333
 
         self.addParameter(
             QgsProcessingParameterVectorLayer(
@@ -133,7 +135,7 @@ def initAlgorithm(self, config=None):
         self.addParameter(
             QgsProcessingParameterRasterDestination(
                 "Soils",
-                "ISRIC Derived HSG",
+                "HSG",
                 optional=True,
                 createByDefault=False,
                 defaultValue=None,
@@ -161,7 +163,7 @@ def initAlgorithm(self, config=None):
     def processAlgorithm(self, parameters, context, model_feedback):
         # Use a multi-step feedback, so that individual child algorithm progress reports are adjusted for the
         # overall progress through the model
-        feedback = QgsProcessingMultiStepFeedback(6, model_feedback)
+        feedback = QgsProcessingMultiStepFeedback(7, model_feedback)
         results = {}
         outputs = {}
 
@@ -184,12 +186,13 @@ def processAlgorithm(self, parameters, context, model_feedback):
             extent[2] + 2 * self.lc_pixel_size,
             extent[3] + 2 * self.lc_pixel_size,
         )
-        extent_isric = (
+        extent_ornl = (
             extent[0] - 2 * self.soils_pixel_size,
             extent[1] - 2 * self.soils_pixel_size,
             extent[2] + 2 * self.soils_pixel_size,
             extent[3] + 2 * self.soils_pixel_size,
         )
+        bbox_dim_soil = createRequestBBOXDim(extent_ornl, self.soils_pixel_size)
 
         step = 1
         feedback.setCurrentStep(step)
@@ -250,67 +253,51 @@ def processAlgorithm(self, parameters, context, model_feedback):
             ]
         ):
 
+            if parameters.get("Soils", None):
+                try:
+                    parameters["Soils"].destinationName = "HSG"
+                except AttributeError:
+                    pass
+
+                soils_output = parameters["Soils"]
+            else:
+                soils_output = QgsProcessing.TEMPORARY_OUTPUT
+
+            outputs["DownloadedSoils"] = downloadFile(
+                GLOBAL_ESA_ORNL["ORNL_HYSOG"].format(
+                    bbox_dim_soil[0],
+                    bbox_dim_soil[1],
+                    ",".join([str(item) for item in extent_ornl]),
+                ),
+                "https://webmap.ornl.gov/ogcbroker/wcs",
+                "Error getting Hydorologic Soil Group data from 'https://webmap.ornl.gov/'. Most probably because either their server is down or there is a certification issue.\nThis should be temporary. Try again later.\n",
+                context=context,
+                feedback=feedback,
+            )
+
             alg_params = {
-                "DATA_TYPE": 0,
-                "EXTRA": "",
-                "INPUT": GLOBAL_ESA_ISRIC["ISRIC_CLAY"],
+                "INPUT": outputs["DownloadedSoils"],
+                "TARGET_CRS": None,
                 "NODATA": None,
+                "COPY_SUBDATASETS": False,
                 "OPTIONS": "",
-                "PROJWIN": f"{extent_isric[0]},{extent_isric[2]},{extent_isric[1]},{extent_isric[3]} [EPSG:4326]",
-                "OUTPUT": QgsProcessing.TEMPORARY_OUTPUT,
+                "EXTRA": "",
+                "DATA_TYPE": 0,
+                "OUTPUT": soils_output,
             }
-            outputs["IsricClay"] = processing.run(
-                "gdal:cliprasterbyextent",
-                alg_params,
-                context=context,
-                feedback=feedback,
-                is_child_algorithm=True,
-            )["OUTPUT"]
 
             step += 1
             feedback.setCurrentStep(step)
             if feedback.isCanceled():
                 return {}
 
-            # reproject to 4326
-            # the original CRS of of ISRIC raster is probalamtic and raster is disappearing in QGIS in that CRS
-            outputs["IsricClay4326"] = gdalWarp(
-                outputs["IsricClay"],
-                QgsCoordinateReferenceSystem("EPSG:4326"),
+            outputs["Soils"] = processing.run(
+                "gdal:translate",
+                alg_params,
                 context=context,
                 feedback=feedback,
-            )
-
-            step += 1
-            feedback.setCurrentStep(step)
-            if feedback.isCanceled():
-                return {}
-
-            input_dict = {
-                "input_a": outputs["IsricClay4326"],
-                "band_a": 1,
-            }
-            exprs = "((A== 0) * 0) + ((A >= 1) * (A <= 100) * 1) + ((A >= 100) * (A <= 200) * 2) + ((A > 200) *(A <= 400) * 3) + ((A > 400) * 4)"
-
-            if parameters.get("Soils", None):
-                try:
-                    parameters["Soils"].destinationName = "ISRIC Derived HSG"
-                except AttributeError:
-                    pass
-
-                soils_output = parameters["Soils"]
-            else:
-                soils_output = QgsProcessing.TEMPORARY_OUTPUT
-
-            outputs["Soils"] = perform_raster_math(
-                exprs,
-                input_dict,
-                context,
-                feedback,
-                output=soils_output,
-                no_data=255,
-                out_data_type=0,
-            )
+                is_child_algorithm=True,
+            )["OUTPUT"]
 
             step += 1
             feedback.setCurrentStep(step)
@@ -414,14 +401,14 @@ def name(self):
         lowercase alphanumeric characters only and no spaces or other
         formatting characters.
         """
-        return "globalesaisric"
+        return "globalesaornl"
 
     def displayName(self):
         """
         Returns the translated algorithm name, which should be used for any
         user-visible display of the algorithm name.
         """
-        return self.tr("Curve Number Generator (Global) (ESA & ISRIC)")
+        return self.tr("Curve Number Generator (Global) (ESA & ORNL)")
 
     def icon(self):
         icon = QIcon(os.path.join(cmd_folder, "icon.png"))
@@ -438,33 +425,34 @@ def shortHelpString(self):
             msg
             + f"""<html><body>
 <h2>Algorithm description</h2>
-<p>This algorithm generates a Curve Number layer for the given Area of Interest. It can also generate Hydrologic Soil Groups (HSG) raster from ISRIC clay dataset and download ESA Land Cover raster for the same area.
+<p>This algorithm generates a Curve Number layer for the given Area of Interest. It can also generate Hydrologic Soil Groups (HSG) raster from ORNL Hydrologic Soil Group dataset (HYSOGs250m) and download ESA Land Cover 2021 raster for the same area.
 
-For areas where the ISRIC dataset has no data such as urban areas, HSG D is assumed.</p>
+For areas where the ORNL dataset has no data such as permanent water bodies, HSG D is assumed.</p>
 <h2>Input parameters</h2>
 <h3>Area of Interest</h3>
-<p>Polygon layer representing an area of interest</p>
+<p>Polygon layer representing an area of interest.</p>
 <h3>Lookup Table [optional</h3>
-<p>Optional Table to relate ESA Land Cover Value and HSG Value to a particular curve number. By default the algorithm uses pre defined tables. The table must have two columns 'grid_code' and 'cn'. grid_code is a concatenation of ESA Land Cover code and Hydrologic Soil Group. <a href="https://raw.githubusercontent.com/ar-siddiqui/curve_number_generator/v{PLUGIN_VERSION}/curve_number_generator/processing/algorithms/global_esa_isric/lookups/default_lookup_f_ii.csv">Template csv file to create custom table</a>.</p>
+<p>Optional Table to relate ESA Land Cover Value and HSG Value to a particular curve number. By default the algorithm uses pre defined tables. The table must have two columns 'grid_code' and 'cn'. grid_code is a concatenation of ESA Land Cover code and Hydrologic Soil Group. <a href="https://raw.githubusercontent.com/ar-siddiqui/curve_number_generator/v{PLUGIN_VERSION}/curve_number_generator/processing/algorithms/global_esa_ornl/lookups/default_lookup_f_ii.csv">Template csv file to create custom table</a>.</p>
 <h3>Hydrologic Condition [Ignored when custom lookup table is provided]</h3>
 <p> Hydrologic condition is a parameter that represents combinations of factors that affect infiltration and runof. It can be Poor, Fair, or Good. (see <a href="https://directives.sc.egov.usda.gov/17758.wba">Table 9-1</a> for further description).
 
 If unsure, use the default fair hydrologic conidtion which is the most common case in hydrologic studies.
 <h3>Antecedent Runoff Condition [Ignored when custom lookup table is provided]</h3>
 <p> Antecedent Runoff Condition (ARC) is the relative wetness or dryness index for the soil. I for dry, II for average, and III for wet conditions. (see <a href="https://directives.sc.egov.usda.gov/17752.wba">Table 10-1</a> for further understanding)</p>
+
+If unsure, use the default ARC II which is the most common case in hydrologic studies.
 <h2>Outputs</h2>
 <h3>ESA World Cover</h3>
 <p>ESA Land Cover 2021 raster.</p>
-<h3>ISRIC Derived HSG</h3>
-<p>Hydrologic Soil Groups raster derived from the ISRIC clay dataset.
-
-Note: In dense urban areas, ISRIC soil raster has nodata cells, which are also reflected in the derived HSG raster.</p>
+<h3>HSG</h3>
+<p>ORNL Hydrologic Soil Groups (HYSOGs250m).</p>
 <h3>Curve Number</h3>
 <p>Generated Curve Number layer based on Land Cover and HSG values.</p>
 <h3>Curve Number (Vectorized)</h3>
 <p>Vector form of the generated Curve Number layer.</p>
-<br><p align="right">Algorithm author: Abdullah Azzam</p><p align="right">Help author: Abdullah Azzam</p><p align="right">Algorithm version: {PLUGIN_VERSION}</p><p align="right">Contact email: ars.work.ce@gmail.com</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>"""
+<br>
+<p align="right">Algorithm science author: Abdullah Azzam</p><p align="right">Code author: Abdul Raheem Siddiqui</p><p align="right">Help author: Abdullah Azzam</p><p align="right">Algorithm version: {PLUGIN_VERSION}</p><p align="right">Contact email: ar-siddiqui@outlook.com</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>"""
         )
 
     def createInstance(self):
-        return GlobalEsaIsric()
+        return GlobalEsaORNL()