ArcGIS TUFLOW Toolbar: Difference between revisions

Content deleted Content added
 
(18 intermediate revisions by 4 users not shown)
Line 1:
<font color="red"><font size = 18>Page Under Construction</font><font color="black"><br>
 
=Introduction=
A TUFLOW toolbar is available for ArcGIS XXPro 3.4 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 containcontains the .esriAddinX, a stand alone toolbar add-in to ArcGIS.
 
=Installation=
For instructions on how to install the ArcGIS Toolbar please see the following link:
* [[TUFLOW_ArcGIS_Toolbar_InstallationTUFLOW_ArcGIS_Toolbox_and_Toolbar_Installation#ArcTUFLOW_Toolbar | How to install ArcTUFLOW Toolbox and Toolbar]]<br><br>
 
=The Utilities: What are they and How to use them=
Line 24 ⟶ 22:
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Utilities
|-
|Start Model Build || 1. [[#Configure_TUFLOW | Configure TUFLOW (Required Initialization Step)]]
21. [[#Create_TUFLOW_Folders ArcTUFLOW_Configure_TUFLOW | CreateConfigure TUFLOW Folders(Required Initialization Step)]] <br>
2. [[#Create_TUFLOW_Folders | Create TUFLOW Folders]]
|-
|Model Build and Development || 3. [[#Import_Empty_(template)_TUFLOW_Files| Import Empty (template) TUFLOW Files]]<br>
3. [[#Import_Empty_(template)_TUFLOW_Files| Import Empty (template) TUFLOW Files]]<br>
4. [[#Insert_TUFLOW_Attributes | Insert TUFLOW Attributes]]<br>
5. [[#Increment_Layer | Increment Layer]]<br>
6. [[#Style_All_TUFLOW_Layers | Style All TUFLOW Layers]] <br>
7. [[#Style_Selected_TUFLOW_Layers | Style Selected TUFLOW Layers]] <br>
|-
|Running TUFLOW || 8. [[#Run_TUFLOW_Simulation | Run TUFLOW Simulation]]<br>
8. [[#Run_TUFLOW_Simulation | Run TUFLOW Simulation]]<br>
|-
|Loading and Viewing Results || 9. [[#Load_Simulation_Input_Files | Load Simulation Input Files]]<br>
9. [[#Load_Simulation_Input_Files | Load Simulation Input Files]]<br>
10. [[#Label_Selected_Layer | Label Selected Layer]] <br>
11. [[#Apply GPKG Layer Names | Apply GPKG Layer Names]]<br>
Line 45 ⟶ 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 62 ⟶ 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).
<br>
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 ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to [[#Configure_TUFLOW | Configure TUFLOW]] for more instructions. <br><br>
 
The ArcTUFLOWArcGIS toolboxtoolbar requires configuring prior to using this tool. Refer to [[#Configure_TUFLOWArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] for more instructions. <br><br>
<br>
<br>
<br>
Line 73 ⟶ 78:
<br>
<br>
 
==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 83 ⟶ 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>
<br>
<br>
<br>
<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:
* Select the "Source Layer" - the desired TUFLOW layer to be incremented (these can be dragged and dropped from the TOC into the tool window).
* Select the "Output Folder" - the desired folder for incremented layer to be saved.
* Specify the "Output Name" - new revision number.
* Choose to supersede the old layers (these will be placed in a 'SS' folder in the same directory as the model layer).
* Choose to append revision number if none already exists
* Choose whether to keep the source layer open.
<br>
<br>
<br>
<br>
<br>
 
==Style All TUFLOW Layers==
Line 104 ⟶ 121:
 
==Run TUFLOW Simulation==
[[File:ArcGIS_RunArcGIS_Run_v2.png|400px|thumb|right]]
* Enter the simulation tcf reference
* 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>
<br>
<br>
==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>
The user has the option of which files to import from the simulation.
<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>