Skip to content

Commit

Permalink
Merge pull request #116 from NOAA-OCM/features/gui_tweaks
Browse files Browse the repository at this point in the history 
Features/gui tweaks
  • Loading branch information
@NSPECT
NSPECT authored May 19, 2022
2 parents aa159c6 + 8356290 commit 70425f9
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 19 deletions.
21 changes: 12 additions & 9 deletions QNSPECT/processing/algorithms/run_analysis/run_erosion_analysis.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -626,15 +626,6 @@ def shortHelpString(self):
<h3>Run Name</h3>
<p>Name of the run. The algorithm will create a folder with this name and save all outputs and a configuration file in that folder.</p>
<h3>Elevation Raster</h3>
<p>Elevation raster for the area of interest. The CRS can be in any units, but the <span style="color: #ff9800">elevation must be in meters</span>. The algorithm uses elevation data to calculate ratios, flow direction, and flow accumulation throughout a watershed.</p>
<h3>Hydrologic Soils Group Raster</h3>
<p>Hydrologic Soil Group raster for the area of interest with following mapping {'A': 1, 'B': 2, 'C': 3, 'D':4, 'A/D':5, 'B/D':6, 'C/D':7, 'W':8, Null: 9}. The soil raster is used to generate runoff estimates using NRCS Curve Number method.</p>
<h3>K-factor Raster</h3>
<p>Soil erodibility raster for the area of interest. The K-factor is used in RUSLE equation.</p>
<h3>Land Cover Raster</h3>
<p>Land Cover/Classification raster for the area of interest. The algorithm uses Land Cover Raster and Lookup Table to determine each cell's erosion potential.</p>
Expand All @@ -645,6 +636,18 @@ def shortHelpString(self):
<p>Lookup table to relate each land cover class with Curve Number and C-Factor. The user can skip providing a lookup table if the land cover type is not custom; the algorithm will utilize the default lookup table for the land cover type selected in the previous option.</p>
<p>To create a custom lookup table, use `Create Lookup Table Template` tool. The table must contain all land cover classes available in the land cover raster.</p>
<h3>Elevation Raster</h3>
<p>Elevation raster for the area of interest. The CRS can be in any units, but the <span style="color: #ff9800">elevation must be in meters</span>. The algorithm uses elevation data to calculate ratios, flow direction, and flow accumulation throughout a watershed.</p>
<h3>R-Factor Raster</h3>
<p>The rainfall-runoff erosivity factor (R-factor) quantifies the effects of raindrop impacts and reflects the amount and rate of runoff associated with the rain. R-factor raster data for the coterminous United States and six of the main Hawaiian Islands are available from the NOAA Office for Coastal Management. For areas not covered by these data, a method to calculate R-factor is described in chapter 2 of the USDA Handbook Number 703 (Wischmeier and Smith, 1978)<a href="https://www.ars.usda.gov/ARSUserFiles/64080530/RUSLE/AH_703.pdf">PDF, 21.4 MB</a>.</p>
<h3>Hydrologic Soils Group Raster</h3>
<p>Hydrologic Soil Group raster for the area of interest with following mapping {'A': 1, 'B': 2, 'C': 3, 'D':4, 'A/D':5, 'B/D':6, 'C/D':7, 'W':8, Null: 9}. The soil raster is used to generate runoff estimates using NRCS Curve Number method.</p>
<h3>K-factor Raster</h3>
<p>Soil erodibility raster for the area of interest. The K-factor is used in RUSLE equation.</p>
<h2>Advanced Parameters</h2>
<!--h3 >Use Multi Flow Direction [MFD] Routing</h3-->
Expand Down
20 changes: 10 additions & 10 deletions QNSPECT/processing/algorithms/run_analysis/run_pollution_analysis.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -504,16 +504,6 @@ def shortHelpString(self):
<h2>Input Parameters</h2>
<h3>Run Name</h3>
<p>Name of the run. The algorithm will create a folder with this name and save all outputs and a configuration file in that folder.</p>
<h3>Elevation Raster</h3>
<p>Elevation raster for the area of interest. This can be in any elevation unit. The algorithm only uses elevation data to calculate flow direction and flow accumulation throughout a watershed. </p>
<h3>Soil Raster</h3>
<p>Hydrologic Soil Group raster for the area of interest with following mapping <code>{'A': 1, 'B': 2, 'C': 3, 'D':4, 'A/D':5, 'B/D':6, 'C/D':7, 'W':8, Null: 9}</code>. The soil raster is used to generate runoff estimates using NRCS Curve Number method.</p>
<h3>Precipitation Raster</h3>
<p>Precipitation amounts in inches or millimeters for the area of interest. The precipitation values are used to calculate access runoff.</p>
<h3>Precipitation Raster Units</h3>
<p>Units of the precipitation raster, inches or millimeters.</p>
<h3>Number of Raining Days</h3>
<p>This field indicates the average number of days rain occurs in one year in the area of interest. A raining day is defined as a day on which there was enough rain to produce runoff. A higher number of raining days reduces runoff volume by increasing total retention. A value of 1 raining day can be used to simulate runoff from a single event. </p>
<h3>Land Cover Raster</h3>
<p>Land Cover/Classification raster for the area of interest. The algorithm uses Land Cover Raster and Lookup Table to determine each cell's runoff and pollution potential.</p>
<h3>Land Cover Type</h3>
Expand All @@ -522,6 +512,16 @@ def shortHelpString(self):
<p>Lookup table to relate each land cover class with Curve Number and pollutant load. The user can skip providing a lookup table if the land cover
type is not custom; the algorithm will utilize the default lookup table for the land cover type selected in the previous option.
To create a custom lookup table, use `Create Lookup Table Template` tool. The table must contain all land cover classes available in the land cover raster and all pollutants that have Output = Y in the `Pollutant Outputs` parameter.</p>
<h3>Elevation Raster</h3>
<p>Elevation raster for the area of interest. This can be in any elevation unit. The algorithm only uses elevation data to calculate flow direction and flow accumulation throughout a watershed. </p>
<h3>Precipitation Raster</h3>
<p>Precipitation amounts in inches or millimeters for the area of interest. The precipitation values are used to calculate access runoff.</p>
<h3>Precipitation Raster Units</h3>
<p>Units of the precipitation raster, inches or millimeters.</p>
<h3>Number of Raining Days</h3>
<p>This field indicates the average number of days rain occurs in one year in the area of interest. A raining day is defined as a day on which there was enough rain to produce runoff. A higher number of raining days reduces runoff volume by increasing total retention. A value of 1 raining day can be used to simulate runoff from a single event. </p>
<h3>Soil Raster</h3>
<p>Hydrologic Soil Group raster for the area of interest with following mapping <code>{'A': 1, 'B': 2, 'C': 3, 'D':4, 'A/D':5, 'B/D':6, 'C/D':7, 'W':8, Null: 9}</code>. The soil raster is used to generate runoff estimates using NRCS Curve Number method.</p>
<h3>Pollutant Outputs</h3>
<p>In addition to the runoff, the algorithm will output the following rasters for each pollutant added here with Output column as Y:
- Local (per cell) pollutant load [mg]
Expand Down

0 comments on commit 70425f9

Please sign in to comment.