View source for Tutorial Introduction

= 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:
:*<u>[https://vimeo.com/505584298/2c91bd5f48 What Is TUFLOW?]</u>

=Requirements and Downloads=
TUFLOW uses QGIS as its Graphical User Interface (GUI), in combination with text editor and spreadsheet software, for its model creation and result viewing. The group of software creates an extremely workflow efficient and flexible modelling environment. Notably, QGIS does not experience the data load/visualisation lag and display issues some other hydraulic modelling software GUIs are limited by when working with larger datasets.<br>

This short video introduces the required TUFLOW modelling programs:
:*<u>[https://vimeo.com/505579529/03f4cb3d17 Required Programs]</u><br>

{| class="wikitable" width="75%"

! style="background-color:#005581; font-weight:bold; color:white;"| Requirement
! style="background-color:#005581; font-weight:bold; color:white;" | Brief Description
! style="background-color:#005581; font-weight:bold; color:white;" | 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.<br>
It is recommended to always use the latest release version of TUFLOW.<br>

This tutorial model does not require a TUFLOW licence.<br>

This tutorial is set up to use a NVIDIA GPU card. If this is not available, CPU can be used in the hardware command. <br>
||The TUFLOW executable is provided within the <u>[https://wiki.tuflow.com/Tutorial_Introduction#Module_Data Tutorial Dataset]</u>.  
|-
| '''QGIS''' <br><br>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. <br><br>
The TUFLOW plugin includes numerous tools to increase workflow efficiency.  <br>

||<u>[https://qgis.org/download/ Latest 64-bit version of QGIS]</u>. <br><br>

<u>[[TUFLOW_QGIS_Plugin| QGIS TUFLOW Plugin Installation]]</u>.
|-
| '''NotePad++''' <br><br>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:<br>
*Colour code the TUFLOW control files;
*Open other files from the active control file; and
*Launch a TUFLOW simulation. <br><br>
TUFLOW colour coding can be enabled using syntax highlighting. 
|| <u>[https://notepad-plus-plus.org/downloads/ Latest 64-bit version of Notepad++]</u>. <br><br>

<u>[https://downloads.tuflow.com/_archive/Miscellaneous/NPP_TUFLOW_Syntax_Highlighting.zip TUFLOW syntax highlighting for Notepad++]</u>.<br><br>

For instructions on configuring Notepad++ for TUFLOW modelling, see <u>[[NotepadPlusPlus_Tips |Notepad++ tips]]</u>.
|-
| '''Microsoft Excel''' || A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created in Excel. || 
|-
| '''Windows File Explorer''' || Windows File Explorer is used for navigating, copying and renaming files. It is recommended to display file extension to allow for editing of file extensions. For more details, see [[Tutorial_Troubleshooting_QGIS#Editing_File_Extension | Editing file extension]]. || 
|}

=Module Data=
To build the tutorial model, download one of the datasets below. This includes a digital elevation model (DEM), aerial photography, background model data for the tutorial model and a working version of the model. There are two formats available, Shapefile and GeoPackage. GeoPackage has been supported since the 2023-03 Release, for tips on its use see <u>[https://wiki.tuflow.com/GeoPackage_Tips GeoPackage Tips]</u>. 
:*<u>[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/Tutorial_Models_QGIS_GPKG.zip Tutorial Dataset - QGIS - GPKG]</u>
:*<u>[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/Tutorial_Models_QGIS_SHP.zip Tutorial Dataset - QGIS - SHP]</u>

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 <u>[mailto:support@tuflow.com support@tuflow.com]</u>.

=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.<br>

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:

:*<u>[[Tutorial_M01 | Module 1]]</u>  - 2D Base Model
:*<u>[[Tutorial_M02 | Module 2]]</u>  - Topography Updates
:*<u>[[Tutorial_M03 | Module 3]]</u>  - 1D Culverts
:*<u>[[Tutorial_M04 | Module 4]]</u>  - 2D Bridges
:*<u>[[Tutorial_M05 | Module 5]]</u>  - Integrated Urban Drainage
:*<u>[[Tutorial_M06 | Module 6]]</u>  - Direct Rainfall
:*<u>[[Tutorial_M07 | Module 7]]</u>  - Quadtree 
:*<u>[[Tutorial_M08 | Module 8]]</u>  - Scenario Management
:*<u>[[Tutorial_M09 | Module 9]]</u>  - Event Management
:*<u>[[Tutorial_M10 | Module 10]]</u> - Dam Break
:*<u>[[Tutorial_M11 | Module 11]]</u> - 1D Open Channel

=Archive Dataset=
Historic tutorial model datasets can be accessed via the following link: <u>[[Tutorial_Model_Archive| TUFLOW Classic Tutorial Model Archive]]</u>.

=Contact=
For comments, requests and feedback contact <u>[mailto:support@tuflow.com support@tuflow.com]</u>.<br>
For further training opportunities see <u>[https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue]</u> and/or contact <u>[mailto:training@tuflow.com training@tuflow.com]</u>. <br>
Alternatively, see the <u>[[TUFLOW_Example_Models#Example_Model_Catalogue | TUFLOW Example Models]]</u> to explore the full list of TUFLOW features.

<br>
{{Tips Navigation
|uplink=[[Main_Page| Back to Main Page]]
}}