Tutorial Introduction

From Tuflow
Jump to: navigation, search

Introduction

This TUFLOW licence free tutorial model is aimed at new users, stepping through the process of building and running a model. To begin, watch the following video:


Requirements and Downloads

TUFLOW doesn't have its own graphical user interface (GUI), it uses GIS software and text editor for its model creation and result viewing. As such, it is very efficient and flexible and doesn't have the same data load/visualisation limitations using big datasets as other modelling software GUIs.

This short video introduces the required TUFLOW modelling programs:

Requirement Brief Description Download
TUFLOW TUFLOW is a computer program for simulating depth-averaged, one and two-dimensional free-surface flows such as occurs from floods and tides, with the 2D solution occurring over a regular grid of square elements.

It is recommended to always use the latest release version of TUFLOW.

This tutorial model does not require a TUFLOW licence.

This tutorial is set up to use a NVIDIA GPU card. If this is not available, CPU can be used in the hardware command.

Tutorial Dataset.

The TUFLOW executable is provided within the Tutorial Dataset.
QGIS

QGIS TUFLOW plugin
The geographic information system (GIS) used to build models and view results. This tutorial was developed with QGIS 3.20. It is recommended to have QGIS 3.20 or later to ensure compatibility with TUFLOW plugin latest features.

The TUFLOW plugin includes numerous tools to increase workflow efficiency.

Latest 64-bit version of QGIS.

QGIS TUFLOW Plugin Installation.

NotePad++

Syntax Highlighting
A text editor is required for creation of the TUFLOW input files. This tutorial was developed with NotePad++. Ideally a text editor should be able to:
  • Colour code the TUFLOW control files;
  • Open other files from the active control file; and
  • Launch a TUFLOW simulation.

TUFLOW colour coding can be enabled using syntax highlighting.

Latest 64-bit version of Notepad++.

TUFLOW syntax highlighting for Notepad++.

For instructions on configuring Notepad++ for TUFLOW modelling, see Notepad++ tips.

Microsoft Excel A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created in Excel.

Note: there are numerous GIS packages that can be used, these tutorials have been specifically designed for QGIS using the QGIS TUFLOW Plugin. If you would like to see past tutorials for MapInfo, ArcGIS or SMS, please contact support@tuflow.com.

Tutorial Modules

The download dataset contains the input files and working version of the tutorial model for reference. Results and check files are not included to keep the size of the download file manageable. The folder should be placed in a location with write permissions.

The tutorial model is presented in a number of modules. All modules can be completed independently, however new users are encouraged to undertake the modules in sequence:


Contact

For comments, requests and feedback contact support@tuflow.com.

Archive Dataset

Historic tutorial model datasets can be accessed via the following link: TUFLOW Classic Tutorial Model Archive.