latest build

Author: gassc

docs/docs/install.md

@@ -17,7 +17,7 @@ Once you've done this, close ArcGIS Pro.
 
 ## 2. Download the Culvert Analysis Toolkit installation file
 
-Download the latest install "wheel" [here](releases/culvert_toolkit-0.1.7-py3-none-any.whl).
+Download the latest install "wheel" [here](releases/culvert_toolkit-0.2.0-py3-none-any.whl).
 
 <!-- Head to the [Releases page (github.com/civicmapper/culvert-toolkit/releases)](https://github.com/civicmapper/culvert-toolkit/releases) and download the `.whl` file from the latest version of the tool. -->
 

docs/docs/releases/culvert_toolkit-0.2.0-py3-none-any.whl

@@ -1,2 +1,2 @@
 <?xml version="1.0"?>
-<metadata xml:lang="en"><Esri><CreaDate>20221108</CreaDate><CreaTime>17180900</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20230227</ModDate><ModTime>213957</ModTime><scaleRange><minScale>150000000</minScale><maxScale>5000</maxScale></scaleRange><ArcGISProfile>ItemDescription</ArcGISProfile></Esri><tool name="CulvertCapacityPytTool" displayname="NAACC Culvert Capacity" toolboxalias="CulvertToolkit" xmlns=""><arcToolboxHelpPath>c:\program files\arcgis\pro\Resources\Help\gp</arcToolboxHelpPath><parameters><param name="points_filepath" displayname="Culvert Points" type="Required" direction="Input" datatype="Feature Layer" expression="points_filepath"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Points feature class compliant with the NAACC schema. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Use the NAACC Table Ingest tool to generate this data from NAACC downloads.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="raster_flowdir_filepath" displayname="Flow Direction" type="Required" direction="Input" datatype="Raster Layer" expression="raster_flowdir_filepath"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Flow direction raster, derived from hydrologically corrected DEM&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="raster_flowlen_filepath" displayname="Flow Length" type="Optional" direction="Input" datatype="Raster Layer" expression="{raster_flowlen_filepath}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Flow length raster, derived from hydrologically corrected DEM&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="raster_slope_filepath" displayname="Slope" type="Required" direction="Input" datatype="Raster Layer" expression="raster_slope_filepath"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Slope raster, derived from hydrologically corrected DEM. &lt;/SPAN&gt;&lt;SPAN STYLE="font-weight:bold;"&gt;Must be percent slope&lt;/SPAN&gt;&lt;SPAN&gt;.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="raster_curvenumber_filepath" displayname="Curve Number" type="Required" direction="Input" datatype="Raster Layer" expression="raster_curvenumber_filepath"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Curve Number raster, representing curve numbers calculated according the the &lt;/SPAN&gt;&lt;A href="https://civicmapper.github.io:443/culvert-toolkit/assets/Urban-Hydrology-for-Small-Watersheds-TR-55.pdf" target="_blank" STYLE="text-decoration:underline;"&gt;&lt;SPAN&gt;TR-55 method&lt;/SPAN&gt;&lt;/A&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="precip_src_config_filepath" displayname="Precipitation Configuration File" type="Required" direction="Input" datatype="File" expression="precip_src_config_filepath"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;A Culvert-Toolkit precipitation data source configuration JSON file. Create this file by running the NOAA Rainfall Raster Data Download tool.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="output_points_filepath" displayname="Result Points" type="Required" direction="Output" datatype="Feature Class" expression="output_points_filepath"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Output point feature class, which will include all submitted culverts (even those that aren't valid), with calculated capacity and peak-flow/runoff estimates as a field, per record. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;An accompanying polygon feature class containing the delineated watersheds of the culverts will be saved along with the point feature. It's name will be based on the name of the point feature class, suffixed with &lt;/SPAN&gt;&lt;SPAN STYLE="font-style:italic;"&gt;"_sheds".&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param></parameters><summary>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Measure the capacity of culverts by calculating peak flow over a hydrologically corrected digital elevation model. Culvert location data must be NAACC schema-compliant and processed through the &lt;/SPAN&gt;&lt;SPAN STYLE="font-weight:bold;"&gt;NAACC Table Ingest &lt;/SPAN&gt;&lt;SPAN&gt;tool.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</summary><usage>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Measure the capacity of culverts by calculating peak flow over a hydrologically corrected digital elevation model. Culvert location data must be NAACC schema-compliant and processed through the &lt;/SPAN&gt;&lt;SPAN STYLE="font-weight:bold;"&gt;NAACC Table Ingest &lt;/SPAN&gt;&lt;SPAN&gt;tool.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</usage></tool><dataIdInfo><idCitation><resTitle>NAACC Culvert Capacity</resTitle></idCitation><idCredit>Cornell Soil &amp; Water Lab, GroundPoint Engineering, CivicMapper</idCredit><searchKeys><keyword>culvert</keyword><keyword>stormwater</keyword><keyword>analysis</keyword><keyword>tr-55</keyword><keyword>peak-flow</keyword><keyword>capacity</keyword><keyword>run-off</keyword></searchKeys></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Tool</formatName></distorFormat></distributor></distInfo><mdHrLv><ScopeCd value="005"/></mdHrLv><mdDateSt Sync="TRUE">20230224</mdDateSt></metadata>
+<metadata xml:lang="en"><Esri><CreaDate>20221108</CreaDate><CreaTime>17180900</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20230321</ModDate><ModTime>150334</ModTime><scaleRange><minScale>150000000</minScale><maxScale>5000</maxScale></scaleRange><ArcGISProfile>ItemDescription</ArcGISProfile></Esri><tool name="CulvertCapacityPytTool" displayname="NAACC Culvert Capacity" toolboxalias="CulvertToolkit" xmlns=""><arcToolboxHelpPath>c:\program files\arcgis\pro\Resources\Help\gp</arcToolboxHelpPath><parameters><param name="points_filepath" displayname="Culvert Points" type="Required" direction="Input" datatype="Feature Layer" expression="points_filepath"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Points feature class compliant with the NAACC schema. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Use the NAACC Table Ingest tool to generate this data from NAACC downloads.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="raster_flowdir_filepath" displayname="Flow Direction" type="Required" direction="Input" datatype="Raster Layer" expression="raster_flowdir_filepath"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Flow direction raster, derived from hydrologically corrected DEM&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="raster_flowlen_filepath" displayname="Flow Length" type="Optional" direction="Input" datatype="Raster Layer" expression="{raster_flowlen_filepath}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Flow length raster, derived from hydrologically corrected DEM&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="raster_slope_filepath" displayname="Slope" type="Required" direction="Input" datatype="Raster Layer" expression="raster_slope_filepath"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Slope raster, derived from hydrologically corrected DEM. &lt;/SPAN&gt;&lt;SPAN STYLE="font-weight:bold;"&gt;Must be percent slope&lt;/SPAN&gt;&lt;SPAN&gt;.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="raster_curvenumber_filepath" displayname="Curve Number" type="Required" direction="Input" datatype="Raster Layer" expression="raster_curvenumber_filepath"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Curve Number raster, representing curve numbers calculated according the the &lt;/SPAN&gt;&lt;A href="https://civicmapper.github.io:443/culvert-toolkit/assets/Urban-Hydrology-for-Small-Watersheds-TR-55.pdf" target="_blank" STYLE="text-decoration:underline;"&gt;&lt;SPAN&gt;TR-55 method&lt;/SPAN&gt;&lt;/A&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="precip_src_config_filepath" displayname="Precipitation Configuration File" type="Required" direction="Input" datatype="File" expression="precip_src_config_filepath"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;A Culvert-Toolkit precipitation data source configuration JSON file. Create this file by running the NOAA Rainfall Raster Data Download tool.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="output_points_filepath" displayname="Result Points" type="Required" direction="Output" datatype="Feature Class" expression="output_points_filepath"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Output point feature class, which will include all submitted culverts (even those that aren't valid), with calculated capacity and peak-flow/runoff estimates as a field, per record. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;An accompanying polygon feature class containing the delineated watersheds of the culverts will be saved along with the point feature. It's name will be based on the name of the point feature class, suffixed with &lt;/SPAN&gt;&lt;SPAN STYLE="font-style:italic;"&gt;"_sheds".&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param></parameters><summary>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Measure the capacity of culverts by calculating peak flow over a hydrologically corrected digital elevation model. Culvert location data must be NAACC schema-compliant and processed through the &lt;/SPAN&gt;&lt;SPAN STYLE="font-weight:bold;"&gt;NAACC Table Ingest &lt;/SPAN&gt;&lt;SPAN&gt;tool.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</summary><usage>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Measure the capacity of culverts by calculating peak flow over a hydrologically corrected digital elevation model. Culvert location data must be NAACC schema-compliant and processed through the &lt;/SPAN&gt;&lt;SPAN STYLE="font-weight:bold;"&gt;NAACC Table Ingest &lt;/SPAN&gt;&lt;SPAN&gt;tool.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</usage></tool><dataIdInfo><idCitation><resTitle>NAACC Culvert Capacity</resTitle></idCitation><idCredit>Cornell Soil &amp; Water Lab, GroundPoint Engineering, CivicMapper</idCredit><searchKeys><keyword>culvert</keyword><keyword>stormwater</keyword><keyword>analysis</keyword><keyword>tr-55</keyword><keyword>peak-flow</keyword><keyword>capacity</keyword><keyword>run-off</keyword></searchKeys></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Tool</formatName></distorFormat></distributor></distInfo><mdHrLv><ScopeCd value="005"/></mdHrLv><mdDateSt Sync="TRUE">20230224</mdDateSt></metadata>

src/drainit/esri/help/gp/CulvertCapacityPytTool_CulvertToolkit.xml

@@ -5,8 +5,8 @@
 		<CreaTime>17180900</CreaTime>
 		<ArcGISFormat>1.0</ArcGISFormat>
 		<SyncOnce>TRUE</SyncOnce>
-		<ModDate>20230227</ModDate>
-		<ModTime>213956</ModTime>
+		<ModDate>20230321</ModDate>
+		<ModTime>150334</ModTime>
 		<scaleRange>
 			<minScale>625000</minScale>
 			<maxScale>50000</maxScale>

src/drainit/esri/help/gp/CulvertToolkit_toolbox.xml

@@ -1,2 +1,2 @@
 <?xml version="1.0"?>
-<metadata xml:lang="en"><Esri><CreaDate>20221111</CreaDate><CreaTime>12175500</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20230227</ModDate><ModTime>213957</ModTime><scaleRange><minScale>150000000</minScale><maxScale>5000</maxScale></scaleRange><ArcGISProfile>ItemDescription</ArcGISProfile></Esri><tool name="NaaccEtlPytTool" displayname="NAACC Table Ingest" toolboxalias="CulvertToolkit" xmlns=""><arcToolboxHelpPath>c:\program files\arcgis\pro\Resources\Help\gp</arcToolboxHelpPath><parameters><param name="naacc_src_table" displayname="NAACC Table (CSV or Feature Class)" type="Required" direction="Input" datatype="File or Feature Class" expression="naacc_src_table"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Path to CSV, SHP, or FGDB feature class containing data with a NAACC-compliant schema.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="output_fc" displayname="Output Feature Class" type="Required" direction="Output" datatype="Feature Class" expression="output_fc"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Path in a geodatabase to save the new, ready-to-use feature class&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param></parameters><summary>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Read in, validate, and extend a NAACC-compliant source table, saving the output as geodata (e.g., a file geodatabase feature class) for use in other culvert analysis tools.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</summary><usage>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Read in, validate, and extend a NAACC-compliant source table, saving the output as geodata (e.g., a file geodatabase feature class) for use in other culvert analysis tools.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</usage></tool><dataIdInfo><idCitation><resTitle>NAACC Table Ingest</resTitle></idCitation><searchKeys><keyword>NAACC</keyword><keyword>culverts</keyword><keyword>ETL</keyword><keyword>features</keyword><keyword>conversion</keyword><keyword>validation</keyword><keyword>extract-transform-load</keyword></searchKeys></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Tool</formatName></distorFormat></distributor></distInfo><mdHrLv><ScopeCd value="005"/></mdHrLv><mdDateSt Sync="TRUE">20230224</mdDateSt></metadata>
+<metadata xml:lang="en"><Esri><CreaDate>20221111</CreaDate><CreaTime>12175500</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20230321</ModDate><ModTime>150334</ModTime><scaleRange><minScale>150000000</minScale><maxScale>5000</maxScale></scaleRange><ArcGISProfile>ItemDescription</ArcGISProfile></Esri><tool name="NaaccEtlPytTool" displayname="NAACC Table Ingest" toolboxalias="CulvertToolkit" xmlns=""><arcToolboxHelpPath>c:\program files\arcgis\pro\Resources\Help\gp</arcToolboxHelpPath><parameters><param name="naacc_src_table" displayname="NAACC Table (CSV or Feature Class)" type="Required" direction="Input" datatype="File or Feature Class" expression="naacc_src_table"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Path to CSV, SHP, or FGDB feature class containing data with a NAACC-compliant schema.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="output_fc" displayname="Output Feature Class" type="Required" direction="Output" datatype="Feature Class" expression="output_fc"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Path in a geodatabase to save the new, ready-to-use feature class&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param></parameters><summary>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Read in, validate, and extend a NAACC-compliant source table, saving the output as geodata (e.g., a file geodatabase feature class) for use in other culvert analysis tools.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</summary><usage>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Read in, validate, and extend a NAACC-compliant source table, saving the output as geodata (e.g., a file geodatabase feature class) for use in other culvert analysis tools.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</usage></tool><dataIdInfo><idCitation><resTitle>NAACC Table Ingest</resTitle></idCitation><searchKeys><keyword>NAACC</keyword><keyword>culverts</keyword><keyword>ETL</keyword><keyword>features</keyword><keyword>conversion</keyword><keyword>validation</keyword><keyword>extract-transform-load</keyword></searchKeys></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Tool</formatName></distorFormat></distributor></distInfo><mdHrLv><ScopeCd value="005"/></mdHrLv><mdDateSt Sync="TRUE">20230224</mdDateSt></metadata>