Latest revision as of 15:17, 18 July 2024

Introduction

A TUFLOW toolbox is available for ArcMap 10.1 and newer. This toolbox helps with streamlining the process of creating and editing a TUFLOW model in ArcMap. A Toolbar has also been developed to accompany the toolbox to further increase efficiency and workflow. The toolbar shortcuts the opening of the toolbox utilities to a single click on an easily accessible toolbar.

These utilities can be downloaded from the TUFLOW website:

Download Link

The download contains both the .esriaddin and the ArcTUFLOW Toolbox. The .esriaddin is a stand alone toolbar add-in to ArcMap and (as suggested) is a stand alone item that does not need to be kept with the other contents of the download. The .tbx is the ArcTUFLOW Toolbox and should be kept with the other folders contained in the download.

Installation

For instructions on how to install ArcTUFLOW Toolbox and Toolbar into ArcMap please see the following link:

How to install ArcTUFLOW Toolbox and Toolbar

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:

Model Stage	Utilities
Start Model Build	1. Configure TUFLOW (Required Initialization Step) 2. Create TUFLOW Folders
Model Build and Development	3. Import Empty (template) TUFLOW Files 4. Insert TUFLOW Attributes 5. Increment Layer 6. Style All TUFLOW Layers - Toolbar only 7. Style Selected TUFLOW Layers - Toolbar only 8. Create Breakline 9. Change Attribute Data Type 10. Correct Pipe Direction
Running TUFLOW	11. Run TUFLOW Simulation
Loading and Viewing Results	12. Load Simulation Input Files 13. Label Selected Layer - Toolbar only 14. TUPLOT - Toolbar only
Miscellaneous	15. About

Configure TUFLOW

The first item, “Configure TUFLOW”, 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 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

Create TUFLOW Folders

The tool "Create TUFLOW Folders" will create the standard TUFLOW folder structure and generate empty TUFLOW template files.

This tool is best used if Configure TUFLOW has been run prior.

Import Empty (template) TUFLOW Files

"Import Empty Template Files" can be used to import new shp files for editing. This tool will automatically delete the dummy "null" entry which otherwise requires manual deletion if an empty file loaded from the catalog.

Select the object type (point, line or region)
Select the desired template file
Specify the run ID for the file. This will be added to the file name as a suffix.

The ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to Configure TUFLOW for more instructions.

Insert TUFLOW Attributes

"Insert TUFLOW Attributes" 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 attribues 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 has been run prior.

Increment Layer

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.

Create Breakline

The "Create Breakline" tool will create a 2d_zsh breakline from a user input polyline and DEM. The user has a number of options, such as:

Vertice placement along line - the user can specify additional intervals at which to extract elevations, or use only the line vertices
Elevation extraction - extract straight from DEM, or use a statistical approach by looking at surrounding elevation values

The steps are:

Specify the input polyline from which a breakline will be created from
Select if the user only wants to extract points at a specified chainage (ignore line vertices) - otherwise points will be extracted at defined chainage and vertices
Specify an interval at which to insert additional elevation extraction points along line - leave blank to output at line vertices only
Specify the underlying DEM to use to for elevation extraction
Specify a search radius for considering neighbouring elevation values if using a statistical approach to elevation extraction - leave blank to extract elevation from immediate cell
Specify a statistical operation (must be coupled with a search radius). Options include:
- 'MAXIMUM'
- 'MINIMUM'
- 'MEAN'

Change Attribute Data Type

This tool allows you to modify a shapefile attribute (field) type whist keeping the attribute order intact. An example of its use is the modification of the pBlockage attribute in a 1d_nwk layer from 'double' to 'text' for the new Australian Rainfall and Runoff blockage scenarios. Please note that at present the script only allows for the change of attributes to type text.

Firstly select the 'Change Attribute Type Script' from the ArcTUFLOW toolbox.

Populate the tool dialogue and run. You can find help information on the various inputs on the tool info panel.

Correct Pipe Direction

The "Correct Pipe Direction" tool will reverse the direction of all lines within a layer based on the upstream and downstream invert levels. Based on the invert levels, the tool will reverse any line that has an adverse gradient, with the assumption that the line has been digitised in the wrong direction. It will also switch the upstream and downstream invert attributes to correct them after reversing the line direction.

The steps are:

Select an input pipe layer
Select the fields which represent the upstream and downstream invert levels

Run TUFLOW Simulation

Enter the simulation tcf reference
Define the path to the TUFLOW executable

The ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to Configure TUFLOW for more instructions.

Load Simulation Input Files

This tool loads all input shp files from a model simulation into a common ArcGIS Map window.
The user has the option of which files to import from the simulation.

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.

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.

TUPLOT

TUPLOT is a 1D and 2D time series results viewer. A full description on how to use it is below:

How to use TUPLOT

About

Displays version of ArcTUFLOW.

