ArcGIS TUFLOW Toolbar: Difference between revisions

Content deleted Content added
 
(7 intermediate revisions by 4 users not shown)
Line 1:
=Introduction=
A TUFLOW toolbar is available for ArcGIS Pro 3.04 and newer. This toolbar helps with streamlining the process of creating and editing a TUFLOW model in ArcGIS.
 
The ArcGIS toolbar can be downloaded from the TUFLOW website:
* [https://tuflow.com/downloads/#utilitiesgis_tools Download Link]
 
The download contains the .esriAddinX, a stand alone toolbar add-in to ArcGIS.
Line 23:
|-
|Start Model Build ||
1. [[#Configure_TUFLOWArcTUFLOW_Configure_TUFLOW | Configure TUFLOW (Required Initialization Step)]] <br>
2. [[#Create_TUFLOW_Folders | Create TUFLOW Folders]]
|-
Line 47:
==Configure TUFLOW==
[[File:ArcGIS Configure.png|thumb|right]]
The “Configure TUFLOW” tool creates a configuration file that will pre-populate items in other ArcTUFLOWArcGIS tools based on the map documentproject. The steps for running the configuration tool are outlined below:
* Open or savecreate a mapproject documentwith beforea runningmap.
* Select a TUFLOW Model folder for your model. This can be either the folder that contains the entire TUFLOW model folder structure or the folder that contains the TUFLOW subdirectories. For example, it can be either "D:\projects\Example\TUFLOW" or “D:\projects\Example\”. All of the following tools will use this location.
* Enter the file path to the TUFLOW executable.
Line 64:
The "Import Empty" tool can be used to import new SHP or GPKG files for editing.
* Ensure the Empty Directory location is correct.
* Select the desired Empty Type (e.g. 2d_code, 2d_bc). A list and description of available types can be found in Table 2-4 of the <u>[https://downloadsdocs.tuflow.com/TUFLOWclassic-hpc/Releasesmanual/Latestlatest/TUFLOW%20Manual.pdf 2018 TUFLOW Manual]</u>.
* Specify the run ID for the file. This will be added to the file name as a suffix.
*Select the object type (points, lines or regions).
Line 70:
The example shown in the image will create a new layer called "2d_code_M01_001_R.shp". This layer will be automatically saved into the '''TUFLOW\model\gis''' folder.
 
The ArcGIS toolbar requires configuring prior to using this tool. Refer to [[#Configure_TUFLOWArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] for more instructions. <br><br>
<br>
<br>
Line 80:
==Insert TUFLOW Attributes==
[[File:ArcGIS ImportAttributes.png|thumb|right]]
The "Insert TUFLOW Attributes" tool will insert a TUFLOW attribute template in front of an existing GIS layer. This is useful when transferring data from a database (e.g. councilGIS stormwater network) to TUFLOW format.
 
The steps are:
Line 87:
* Specify a run ID for the file. This will be added to the name as a suffix.
 
This tool is best used if [[#Configure_TUFLOWArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] has been run prior.
<br>
<br>
Line 95:
<br>
<br>
 
==Increment Layer==
[[File:ArcGIS_Increment.png|thumb|right]]
The tool "Increment Layer" will increment up one or more TUFLOW layers to a new revision number and replace hethe existing layer in ArcMAPArcGIS with the same style. Currently the limitation of the tool requires revision numbers to be 3 digits longs e.g. 001.
 
The steps are:
Line 124 ⟶ 125:
* Define the path to the TUFLOW executable
<br>
The ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to [[Configure_TUFLOWArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] for more instructions. <br><br>
<br>
<br>
Line 131 ⟶ 132:
==Load Simulation Input Files==
[[File:ArcGIS_Load.png|thumb|right]]
This tool loads all input shp files from a model simulation into athe common ArcGISactive Map window.<br>
<br>
The shp files will be loaded using a predefined symbology for common TUFLOW input file types. This is determined based on the prefix of the file name. For example, the symbology for 2d_code and 2d_zsh files are shown below.<br><br>
[[File:arcTUFLOW_Load_Simulation_File_Symbology.JPG|200px]]
<br><br>