Difference between revisions of "Flood Modeller Tutorial Model"

From Tuflow
Jump to navigation Jump to search
 
(44 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
=Introduction=
 
=Introduction=
 
The objective of this Flood Modeller – TUFLOW model is to demonstrate the ability of TUFLOW to link to an external 1D scheme and the various methods available in which to create this link. It is designed to supplement existing documentation and assumes the user has some prior knowledge of both the Flood Modeller and TUFLOW software packages.
 
The objective of this Flood Modeller – TUFLOW model is to demonstrate the ability of TUFLOW to link to an external 1D scheme and the various methods available in which to create this link. It is designed to supplement existing documentation and assumes the user has some prior knowledge of both the Flood Modeller and TUFLOW software packages.
−
This tutorial model has been developed by BMT WBM with CH2MHill. Please post comments, requests and feedback to the [[Talk:FM Tutorial Model|Discussion Page]] or contact [mailto:support@tuflow.com support@tuflow.com].
+
This tutorial model has been developed by BMT with Jacobs. Please post comments, requests and feedback to [mailto:support@tuflow.com support@tuflow.com].
−
=Requirements=
+
 
−
==Hardware==
+
=Requirements and Downloads=
−
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 XP or later.
+
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.  
−
==Software==  
+
 
−
===TUFLOW===
+
{| class="wikitable" width="75%"
−
TUFLOW build 2016-03-AD or later is required for this tutorial model. This can be obtained from the [http://tuflow.com/Tuflow%20Latest%20Release.aspx downloads section] of the TUFLOW website. It is recommended that you use the latest release version of TUFLOW, both 32 bit and 64 bit versions are available.
+
 
−
This tutorial model does not require a TUFLOW licence in order to be simulated, and no additional drivers should be required.
+
! 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 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 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
  
−
===Flood Modeller===
 
−
Version 4.2 of Flood Modeller or later is required for this tutorial model. Currently, a valid license for Flood Modeller and the TUFLOW link is required to simulate this tutorial model however we are currently working with CH2M to allow for this model to be simulated license free.
 
−
===GIS Software===
 
−
TUFLOW models typically require access to a GIS, 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 and modelling packages:
 
−
*MapInfo
 
−
*QGIS
 
−
*ArcGIS
 
−
*Flood Modeller
 
 
=Module Data=
 
=Module Data=
−
Some model data is provided including a digital elevation model (DEM), aerial photography and a working Flood Modeller model. The required background model data for the tutorial model is available for download on the TUFLOW website.  
+
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>.
−
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 may need to edit the file in a text editor and change the path to the executable (ISISf32.exe), save then double click on the .bat file in Windows Explorer to initiate the simulations.
+
*[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_GPKG.zip QGIS GPKG Data Download (please ignore under construction)]
 +
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=
 
=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:
 
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_Model | TUFLOW Tutorial Model]]
+
*[[Tutorial_Introduction | TUFLOW Tutorial Model]]
−
*[http://tuflow.com/Tuflow%20Documentation.aspx TUFLOW User Manual]
+
*[ https://docs.tuflow.com/classic-hpc/manual/2025.0/ TUFLOW Classic / HPC User Manual]
−
*[https://www.floodmodeller.com/media/34731/isis_1d_quick_start_guide.pdf Flood Modeller 1D Quick Start Guide]
+
*[ https://help.floodmodeller.com/docs/getting-started-with-1d-river-modelling Flood Modeller 1D Quick Start Guide]
−
*[http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]
+
*[ https://help.floodmodeller.com/docs/technical-reference Flood Modeller Technical Reference]
 +
 
 +
 
 
=Modules=
 
=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.  
 
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: <u>[[Flood Modeller Tutorial Module01|Flood Modeller Tutorial Module 1]]</u>.
 
  
−
==Module 2: Linking Flood Modeller to ESTRY (x1DH)==
+
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.
+
 
−
==Module 3: Linking Flood Modeller to ESTRY (x1DQ)==
+
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.
−
The third tutorial demonstrates the linking of an existing Flood Modeller – TUFLOW model that outfalls to an ESTRY network.
+
 
 +
:*<u>[[ Flood_Modeller_Tutorial_Module01 | Flood Modeller Module 1]]</u>  - Linking Flood Modeller to TUFLOW
 +
 
 +
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.
 +
 
 +
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.
 +
:*<u>[[ Flood_Modeller_Tutorial_Module02 | Flood Modeller Module 2]]</u>  - Linking Flood Modeller to ESTRY

Latest revision as of 19:39, 2 May 2025

Introduction

The objective of this Flood Modeller – TUFLOW model is to demonstrate the ability of TUFLOW to link to an external 1D scheme and the various methods available in which to create this link. It is designed to supplement existing documentation and assumes the user has some prior knowledge of both the Flood Modeller and TUFLOW software packages. This tutorial model has been developed by BMT with Jacobs. Please post comments, requests and feedback to support@tuflow.com.

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.

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 commonly used in the UK and Ireland, Australia and the United States for the modelling of surface waters, river systems and pipe networks.

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

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.

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.

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.

Latest 64-bit version of Flood Modeller.

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.


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

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.

If would you like to download the tutorial model datasets for ArcGIS or MapInfo, these can be found on the 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:


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.

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.

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.

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.

Retrieved from "https://wiki.tuflow.com/w/index.php?title=Flood_Modeller_Tutorial_Model&oldid=43231"