Section 17 Utilities

17.1 Introduction

The TUFLOW Utilities are a set of tools that can be used to convert input data for use in a TUFLOW model, or to process / manipulate the raw 2D result files produced from a model simulation. Many of the utilities are DOS executables similar to the TUFLOW engine, however some are macros for use in Excel or Python scripts. GIS based utilities have also been developed for QGIS, ArcGIS, and MapInfo.

The utilities do not require a TUFLOW licence to utilise.

17.2 GIS Based Utilities

17.2.1 QGIS TUFLOW Plugin

If you are using QGIS as your model development or result viewing environment, we strongly recommend installing the TUFLOW QGIS Plugin. It includes numerous tools to increase workflow efficiency and powerful result viewing functionality via its TUFLOW Viewer. After installing, the tools can be found within the TUFLOW QGIS Plugin Menu or the QGIS TUFLOW Processing Toolbox.

Table 17.1: **QGIS TUFLOW Plugin - Tools**
Category	Tool	Example
Editing Tools	Create or Configure TUFLOW Project Import Empty (template GIS file) Insert TUFLOW Attributes to Existing Layer Increment Selected Layer Reload Data Arch Bridge Editor - shown in example image. Copy TUFLOW Command
Run Tools	TUFLOW Runner - shown in example image. Run TUFLOW simulation Running TUFLOW Utilities
Visualisation Tools	TUFLOW Viewer - shown in example image. Applying TUFLOW styles Import Check Files From Folder Load TUFLOW Layers From TCF Filter and Sort TUFLOW Layers Apply GPKG Layer Names Apply Label to Current Layer Apply Stability Styling
Hydrology Tools	ARR to TUFLOW - shown in example image. ReFH2 to TUFLOW SCS to TUFLOW
Integrity Tools	1D Integrity Tool - shown in example image.
Processing Toolbox	Convert TUFLOW Model GIS Format Package Model - shown in example image.

This QGIS Plugin is actively developed, with new versions released frequently. Please send any feedback, recommendations or new feature ideas to support@tuflow.com.

17.2.3 ArcMap Toolbox

The ArcMap Toolbox is available for ArcMap version 10.1 and newer. The toolbox helps with streamlining the process of creating and editing a TUFLOW model in ArcMap. For more information on the ArcMap Toolbox, see the TUFLOW Wiki.

The ArcMap Toolbox is no longer actively developed.

17.2.4 MiTools

MapInfo and TUFLOW Productivity Utilities (miTools) were developed to improve the efficiency of setting up and reviewing TUFLOW models, as well as improving the day to day ease of using MapInfo Professional. For information on miTools, see the TUFLOW Wiki.

MiTools are no longer actively developed.

17.3 Console Utilities

The TUFLOW Console Utilities are like the TUFLOW engine in that they are command window executables with no user interface. They are available for download from the TUFLOW Website.

The TUFLOW Wiki provides a comprehensive list of available options for each utility along with further examples.

Please send any feedback, recommendations or suggestions on the Utilities to support@tuflow.com.

17.3.1 Pre and Post Processing

The following utilities are available to assist in pre and post processing:

These Utilities can also be downloaded and run directly through the TUFLOW QGIS Plugin.

17.3.2 Convert to TUFLOW

The following utilities are available to assist in converting model files from other software to TUFLOW:

Refer to the relevant pages to view the details with regards to the conversion approach.

17.3.3 Textfile Syntax Highlighting

As described in Section 2.2, TUFLOW requires the use of control files to bring together the various GIS and tabular datasets as well as TUFLOW specific commands. To assist in the creation and review of the control files, syntax highlighting tools have been developed and are available for the following text file editors:

An example of the syntax highlighting is shown in Figure 2.2.

17.3.4 PyTUFLOW

PyTUFLOW is a package of Python tools for extracting TUFLOW time series results. It can be used to automate output tasks such as checking model health, goodness-of-fit for model calibration, viewing on-the-fly model output (used in conjunction with Write PO Online == ON), and high-volume output plotting from production runs. An example of its use for generating calibration plots can be seen here.

More information about the PyTUFLOW package can be found on the TUFLOW Wiki.

For worked examples demonstrating the use of PyTUFLOW, please register for the free Introduction to Python for TUFLOW eLearning Course.

17.3.5 Excel Macros

A set of Excel TUFLOW Tools is available for download here. These tools can help with the set up and review of tabular data for input into TUFLOW as well as the review of tabular outputs. Further description of the tools, including setup instructions, is available on the TUFLOW Wiki.