View source for Tutorial Model Archive

=Introduction=
This TUFLOW licence free tutorial model is aimed at new users, stepping through the process of building and running a model.

This version of the tutorials is an archived dataset. It focuses on TUFLOW Classic. The current tutorials focus on teaching TUFLOW HPC, and have been created using a new format with embed videos throughout to help new users learn the TUFLOW modelling steps. To access the current version see <u>[[Tutorial Introduction|Tutorial Introduction]]</u> .

=Requirements=
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.<br>
TUFLOW has relatively modest system requirements for small models such as the tutorial model.  However, larger and more complex models may have higher hardware requirements - in particular memory (RAM).<br>

==Hardware==
The tutorial model is designed to be be small, to allow for quick simulation and load times.  The tutorial model should run on any modern PC or laptop that is capable of running Windows XP or later.

==Software==
===TUFLOW===
TUFLOW can be obtained from the downloads section of the <u>[https://www.tuflow.com/Downloads.aspx TUFLOW website]</u>.  It is recommended that you use the latest release version of TUFLOW.This tutorial model does not require a TUFLOW licence in order to be simulated, and no additional drivers should be required.<br>

Please see [[HPC_Features_Archive | HPC Features Archive]] for more information on TUFLOW HPC features supported in the 2017 release.

===GIS Software===
This tutorial will need one of the following GIS packages. TUFLOW results can be viewed directly in GIS software or exported into GIS format and this is detailed in the tutorial model.  GIS Software have traditionally not handled time varying results well. Therefore, it is recommended (but optional) that a results viewer be used.
<ol>
<li>'''QGIS'''</li>
This tutorial was developed with QGIS 2.8 (Wein), this was previously know as Quantum GIS.  Earlier or later versions of the software should be generally be compatible with the tutorial tasks.  The new version of TUFLOW-QGIS plugin requires QGIS version 3.12 or higher.<br>
TUFLOW plugin for QGIS has been developed which allows the TUFLOW binary format (.dat and .xmdf) results to be viewed in QGIS without the need to convert these into shapefile or raster format.  Installation instruction are available on the <u>[[TUFLOW_QGIS_Plugin| QGIS TUFLOW Plugin Installation]]</u> notes page.  Both QGIS and the plugin are available free of charge.
<li>'''MapInfo with Vertical Mapper'''</li>
This tutorial was developed with MapInfo 10.5 and Vertical Mapper 3.7. Earlier or later versions of the software should generally be compatible with the tutorial tasks.
<li>'''MapInfo with Encom Discover'''</li>
This tutorial was developed with MapInfo 10.5 and Encom Discover Version 12.0. Earlier or later versions of the software should generally be compatible with the tutorial tasks.
<li>'''ArcGIS with Spatial Analyst'''</li>
Early modules of  this tutorial were developed with ArcGIS 9.2, later models (module 3 onward) were developed in ArcGIS 10.0. Earlier or later versions of the software should generally be compatible with the tutorial tasks.
<li>'''Surface-water Modelling Software (SMS)'''</li>
This tutorial was developed with SMS 11.0. Many of the tutorial tasks (such as editing/creating input files) can be completed through the SMS front-end interface. Tasks to be completed differently when using SMS are noted in the appropriate SMS sections. Earlier versions supporting the TUFLOW module and later versions of SMS should be generally compatible with tutorial tasks.<br>
SMS is available from <u>[https://www.aquaveo.com/downloads www.aquaveo.com/downloads]</u>. Once installed a 30 day trial licence can be requested.  See also this page of <u>[[SMS_Tips | SMS Tips]]</u>.
<li>'''WaterRIDE FLOOD Manager'''</li>
WaterRIDE FLOOD Manager is available from <u>[https://waterride.net/ www.waterride.net]</u>. WaterRIDE FLOOD Manager requires a licence.
</ol>

===Text Editor===
A text editor is required for creation of the TUFLOW input files. Any text editor can be used for this purpose. However, it is recommended that a more advanced text editor such as one of those listed below be used.  Ideally a text editor should be able to:<br>
*Colour code the TUFLOW control files;
*Open other files from the active control file; and
*Launch a TUFLOW simulation.
<ol>
<li>'''NotePad ++'''</li>
NotePad++ is a free text editor.  It is available from <u>[https://notepad-plus-plus.org/ https://notepad-plus-plus.org/]</u>.<br>
TUFLOW runfile colour coding can be enabled using the '''Notepad++ Syntax File''' on the <u>[https://www.tuflow.com/Tuflow%20Utilities.aspx TUFLOW downloads]]</u> page.  For instructions on configure Notepad++ for TUFLOW modelling, please see the [[NotepadPlusPlus_Tips |Notepad++ tips page on the wiki]].
<li>'''UltraEdit'''</li>
UltraEdit is recommended and can be downloaded for a trial period from <u>[https://www.ultraedit.com www.ultraedit.com]</u>.
See also <u>[[UltraEdit_Tips | UltraEdit Tips]]</u>.
<li>'''TextPad'''</li>
TextPad is another commercial text editor and may be downloaded from [https://www.textpad.com/ www.textpad.com/]. A trial version is also available.<br>
Please see this page for details on setting up colour coding: <u>[[TextPad_Tips]]</u>.
</ol>

===Microsoft Excel===
This is required for editing and working with tabular data and .csv files. This tutorial has been created in Excel 2010, however earlier version should be compatible with the tutorial.  See also the <u>[[Excel_Tips | Excel Tips]]</u>, which goes through the TUFLOW_tools add-ins.

=Module Data=
In order to build the models some data is required.  This includes a digital elevation model (DEM) and aerial photography.  The required background model data for the tutorial model is available for download below:
* <u>[https://www.tuflow.com/Download/TUFLOW/Tutorial_Model/Tutorial_Data_QGIS.zip QGIS Data Download]</u>.
* <u>[https://www.tuflow.com/Download/TUFLOW/Tutorial_Model/Tutorial_Data_MapInfo.zip MapInfo Data Download]</u>.
* <u>[https://www.tuflow.com/Download/TUFLOW/Tutorial_Model/Tutorial_Data_ArcGIS.zip ArcMap Data Download]</u>.
* <u>[https://www.tuflow.com/Download/TUFLOW/Tutorial_Model/Tutorial_Data_SMS.zip SMS Data Download]</u>.
The download package also contains a working version of the tutorial model for you to refer to. The folder only contains the input files to keep the size of the download file manageable.<br>
If you wish to run all of the final models for each module you can use the batch file under Complete_Model\Tuflow\runs\_run_all.bat.  Before using the batch file you will firstly need to edit the file in a text editor and change the path to the executable ('''TUFLOW_iSP_w64.exe'''), save then double click on the .bat file in Windows Explorer to initiate the simulations.<br>

=Recommended Reading=
Whilst the online tutorial is designed to cover as much material as possible, it is recommended that the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> be downloaded. This will be referred to throughout the tutorial model.<br>
It is also recommended that a sound naming convention for TUFLOW models and associated files be adopted. This is described in the following page: <u>[[Naming_Convention | TUFLOW Naming Convention]]</u>.<br>
The following page (<u>[[TUFLOW_file_types |TUFLOW file types]]</u>) describes the different file types and groups of files provided with this tutorial.<br>
The use of a modelling log is also beneficial and highly recommended.  TUFLOW modelling logs are discussed in this page: <u>[[TUFLOW_Modelling_Log | TUFLOW Modelling Log]]</u>.<br>

=Modules=
The tutorial model is presented in a number of modules. The modules have been developed to be undertaken as steps, with each module offering the opportunity to run the model and review the results. Some of the modules build upon earlier iterations; for example module 2 builds upon the model created in module 1.  For this purpose, models developed during the previous modules are available.<br>
New users are advised to undertake the modules in sequence, whilst more experienced users can skip to modules containing specific features of interest.

==Module 1: 2D only model==
The first tutorial module introduces the user the TUFLOW software, file types and model inputs. In this module a fully two-dimensional model (no 1D) is built. This module can be found <u>[[Tutorial_Module01_Archive| here]]</u>.

==Module 2: Embedding 1D culverts==
The second module introduces three 1D culverts through the road embankments. These culverts are dynamically linked to the 2D model. This module can be found <u>[[Tutorial_Module02_Archive| here]]</u>.

==Module 3: Basic 2D topography modification (breaklines)==
In the third module survey data is imported from text file data. These inputs are added to TUFLOW model as breaklines to ensure that the top of the road and the creek centre line are represented in the 5m TUFLOW model.  This module can be found <u>[[Tutorial_Module03_Archive| here]]</u>.

==Module 4: 1D Open Channel and 2D floodplain==
1D open channel is added to resolve the in-bank areas, the 1D model is dynamically linked to the 2D which is used to model the floodplain areas. This module can be found <u>[[Tutorial_Module04_Archive | here]]</u>.

==Module 5: Flood Impact Assessment==
A simple flood impact assessment is undertaken, a proposed development is added to the model and the peak water level for the existing and developed case scenarios are compared. This module can be found <u>[[Tutorial_Module05_Archive | here]].</u>

==Module 6 Modelling Bridges==
This module introduces the user to both 1D and 2D bridges. This module can be found <u>[[Tutorial_Module06_Archive | here]].</u>

==Module 7: Urban Drainage Modelling==
The use of TUFLOW's powerful 1d/2d underground pipe network linking is explored. This module can be found <u>[[Tutorial_Module07_Archive | here]].</u>

==Module 8: Direct Rainfall==
This module introduces direct rainfall modelling and includes use of new techniques such as the use of depth varying roughness. It includes guidance on the review and presentation of results when using rainfall on grid approaches. This module can be found <u>[[Tutorial_Module08_Archive | here]].</u>

==Module 9: Multiple Domain 2D-2D Model==
This tutorial module uses two different 2D domains of varying cell resolution dynamically linked to one another. A 5m cell resolution is used in the upper portion of the study area. A 2.5m cell resolution is adopted in the downstream area. This module can be found <u>[[Tutorial_Module09_Archive | here]].</u>

==Module 10: Managing Multiple Scenarios, Events and Variable==
This tutorial module demonstrates how to use TUFLOW Scenarios, Events and Variables. These features provide a model design framework to manage large numbers of simulations from a single TUFLOW Control File. Structuring a model in this format has significant benefits:
* It is the most efficient way to execute a project, reducing the number of man hours required to create models. 
* It has substantial quality control advantages. The modelling framework significantly reduces the number of TUFLOW input files required during a project. In doing so, it typically means less chance of accidental user error when input files are created. Particularly if the file is a slight alteration from another (for example, to reflect changes in inputs associated with a modelling a different event magnitude, duration or temporal pattern).<br>
This module can be found <u>[[Tutorial_Module10_Archive | here]].</u>

==Module 11: Dam Break Modelling==
This tutorial module uses variable Z shape to model a dam break. This module can be found <u>[[Tutorial_Module11_Archive | here]].</u>

==Module 14: Pump Modelling in 2D==
This module focuses on adding a pump to the tutorial model to simulate pumping of water from one location in the model to another. This module can be found <u>[[Tutorial_Module14_Archive | here]].</u>

==Contact==

For comments, requests and feedback contact <font color="blue"><u>support@tuflow.com</u></font>.