Merge pull request #118 from NOAA-OCM/URL_updates

Url updates
NOAA-OCM · May 31, 2022 · 53e20a0 · 53e20a0
2 parents c7a5f07 + b40bf42
commit 53e20a0
Show file tree

Hide file tree

Showing 12 changed files with 22 additions and 17 deletions.
diff --git a/QNSPECT/metadata.txt b/QNSPECT/metadata.txt
@@ -6,11 +6,12 @@
 name=QNSPECT
 qgisMinimumVersion=3.16
 description=QGIS Plugin for NOAA Nonpoint Source Pollution and Erosion Comparison Tool (NSPECT)
-version=0.0.1
+version=1.0
 author=NOAA
 email=ocm dot nspect dot admins at noaa dot gov
 
-about=QNSPECT is the QGIS implementation of NOAA Office for Coastal Management (OCM) Nonpoint-Source Pollution and Erosion Comparison Tool (NSPECT). NSPECT is a screening tool designed to allow users to estimate initial baseline pollution and erosion over an area and then compare how those values would change under a different land-use or management scenario. A user must have GRASS installed in QGIS to be able to use certain modules of the QNSPECT.
+about=QNSPECT is the QGIS implementation of the NOAA Office for Coastal Management's (OCM) previous Nonpoint-Source Pollution and Erosion Comparison Tool (NSPECT). QNSPECT is a screening tool designed to allow users to estimate initial baseline pollution and erosion over an area and then compare how those values would change under a different land-use or management scenario. A user must have GRASS installed in QGIS to be able to use certain modules of the QNSPECT. Information  and resources for using QNSPECT can be found on the NOAA Office for Coastal Management Digital Coast <a href="https://coast.noaa.gov/digitalcoast/tools/qnspect.html">QNSPECT Landing Page</a>.  See the help and technical guide for an <a href="https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#Workflow">overview of the typical QNSPECT workflow</a> and a list of <a href="https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#References">references</a>.
+
 
 tracker=https://github.com/NOAA-OCM/QNSPECT/issues
 repository=https://github.com/NOAA-OCM/QNSPECT
@@ -23,21 +24,21 @@ hasProcessingProvider=yes
 # changelog=
 
 # Tags are comma separated with spaces allowed
-tags=analysis, ecology, flood, flow, processing, erosion, pollution, environment, scenario, RUSLE, nonpoint, non-point, python, NSPECT, source, comparison, screening
+tags=analysis, ecology, flood, flow, processing, erosion, pollution, environment, scenario, RUSLE, nonpoint, non-point, python, QNSPECT, source, comparison, screening
 
-homepage=https://github.com/NOAA-OCM/QNSPECT
+homepage=https://coast.noaa.gov/digitalcoast/tools/qnspect.html
 category=Analysis
 icon=resources/branding/icon.svg
 # experimental flag
-experimental=True
+experimental=False
 
 # deprecated flag (applies to the whole plugin, not just a single version)
 deprecated=False
 
 # Since QGIS 3.8, a comma separated list of plugins to be installed
 # (or upgraded) can be specified.
 # Check the documentation for more information.
-# plugin_dependencies=
+# plugin_dependencies=GRASS
 
 Category of the plugin: Raster, Vector, Database or Web
 # category=

diff --git a/QNSPECT/processing/algorithms/align_rasters/align_rasters.py b/QNSPECT/processing/algorithms/align_rasters/align_rasters.py
@@ -374,7 +374,7 @@ def groupId(self):
 
     def shortHelpString(self):
         return """<html><body>
-<h2>Algorithm description</h2>
+<a href="https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#Align_Rasters">Documentation</a><h2>Algorithm description</h2>
 <p>The algorithm aligns one or more rasters to a reference raster. The aligned rasters will adopt the CRS, cell size, and origin of the reference raster. The aligned rasters will be saved as TIFF files.</p>
 <h2>Input parameters</h2>
 <h3>Reference Raster</h3>

diff --git a/QNSPECT/processing/algorithms/compare_scenarios/compare_erosion.py b/QNSPECT/processing/algorithms/compare_scenarios/compare_erosion.py
@@ -186,7 +186,7 @@ def compare_outputs(
 
     def shortHelpString(self):
         return """<html><body>
-<a href="https://www.noaa.gov/">Documentation</a>
+<a href="https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#Compare_Scenarios_Erosion">Documentation</a>
 
 <h2>Algorithm Description</h2>
 

diff --git a/QNSPECT/processing/algorithms/compare_scenarios/compare_pollution.py b/QNSPECT/processing/algorithms/compare_scenarios/compare_pollution.py
@@ -267,7 +267,7 @@ def createInstance(self):
 
     def shortHelpString(self):
         return """<html><body>
-<a href="https://www.noaa.gov/">Documentation</a>
+<a href="https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#Compare_Scenarios_Pollution">Documentation</a>
 
 <h2>Algorithm Description</h2>
 

diff --git a/QNSPECT/processing/algorithms/create_lookup_table_template/create_lookup_table_template.py b/QNSPECT/processing/algorithms/create_lookup_table_template/create_lookup_table_template.py
@@ -120,7 +120,9 @@ def groupId(self):
         return "data_preparation"
 
     def shortHelpString(self):
-        return """<html><body><h2>Algorithm description</h2>
+        return """<html><body>
+        https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#Create_Lookup_Table
+        <h2>Algorithm description</h2>
 <p>This algorithm creates a copy of the land characteristics packaged with QNSPECT. The spreadsheet output will have the necessary fields needed for running the pollution and erosion analysis tools. The intent of this tool is to create a copy that can be edited to include any custom land cover types and coefficients necessary for your analysis.</p>
 <h2>Input parameters</h2>
 <h3>Land Cover Type</h3>

diff --git a/QNSPECT/processing/algorithms/load_run/load_run.py b/QNSPECT/processing/algorithms/load_run/load_run.py
@@ -94,7 +94,7 @@ def createInstance(self):
 
     def shortHelpString(self):
         return """<html><body>