Up
Back to ArcGIS

@@ Line 1: / Line 1: @@
-<font size=3><b>THIS PAGE IS CURRENTLY UNDERGOING UPDATES</b></font>
 =Introduction=
 A TUFLOW toolbox is available for ArcMap 10.1 and newer. This toolbox helps with streamlining the process of creating and editing a TUFLOW model in ArcMap. A Toolbar has also been developed to accompany the toolbox to further increase efficiency and workflow. The toolbar shortcuts the opening of the toolbox utilities to a single click on an easily accessible toolbar.
-These utilities can be downloaded from the TUFLOW website: http://www.tuflow.com/Tuflow%20Utilities.aspx
+These utilities can be downloaded from the TUFLOW website:
+* [https://www.tuflow.com/downloads/#utilities Download Link]
+The download contains both the .esriaddin and the ArcTUFLOW Toolbox. The .esriaddin is a stand alone toolbar add-in to ArcMap and (as suggested) is a stand alone item that does not need to be kept with the other contents of the download. The .tbx is the ArcTUFLOW Toolbox and should be kept with the other folders contained in the download.
 =Installation=
@@ Line 10: / Line 11: @@
 * [[TUFLOW_ArcGIS_Toolbox_and_Toolbar_Installation | How to install ArcTUFLOW Toolbox and Toolbar]]<br><br>
-=The Utilities: What are they, How to use them, and Workflow=
+=The Utilities: What are they and How to use them=
-The descriptions below, and their order are intended to help the user with model initiation, setup and development, running, and checking and viewing results:
+The ArcTUFLOW Tools are intended to help the user with model initiation, setup and development, running, and checking and viewing results:
 [[File: ArcTUFLOW_Toolbox_Toolbar_comb.PNG]]<br>
@@ Line 18: / Line 19: @@
 {| class="wikitable"
-! style="background-color:#005581; font-weight:bold; color:white;" width=5% | Model Stage
+! 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
-! style="background-color:#005581; font-weight:bold; color:white;" width=20% | Description
 |-
 |Start Model Build || 1. [[#Configure_TUFLOW | Configure TUFLOW (Required Initialization Step)]]
 . [[#Create_TUFLOW_Folders  | Create TUFLOW Folders]]<br>
-| This is the first step of any new model or ArcGIS workspace. Using the '''Configure TUFLOW''' utility will create a ''_config.txt'' file that will pre-populate fields in the other utilities that speed up their use. The '''Create TUFLOW Folders''' utility can also be used to create the TUFLOW folder structure and empty SHP files.
 |-
 |Model Build and Development || 3. [[#Import_Empty_(template)_TUFLOW_Files| Import Empty (template) TUFLOW Files]]<br>
@@ Line 34: / Line 33: @@
 . [[#Change_Attribute_Data_Type | Change Attribute Data Type]]<br>
 . [[#Correct_Pipe_Direction | Correct Pipe Direction]]<br>
-XX. [[#Extract_ARR2016_to_TUFLOW | Extract ARR2016 to TUFLOW]] - coming soon<br>
-|These utilities are used in the model development stage to speed up creation of TUFLOW layers. Using the '''Import Empty''' utility enables the user to quickly add empty SHP layers, and the '''Increment Layer''' utility allows the user to rev up TUFLOW layers as the model progresses in iterations. Other utilities such as '''Create Breakline''' automate some of the more time consuming steps in the model build.
 |-
-|Running TUFLOW || 11. [[#Run_TUFLOW_Simulation | Run TUFLOW Simulation]]<br> || The '''Run TUFLOW Simulation''' utility can be used to set off TUFLOW simulations from ArcGIS.
+|Running TUFLOW || 11. [[#Run_TUFLOW_Simulation | Run TUFLOW Simulation]]<br>
 |-
 |Loading and Viewing Results || 12. [[#Load_Simulation_Input_Files | Load Simulation Input Files]]<br>
-. [[#TUPLOT | TUPLOT]] - Toolbar only
+. [[#Label_Selected_Layer | Label Selected Layer]] - Toolbar only<br>
-| These utilities are intended for the purpose of checking and reviewing input files and viewing 1D and time series results. The '''Load Simulation Input Files''' utility allows the user to load in the input SHP files and CHECK files from a simulation for review. And <b>TUPLOT</b> introduces the functionality currently available in QGIS to ArcGIS for viewing 1D and time series results.
+. [[#TUPLOT | TUPLOT]] - Toolbar only
+|-
+|Miscellaneous || 15. [[#About | About]]
 |}<br>
 ==Configure TUFLOW==
-The first item, “Configure TUFLOW”, creates a configuration file for all of the arcTUFLOW tools based on the map document. The steps for running the configuration tool are outlined below:
+The first item, “Configure TUFLOW”, 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).
+* Open or save a map document before running.
-* Select a TUFLOW folder for your model. This should be the folder that contains the entire TUFLOW model folder structure. For example, if your TUFLOW folder is "D:\projects\Example\TUFLOW", the folder set here should be “D:\projects\Example\”. All of the following tools will use this location.
+* Select a TUFLOW 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>
-[[File:ArcGIS_Utility_004a.jpg|400px]]
+[[File:ArcTUFLOW_ConfigureTUFLOW.PNG]]
 ==Create TUFLOW Folders==
+The tool "Create TUFLOW Folders" will create the standard TUFLOW folder structure and generate empty TUFLOW template files.
+This tool is best used if [[#Configure_TUFLOW | Configure TUFLOW]] has been run prior.
+[[File: ArcTUFLOW_CreateTUFLOWFolders.PNG]]
 ==Import Empty (template) TUFLOW Files==
@@ Line 62: / Line 66: @@
 *Specify the run ID for the file. This will be added to the file name as a suffix.
 <br>
-The ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to [[Configure_TUFLOW | Configure TUFLOW]] for more instructions. <br><br>
+The ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to [[#Configure_TUFLOW | Configure TUFLOW]] for more instructions. <br><br>
 [[File:ArcGIS_Utility_007.jpg|400px]]
 ==Insert TUFLOW Attributes==
+"Insert TUFLOW Attributes" 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 attribues 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.
+[[File: ArcTUFLOW_InsertTUFLOWattributes.PNG]]
 ==Increment Layer==
+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
+[[File: ArcTUFLOW_IncrementLayer.PNG]]
 ==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.
 ==Create Breakline==
+The "Create Breakline" tool will create a 2d_zsh breakline from a user input polyline and DEM. The user has a number of options, such as:
+* Vertice placement along line - the user can specify additional intervals at which to extract elevations, or use only the line vertices
+* Elevation extraction - extract straight from DEM, or use a statistical approach by looking at surrounding elevation values
+The steps are:
+* Specify the input polyline from which a breakline will be created from
+* Select if the user only wants to extract points at a specified chainage (ignore line vertices) - otherwise points will be extracted at defined chainage and vertices
+* Specify an interval at which to insert additional elevation extraction points along line - leave blank to output at line vertices only
+* Specify the underlying DEM to use to for elevation extraction
+* Specify a search radius for considering neighbouring elevation values if using a statistical approach to elevation extraction - leave blank to extract elevation from immediate cell
+* Specify a statistical operation (must be coupled with a search radius). Options include:
+** 'MAXIMUM'
+** 'MINIMUM'
+** 'MEAN'
+[[File: ArcTUFLOW_CreateBreakline.PNG]]
 ==Change Attribute Data Type==
@@ Line 88: / Line 134: @@
 ==Correct Pipe Direction==
+The "Correct Pipe Direction" tool will reverse the direction of all lines within a layer based on the upstream and downstream invert levels. Based on the invert levels, the tool will reverse any line that has an adverse gradient, with the assumption that the line has been digitised in the wrong direction. It will also switch the upstream and downstream invert attributes to correct them after reversing the line direction.
+The steps are:
+* Select an input pipe layer
+* Select the fields which represent the upstream and downstream invert levels
+[[File: ArcTUFLOW_CorrectPipeDir.PNG]]
 ==Run TUFLOW Simulation==
@@ Line 100: / Line 154: @@
 This tool loads all input shp files from a model simulation into a common ArcGIS Map window.<br>
-The [[ArcTUFLOW_Run_TUFLOW_Simulation | ArcTUFLOW Run TUFLOW Simulation]] example does not provide an input (.tlf) to complete this example. This section relates to users who have run their own Tutorial, Demo, Example or personal models.
+The user has the option of which files to import from the simulation.
-==About==
-==Extract ARR2016 to TUFLOW==
+[[File: ArcTUFLOW ImportSimFiles.PNG]]
-Coming Soon
-* After completing your model run, enter the simulation tlf reference
-[[File:arcTUFLOW_Load_Simulation_File.JPG|600px]]
 <br>
 <br>
@@ Line 115: / Line 163: @@
 <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.
 ==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 ArcTUFLOW.
 <br>
 {{Tips Navigation
 |uplink=[[ArcGis_Tips | Back to ArcGIS]]}}

Difference between revisions of "ArcTUFLOW Toolbox and Toolbar"

Latest revision as of 15:17, 18 July 2024

Contents

Introduction

Installation

The Utilities: What are they and How to use them

Configure TUFLOW

Create TUFLOW Folders

Import Empty (template) TUFLOW Files

Insert TUFLOW Attributes

Increment Layer

Style All TUFLOW Layers

Style Selected TUFLOW Layers

Create Breakline

Change Attribute Data Type

Correct Pipe Direction

Run TUFLOW Simulation

Load Simulation Input Files

Label Selected Layer

TUPLOT

About

Navigation menu

Search