View source for ArcGIS TUFLOW Toolbar

<font color="red"><font size = 18>Page Under Construction</font><font color="black"><br>

=Introduction=
A TUFLOW toolbar is available for ArcGIS XX 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/#utilities Download Link]

The download contain 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_Installation | How to install ArcTUFLOW Toolbox and Toolbar]]<br><br>

=The Utilities: What are they and How to use them=

The ArcTUFLOW Tools are intended to help the user with model initiation, setup and development, running, and checking and viewing results:

[[File:ArcGIS Toolbar.png]]<br>

{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;" width=2% | Model Stage
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Utilities
|-
|Start Model Build || 1. [[#Configure_TUFLOW | Configure TUFLOW (Required Initialization Step)]] 
2. [[#Create_TUFLOW_Folders  | Create TUFLOW Folders]]<br>
|-
|Model Build and Development || 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>
|-
|Loading and Viewing Results || 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>
12. [[#TUPLOT | TUPLOT]] 
|-
|Miscellaneous || 13. [[#About | About]]
|}<br>

==Configure TUFLOW==
[[File:ArcGIS Configure.png|thumb|right]]
The “Configure TUFLOW” tool creates a configuration file that will pre-populate items in other ArcTUFLOW tools based on the map document. The steps for running the configuration tool are outlined below:
* Open or save a map document before running. 
* 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.
* Select the projection for the TUFLOW model. <br>
* If the "Create Folder Structure" check-box is enabled when the tool is run, the standard TUFLOW folder structure is created. A projection layer is saved inside the '''TUFLOW\model\gis''' folder and a simple TUFLOW control file (.tcf) is created. This .tcf file is in the '''TUFLOW\runs''' folder and is named Create_Empties.tcf.
*If the "Create Template Files" check-box is enabled a TUFLOW simulation is started with the Create_Empties.tcf as in the input file. This simulation creates a series of template files in the '''TUFLOW\model\gis\empty''' folder. All of these template files have projection (CRS) as defined and have the correct GIS attributes for use in TUFLOW modelling. This can be brought into ArcGIS using the [[#Import Empty (template) TUFLOW Files | Import Empty]] tool.
* If the "Tutorial Model" check-box is enabled, the Create_Empties.tcf will run with the "Tutorial Model == ON" command. 
* Select the default GIS format used in the TUFLOW model. If creating empty files, the empty files will be output in this format along with the projection file. The GPKG format is compatible with the TUFLOW 2023-03 Release or later.




==Import Empty (template) TUFLOW Files==
[[File:ArcGIS ImportEmpty.png|thumb|right]]
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 [[https://downloads.tuflow.com/TUFLOW/Releases/Latest/TUFLOW%20Manual.pdf 2018 TUFLOW Manual]]. 
* 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 ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to [[#Configure_TUFLOW | Configure TUFLOW]] for more instructions. <br><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. council stormwater network) to TUFLOW format.

The steps are:
* Select the input file (the file to have TUFLOW attributes inserted into).
* Select the TUFLOW file format.
* Specify a run ID for the file. This will be added to the name as a suffix.

This tool is best used if [[#Configure_TUFLOW | Configure TUFLOW]] has been run prior.



==Increment Layer==
[[File:ArcGIS_Imcrement.png|thumb|right]]
The tool "Increment Layer" will increment up one or more TUFLOW layers to a new revision number and replace he existing layer in ArcMAP 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 desired TUFLOW layer to be incremented (these can be dragged and dropped from the TOC into the tool window)
* Specify the 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



==Style All TUFLOW Layers==

This button will apply TUFLOW stylings onto all TUFLOW related layers in the TOC.

==Style Selected TUFLOW Layers==

This button will apply TUFLOW stylings to the selected layer in the TOC.

==Run TUFLOW Simulation==
[[File:ArcGIS_Run.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_TUFLOW | Configure TUFLOW]] for more instructions. <br><br>

==Load Simulation Input Files==
[[File:ArcGIS_Load.png|thumb|right]]
This tool loads all input shp files from a model simulation into a common ArcGIS 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>
This tool is courtesy of Wood Rodgers, Inc.  (www.woodrodgers.com)

==Label Selected Layer==

This tool will auto label the selected layer in the TOC. If the selected layer is a TUFLOW layer (e.g. 1d_nwk) the tool will automatically apply an expression, displaying useful information about the layer. It can also be used on non-TUFLOW layers, however will only label the first attribute. The user also has the option of changing the label colour from the adjacent drop down box (default is black if no colour is selected).

This tool is useful for reviewing models as well as building.

==Apply GPKG Layer Names==
This tool will change the layer name to be the same as the layer name within the GPKG database to every open GPKG layer in the workspace. This tool is useful as sometimes when GPKG layers are opened in ArcGIS (depending on how they are opened) they will contain both the database name and layer name e.g. "database - layername". This tool strips the database name from the layer name in the Layers Panel.

If there are open layers that are not GPKG, then it will have no affect of these layer names.

==TUPLOT==

TUPLOT is a 1D and 2D time series results viewer. A full description on how to use it is below:
* [[TUPLOT_External | How to use TUPLOT]]

==About==
Displays version of ArcGIS Pro Toolbar.