-<a href="https://www.noaa.gov/">Documentation</a>
+<a href="https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#Load_Previous_Run">Documentation</a>
 
 <h2>Algorithm Description</h2>
 

diff --git a/QNSPECT/processing/algorithms/modify_land_cover/modify_land_cover_by_field.py b/QNSPECT/processing/algorithms/modify_land_cover/modify_land_cover_by_field.py
@@ -141,7 +141,7 @@ def createInstance(self):
 
     def shortHelpString(self):
         return """<html><body>
-<a href="https://www.noaa.gov/">Documentation</a>
+<a href="https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#Modify_Land_Cover_vector">Documentation</a>
 
 <h2>Algorithm Description</h2>
 

diff --git a/QNSPECT/processing/algorithms/modify_land_cover/modify_land_cover_by_name.py b/QNSPECT/processing/algorithms/modify_land_cover/modify_land_cover_by_name.py
@@ -167,7 +167,7 @@ def createInstance(self):
 
     def shortHelpString(self):
         return """<html><body>
-<a href="https://www.noaa.gov/">Documentation</a>
+<a href="https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#Modify_Land_Cover_custom">Documentation</a>
 
 <h2>Algorithm Description</h2>
 

diff --git a/QNSPECT/processing/algorithms/modify_land_cover/modify_land_cover_by_nlcdccap.py b/QNSPECT/processing/algorithms/modify_land_cover/modify_land_cover_by_nlcdccap.py
@@ -157,7 +157,7 @@ def createInstance(self):
 
     def shortHelpString(self):
         return """<html><body>
-<a href="https://www.noaa.gov/">Documentation</a>
+<a href="https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#Modify_Land_Cover_NLCD_CCAP">Documentation</a>
 
 <h2>Algorithm Description</h2>
 

diff --git a/QNSPECT/processing/algorithms/rasterize_soil/rasterize_soil.py b/QNSPECT/processing/algorithms/rasterize_soil/rasterize_soil.py
@@ -225,7 +225,9 @@ def groupId(self):
         return "data_preparation"
 
     def shortHelpString(self):
-        return """<html><body><h2>Algorithm description</h2>
+        return """<html><body>
+        https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#Rasterize_Soil
+        <h2>Algorithm description</h2>
 <p>The algorithm converts a vector polygon layer into Hydrologic Soul Group and/or K-Factor rasters. The value of the raster pixels is determined by the vector layer's attributes.</p>
 <p>Two soil parameters are needed: the hydrologic soils group, which is a measure of how permeable the soils are; and the K-factor, which is a measure of how erodible the soils are.</p>
 <h2>Input parameters</h2>

diff --git a/QNSPECT/processing/algorithms/run_analysis/run_erosion_analysis.py b/QNSPECT/processing/algorithms/run_analysis/run_erosion_analysis.py
@@ -616,7 +616,7 @@ def create_ls_factor(self, parameters, context):
 
     def shortHelpString(self):
         return """<html><body>
-<a href="https://www.noaa.gov/">Documentation</a>
+<a href="https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#Run_Erosion_Analysis">Documentation</a>
 <h2>Algorithm Description</h2>
 <p>The `Run Erosion Analysis` algorithm estimates annual erosion volume for a given area on per cell and accumulated basis. The volume is calculated using RUSLE and Sediment Delivery Ratio models (see the QNSPECT Technical documentation for details).</p>
 <p>The user must provide Elevation, Land Cover, Hydrologic Soil Group, K-Factor, and R-Factor rasters for the area of interest. The user is also optionally required to provide a lookup table that relates different land cover classes in the provided Land Cover raster with Curve Number and C-Factor values.</p>

diff --git a/QNSPECT/processing/algorithms/run_analysis/run_pollution_analysis.py b/QNSPECT/processing/algorithms/run_analysis/run_pollution_analysis.py
@@ -495,7 +495,7 @@ def displayName(self):
 
     def shortHelpString(self):
         return """<html><body>
-<a href="https://www.noaa.gov/">Documentation</a>
+<a href="https://coast.noaa.gov/data/digitalcoast/pdf/qnspect-help-and-technical-guide.pdf#Run_Pollution_Analysis">Documentation</a>
 <h2>Algorithm Description</h2>
 <p>The `Run Pollution Analysis` algorithm estimates annual runoff volume and pollutant loading for a given area on per cell and accumulated bases. The Runoff Volume is calculated using the NRCS Curve Number method, while pollution loading is calculated using Land Cover as a proxy.</p>
 The user must provide Elevation, Land Cover, Soil, and Precipitation rasters for the area of interest. The user is also optionally required to provide a lookup table that relates different land cover classes in the provided Land Cover raster with Curve Number and pollutant loading.