ArcTUFLOW Toolbox and Toolbar

THIS PAGE IS CURRENTLY UNDERGOING UPDATES

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

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, How to use them, and Workflow

The descriptions below, and their order are intended to help the user with model initiation, setup and development, running, and checking and viewing results:

Model Stage	Utilities	Description
Start Model Build	1. Configure TUFLOW (Required Initialization Step) 2. Create TUFLOW Folders	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 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	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	The Run TUFLOW Simulation utility can be used to set off TUFLOW simulations from ArcGIS.
Loading and Viewing Results	12. Load Simulation Input Files 13. TUPLOT - Toolbar only	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 TUPLOT introduces the functionality currently available in QGIS to ArcGIS for viewing 1D and time series results.
Miscellaneous	14. 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
  

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.

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

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.

Load Simulation Input Files

This tool loads all input shp files from a model simulation into a common ArcGIS Map window.
The 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.

• After completing your model run, enter the simulation tlf reference

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)

TUPLOT

About

Up
Back to ArcGIS