Tuflow

Flood Modeller Tutorial Model: Difference between revisions

Browse history interactively
← Older edit
Content deleted Content added
VisualWikitext
 
(9 intermediate revisions by one other user not shown)
Line 4:
 
=Requirements and Downloads=
Both TUFLOW and Flood Modeller have 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). Both software are available in 32 and 64 bit versions. The tutorial model is designed to 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 7 or later.
==Hardware==
The tutorial model is designed to 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 7 or later. If you would like to complete the optional TUFLOW HPC steps utilising a GPU card then you will need access to a CUDA enabled NVidia graphics card.
==Software==
===TUFLOW===
 
This tutorial model has been constructed using the 2018 release of TUFLOW. The tutorial model may be simulated licence free using TUFLOW Build 2016-03-AC or later. This can be obtained from the [https://tuflow.com/downloads/#tuflow downloads section] of the TUFLOW website. TUFLOW Build 2016-03-AD or later must be used in order to take advantage of the free TUFLOW link for this tutorial model. <br>
{| class="wikitable" width="75%"
 
===Flood Modeller===
! style="background-color:#005581; font-weight:bold; color:white;"| Requirement
This tutorial model has been constructed using version 4.2 of Flood Modeller. This can be downloaded from the [https://www.floodmodeller.com/en-gb/downloads/ Flood Modeller Website]. The tutorial model may be simulated licence free using Version 4.2 to 4.6. These versions of Flood Modeller contains the free TUFLOW link, which permits simulation of linked models with up to 10 links or the tutorial model.
! style="background-color:#005581; font-weight:bold; color:white;" | Brief Description
! style="background-color:#005581; font-weight:bold; color:white;" | Download
|-
 
Larger models with more links will require a [https://www.floodmodeller.com/en-gb/sales/pricing-and-licensing-options/tuflow/ link licence]. A licence is also required is you intend to run the model in Flood Modeller 5 or later<br>
| '''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>
 
===GIS Software===
It is commonly used in the UK and Ireland, Australia and the United States for the modelling of surface waters, river systems and pipe networks. <br>
TUFLOW models typically require access to a GIS package, text editor, Microsoft Excel and a results viewer to build, review and visualise a model. Refer to the following Wiki page to view a list of compatible packages. Alternatively, Flood Modeller may be used as a GUI for creating and editing GIS layers in a TUFLOW model and also for visualising the results. Instructions for this Flood Modeller – TUFLOW tutorial model have been provided using the following GIS file formats: ▼
 
Instructions for this Flood Modeller – TUFLOW tutorial model have been provided using the following GIS and modelling packages:
It is recommended to always use the latest release version of TUFLOW.<br>
*MapInfo
 
*QGIS - SHP▼
This tutorial model does not require a TUFLOW licence.<br>
*ArcGIS
 
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>.
|-
 
|'''Flood Modeller'''|| Flood Modeller (previously known as ISIS) is a commercial flood modelling package developed by Jacobs for simulating depth-averaged one and two dimensional free surface flows. It is primarily used for the simulation of river channels and is widely used within the UK and Ireland. This tutorial model will only leverage Flood Modeller’s 1D Solver. <br>
TUFLOW 1D and 2D domains can be dynamically linked to the 1D domain of Flood Modeller Pro. Flood Modeller is not included within the TUFLOW executable and must be downloaded separately. <br>
 
Unlike TUFLOW Flood Modeller has a standalone Graphical User Interface which can be used to build networks, run models, and visualise results.
 
It is recommended that TUFLOW 2020-10-AD or later is used in conjunction with Flood Modeller Version 5 or later. <br>
 
For Flood Modeller Version 5 or later a Standard, Professional, or Unlimited Edition of Flood Modeller Pro is required to open and run the tutorial model.
||<u>[https://www.floodmodeller.com/downloads/ Latest 64-bit version of Flood Modeller]<u>. <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>
 
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. ||
|}▼
 
 
▲TUFLOW models typically require access to a GIS package, text editor, Microsoft Excel and a results viewer to build, review and visualise a model. Refer to the following Wiki page to view a list of compatible packages. Alternatively, Flood Modeller may be used as a GUI for creating and editing GIS layers in a TUFLOW model and also for visualising the results. Instructions for this Flood Modeller – TUFLOW tutorial model have been provided using the following GIS file formats:
▲*QGIS - SHP
* QGIS - GPKG
 
=Module Data=
ToAll builddata to complete the tutorial model,has downloadbeen one of the datasets below. Thisprovided, includesincluding a digital elevation model (DEM), aerial photography, backgroundand a complete Flood Modeller model. dataData for thethis tutorial modelis andprovided in a working versionvariety of thedifferent model.GIS There are twocompatible formats available, Shapefile and GeoPackage. GeoPackageDownload hasthe beendataset supportedthat sincematches the 2023-03GIS Release,software foryou tipsare on its use see <u>[httpsusing://wiki.tuflow.com/GeoPackage_Tips GeoPackage Tips]</u>.
*[https://downloads.tuflow.com/_archive/TUFLOW/Tutorial_Model/FMT_Tutorial_QGIS.zip QGIS SHP Data Download]
*[https://downloads.tuflow.com/_archive/TUFLOW/Tutorial_Model/FMT_Tutorial_QGIS_GPKGFMT_Tutorial_Data_MapInfo.zip QGIS GPKGMapInfo Data Download]
*[https://downloads.tuflow.com/_archive/TUFLOW/Tutorial_Model/FMT_Tutorial_Data_ArcGIS.zip ArcGIS Data Download]
If would you like to download the tutorial model datasets for ArcGIS or MapInfo, these can be found on the [[Flood_Modeller_Tutorial_Model_Archive | Archive Page]].
 
=Recommended Reading=
The aim of this tutorial is to demonstrate the steps undertaken to build, review and visualise the results of a linked Flood Modeller – TUFLOW model. It assumes that the user has a good understanding of both the 1D component of Flood Modeller and the 1D and 2D components of TUFLOW. The following resources may be of use:
*[[Tutorial_Introduction | TUFLOW Tutorial Model]]
*[ https://docs.tuflow.com/classic-hpc/manual/2025.0latest/ TUFLOW Classic / HPC User Manual]
*[ https://helpwww.floodmodeller.com/docsmedia/getting-started-with-1d-river-modelling34731/isis_1d_quick_start_guide.pdf Flood Modeller 1D Quick Start Guide]
*[ https://help.floodmodeller.com/docs/technical-reference Flood Modeller TechnicalUser ReferenceManual]
 
 
=Modules=
The tutorial is presented over a series of modules, with each module offering the opportunity to run the model and review the results. Each of the modules builds upon the previous iteration with models developed in the previous module made available.
New users are advised to undertake the modules in sequence, whilst more experienced users can skip to modules containing specific features of interest. 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.▼
==Module 1: Linking Flood Modeller to TUFLOW==
The first tutorial module introduces the user to the linking of a TUFLOW 2D domain to a 1D Flood Modeller model. FromTo access this tutorialmodule youof willthe learntutorial howplease tosee linkthis an existingpage: [[Flood Modeller 1D model to a TUFLOW 2D domain. This tutorial is ideal for those starting to learn how to linkTutorial Module01|Flood Modeller andTutorial Module TUFLOW1]].<br>▼
<br>
From this tutorial you will learn how to link an existing Flood Modeller 1D model to a TUFLOW 2D domain.<br>
This tutorial is ideal for those starting to learn how to link Flood Modellder and TUFLOW.<br>
 
==Module 2: Linking Flood Modeller to ESTRY==
▲New users are advised to undertake the modules in sequence, whilst more experienced users can skip to modules containing specific features of interest. 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 second tutorial demonstrates the linking of an ESTRY pipe network to an existing Flood Modeller – TUFLOW linked model. To access this module of the tutorial please see this page:
 
[[Flood Modeller Tutorial Module02|Flood Modeller Tutorial Module 2]]. <br>
▲The first tutorial module introduces the user to the linking of a TUFLOW 2D domain to a 1D Flood Modeller model. From this tutorial you will learn how to link an existing Flood Modeller 1D model to a TUFLOW 2D domain. This tutorial is ideal for those starting to learn how to link Flood Modeller and TUFLOW.
 
From this tutorial you will learn how to add a 1D pipe network and connect it to the representation of the watercourse created in Flood Modeller and link it to the TUFLOW representation of the floodplain created as part of [[Flood Modeller Tutorial Module01|Flood Modeller Tutorial Module 1]]. This tutorial is ideal for those who would like to learn more about the interaction of TUFLOW with Flood Modeller including the simulation of fully integrated drainage systems.
:*<u>[[ Flood_Modeller_Tutorial_Module01 | Flood Modeller Module 1]]</u> - Linking Flood Modeller to TUFLOW
 
=Contact=
The second tutorial demonstrates the linking of an ESTRY pipe network to an existing Flood Modeller – TUFLOW linked model. From this tutorial you will learn how to add a 1D pipe network and connect it to the representation of the watercourse created in Flood Modeller and link it to the TUFLOW representation of the floodplain created as part of the first tutorial.
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>
 
<br>
The second tutorial is ideal for those who would like to learn more about the interaction of TUFLOW with Flood Modeller including the simulation of fully integrated drainage systems.
{{Tips Navigation
:*<u>[[ Flood_Modeller_Tutorial_Module02 | Flood Modeller Module 2]]</u> - Linking Flood Modeller to ESTRY
|uplink=[[Main_Page| Back to Main Page]]
▲|}}
Retrieved from "https://wiki.tuflow.com/Flood_Modeller_Tutorial_Model"