ArcTUFLOW Toolbox and Toolbar

From Tuflow
Revision as of 10:07, 14 March 2018 by Ellis Symons (Talk | contribs) (Introduction)

Jump to: navigation, search


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:

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.


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

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:

ArcTUFLOW Toolbox Toolbar comb.PNG

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
XX. Extract ARR2016 to TUFLOW - coming soon

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.

ArcGIS Utility 007.jpg

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.

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

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'

ArcTUFLOW CreateBreakline.PNG

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.
    Arc Change att tool.JPG

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

    Arc Change att tool iface.JPG

    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

    ArcTUFLOW CorrectPipeDir.PNG

    Extract ARR2016 to TUFLOW

    Coming Soon

    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.

    ArcGIS Utility 008.jpg

    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.

    ArcTUFLOW ImportSimFiles.PNG

    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.

    ArcTUFLOW Load Simulation File Symbology.JPG

    This tool is courtesy of Wood Rodgers, Inc. (

    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 is a 1D and 2D time series results viewer. A full description on how to use it is below:


    Displays version of ArcTUFLOW.

    Go-up.png Back to ArcGIS