Flood Modeller Tutorial Model: Difference between revisions

Content deleted Content added
No edit summary
Line 1:
=Introduction=
The objective of thisthe Flood Modeller - TUFLOW modelmodules is to demonstrate the ability ofhow TUFLOW to linklinks to anthe external Flood Modeller 1D scheme and the various methods available in which to create this link. ItThey isare designed to supplement existing documentation and assumes the user has someassume prior knowledge of both the Flood Modeller and TUFLOW software packages.
 
ThisThese tutorialmodules model has beenwere developed by BMT in collaboration with Jacobs. Please post commentsComments, requests and feedback can be sent to [mailto:support@tuflow.com support@tuflow.com].
 
=Requirements and Downloads=
Both TUFLOW and Flood Modeller have relatively modest system requirements for small models such as thethose tutorialused model.in these However,modules. largerLarger and more complex models, however, may haverequire higher hardware requirementsspecifications, - in particularparticularly memory (RAM). The Bothtutorial softwaremodels are availableintentionally insmall 32to ensure quick simulation and 64load bittimes, versionsand should run on any modern PC or laptop capable of running Windows 7 or later.
 
==Hardware==
TUFLOW models typically require access to a GIS package, a text editor, Microsoft Excel and a results viewer to build, review and visualise a model. ReferA tolist theof followingcompatible Wikipackages pageis toavailable viewon athe list ofTUFLOW compatible packagesWiki. Alternatively, Flood Modeller maycan also be used as a GUIgraphical user interface for creating and editing GIS layers in a TUFLOW model, andas alsowell as for visualising the results.
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==
Instructions for this Flood Modeller - TUFLOW tutorialmodules model have beenare provided using the following GIS and modellingfile packagesformats:
===TUFLOW===
 
* '''<u>QGIS - SHP</u>'''
 
* '''<u>QGIS - GPKG</u>'''
 
{| 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 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 commonly used in the UK and Ireland, Australia and the United States for the modelling of surface waters, river systems and pipe networks. <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 specfied within the [https://docs.tuflow.com/classic-hpc/manual/2025.2/TCFCommands-1.html#tcfHardware 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. 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. [https://docs.tuflow.com/classic-hpc/manual/2025.2/OneD2DLinkingFM-2.html#fig:fig-FMTUFLOWVersionCompatability Figure 10.15] of the [https://docs.tuflow.com/classic-hpc/manual/2025.2/ 2025 TUFLOW manual] provides a list of compatibility between recent Flood Modeller and TUFLOW versions. <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.
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>
||<u>[https://www.floodmodeller.com/downloads/ Latest 64-bit version of Flood Modeller]<u>. <br><br>
|-
| '''QGIS''' <br><br>QGIS TUFLOW plugin || A 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>
===Flood Modeller===
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.
 
||<u>[https://qgis.org/download/ Latest 64-bit version of QGIS]</u>. <br><br>
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>
 
<u>[[TUFLOW_QGIS_Plugin| QGIS TUFLOW Plugin Installation]]</u>.
===GIS Software===
|-
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.
| '''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>
Instructions for this Flood Modeller – TUFLOW tutorial model have been provided using the following GIS and modelling packages:
*Colour code the TUFLOW control files;
*MapInfo
*Open other files from the active control file; and
*QGIS
*Launch a TUFLOW simulation. <br>
*ArcGIS
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. ||
|}
=Module Data=
AllTo data to completebuild the tutorial hasmodel, beendownload provided,one of the datasets below. This includingincludes a digital elevation model (DEM), aerial photography, background model data for the tutorial model and a completeworking Floodversion Modellerof the model. DataThere forare thistwo tutorialformats isavailable, providedShapefile inand aGeoPackage. varietyThe ofGeoPackage differentformat GIShas compatiblebeen formats.supported Downloadsince the dataset2023-03 thatRelease, matchesfor thetips GISon softwareits youuse aresee using<u>[https://wiki.tuflow.com/GeoPackage_Tips GeoPackage Tips]</u>.
*[https://downloads.tuflow.com/_archive/TUFLOW/Tutorial_Model/FMT_Tutorial_QGISQGIS_SHP_FMP_Tut_Model.zip QGIS DataSHP Download]
*[https://downloads.tuflow.com/_archive/TUFLOW/Tutorial_Model/FMT_Tutorial_Data_MapInfoQGIS_GPKG_FMP_Tut_Model.zip MapInfoQGIS DataGPKG 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]].
*[https://downloads.tuflow.com/_archive/TUFLOW/Tutorial_Model/FMT_Tutorial_Data_ArcGIS.zip ArcGIS Data Download]
 
=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/latest2025.2/ TUFLOW Classic / HPC User Manual]
*[https://wwwhelp.floodmodeller.com/mediadocs/34731/isis_1d_quick_start_guide.pdfgetting-started-with-1d-river-modelling Flood Modeller 1D Quick Start Guide]
*[https://help.floodmodeller.com/docs/technical-reference Flood Modeller UserTechnical ManualReference]
 
=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.
==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. To access this module of the tutorial please see this page: [[Flood Modeller Tutorial Module01|Flood Modeller Tutorial Module 1]].<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>
 
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, but can be generated through the running of the simulations. The folder should be placed in a location with write permissions. 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.
==Module 2: Linking Flood Modeller to ESTRY==
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>
 
:*<u>[[ Flood_Modeller_Tutorial_Module01_Provisional | Flood Modeller Module 1]]</u> - Linking Flood Modeller to 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.
 
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 [[Floodthe Modellerfirst Tutorial Module01|Flood Modeller Tutorial Module 1]]tutorial. ThisThe 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.
=Contact=
:*<u>[[ Flood_Modeller_Tutorial_Module02_Provisional | Flood Modeller Module 2]]</u> - Linking Flood Modeller to ESTRY
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>