Difference between revisions of "Tutorial Introduction"

From Tuflow
Jump to navigation Jump to search
 
(27 intermediate revisions by 5 users not shown)
Line 4: Line 4:
 
<br>
 
<br>
  
=Requirements=
+
=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.<br>
+
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:
 
This short video introduces the required TUFLOW modelling programs:
Line 22: Line 22:
  
 
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>
 
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>
||<u>[https://downloads.tuflow.com/Private_Download/Tutorial_Model.zip Tutorial Dataset]</u>. <br><br>The TUFLOW executable is provided within the Tutorial Dataset.   
+
||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>
+
| '''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>
 
The TUFLOW plugin includes numerous tools to increase workflow efficiency.  <br>
  
||<u>[https://qgis.org/en/site/forusers/download.html Latest 64-bit version of QGIS]</u>. <br><br>
+
||<u>[https://qgis.org/download/ Latest 64-bit version of QGIS]</u>. <br><br>
  
 
<u>[[TUFLOW_QGIS_Plugin| QGIS TUFLOW Plugin Installation]]</u>.
 
<u>[[TUFLOW_QGIS_Plugin| QGIS TUFLOW Plugin Installation]]</u>.
Line 38: Line 38:
 
|| <u>[https://notepad-plus-plus.org/downloads/ Latest 64-bit version of Notepad++]</u>. <br><br>
 
|| <u>[https://notepad-plus-plus.org/downloads/ Latest 64-bit version of Notepad++]</u>. <br><br>
  
<u>[https://www.tuflow.com/Download/Miscellaneous/NPP_TUFLOW_Syntax_Highlighting.zip TUFLOW syntax highlighting for 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>.
 
For instructions on configuring Notepad++ for TUFLOW modelling, see <u>[[NotepadPlusPlus_Tips |Notepad++ tips]]</u>.
Line 44: Line 44:
 
| '''Microsoft Excel''' || A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created in Excel. ||  
 
| '''Microsoft Excel''' || A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created in Excel. ||  
 
|}
 
|}
 +
 +
<br>
 +
 +
=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 <font color="blue"><u>support@tuflow.com</u></font>.
 
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 <font color="blue"><u>support@tuflow.com</u></font>.
<br><br>
 
  
=Modules=
+
=Tutorial Modules=
Download the <u>[https://downloads.tuflow.com/Private_Download/Tutorial_Model.zip Tutorial Dataset]</u>. The folder only contains the input files to keep the size of the download file manageable. The download package also contains a working version of the tutorial model for reference. The downloaded content should be extracted and the folder placed somewhere with write permissions.<br>
+
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.
+
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_M01 | Module 1]]</u>  - 2D Base Model
 
:*<u>[[Tutorial_M02 | Module 2]]</u>  - Topography Updates
 
:*<u>[[Tutorial_M02 | Module 2]]</u>  - Topography Updates
:*<u>[[Tutorial_M03 | Module 3]]</u>  - 1D Culverts in 2D Model
+
:*<u>[[Tutorial_M03 | Module 3]]</u>  - 1D Culverts
 
:*<u>[[Tutorial_M04 | Module 4]]</u>  - 2D Bridges
 
:*<u>[[Tutorial_M04 | Module 4]]</u>  - 2D Bridges
:*<u>[[Tutorial_M05 | Module 5]]</u>  - Integrated Urban Drainage (Pipe Network)
+
:*<u>[[Tutorial_M05 | Module 5]]</u>  - Integrated Urban Drainage
 
:*<u>[[Tutorial_M06 | Module 6]]</u>  - Direct Rainfall
 
:*<u>[[Tutorial_M06 | Module 6]]</u>  - Direct Rainfall
 
:*<u>[[Tutorial_M07 | Module 7]]</u>  - Quadtree  
 
:*<u>[[Tutorial_M07 | Module 7]]</u>  - Quadtree  
Line 62: Line 69:
 
:*<u>[[Tutorial_M09 | Module 9]]</u>  - Event Management
 
:*<u>[[Tutorial_M09 | Module 9]]</u>  - Event Management
 
:*<u>[[Tutorial_M10 | Module 10]]</u> - Dam Break
 
:*<u>[[Tutorial_M10 | Module 10]]</u> - Dam Break
:*<u>[[Tutorial_M11 | Module 11]]</u> - 1D Open Channel ESTRY
+
:*<u>[[Tutorial_M11 | Module 11]]</u> - 1D Open Channel
 
<br>
 
<br>
  
Line 71: Line 78:
  
 
=Archive Dataset=
 
=Archive Dataset=
Historic tutorial model datasets can be accessed via the following link: <u>[[Tutorial_Model_Archive| TUFLOW Tutorial Model Archive]]</u>.
+
Historic tutorial model datasets can be accessed via the following link: <u>[[Tutorial_Model_Archive| TUFLOW Classic Tutorial Model Archive]]</u>.
 +
 
 +
<br>
 +
{{Tips Navigation
 +
|uplink=[[Main_Page| Back to Main Page]]
 +
}}

Latest revision as of 18:51, 19 September 2024

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

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.

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.


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 GeoPackage Tips.

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.


Up
Go-up.png Back to Main Page