Difference between revisions of "TUFLOW SWMM Tutorial Introduction"

From Tuflow
Jump to navigation Jump to search
(47 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
On request from USA XPSWMM users, TUFLOW linkage with 1D EPA Storm Water Management Model (SWMM) has been added as a supported feature in TUFLOW 2023-03-AD release or newer. EPA SWMM is used for simulating urban watershed hydrologic and 1D hydraulic behavior. Initially developed in the early 1970's by the USA Environmental Protection Agency (EPA), the software has since undergone numerous updates and enhancements to become one of the most used 1D stormwater runoff and water quality analysis tools in North America. The primary uses of EPA SWMM include designing and evaluating stormwater systems and also planning and assessment of low-impact developments (also known as Water Sensitive Urban Design). For more details about EPA SWMM, please visit: <u>[https://www.epa.gov/water-research/storm-water-management-model-swmm  https://www.epa.gov/water-research/storm-water-management-model-swmm]</u>.
 +
 +
<br>
 +
This EPA SWMM series of tutorials has been written in USA English for the predominantly USA SWMM user base.
 +
 
= 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><br>
+
The following tutorial models are aimed at new and experienced users, stepping through the process of building and running TUFLOW SWMM together. The main objective aims to demonstrate the ability for TUFLOW to link to 1D EPA SWMM in a variety of different common use case scenarios.  
<br>
 
TUFLOW has supported 1D/2D dynamic coupling since its initial 2D solver development in 1989. Traditionally, 1D (1 Dimensional) linking and associated modelling has been applied using TUFLOW's 1D solver, ESTRY. As demonstrated in:
 
:*<u>[[Tutorial_M03 | Module 3]]</u>  - 1D Culverts
 
:*<u>[[Tutorial_M05 | Module 5]]</u>  - Integrated Urban Drainage
 
:*<u>[[Tutorial_M11 | Module 11]]</u> - 1D Open Channel<br>
 
New in 2023, TUFLOW's 1D linking and solver options have been expanded to include EPA Storm Water Management Model (SWMM). EPA SWMM is a widely used software for simulating urban and non-urban watersheds' hydrologic and 1D hydraulic behaviour. Initially developed in the early 1970's by the USA Environmental Protection Agency (EPA), the software has since undergone numerous updates and enhancements to become one of the most used 1D stormwater runoff and water quality analysis tools globally, particularly in North America.  The primary uses of EPA SWMM include designing and evaluating stormwater systems and also planning and assessment of low-impact development (also known as Water Sensitive Urban Design) techniques. For more details about EPA SWMM, please visit: <u>[https://www.epa.gov/water-research/storm-water-management-model-swmm</font> Storm Water Management Model]</u><br>
 
  
The following tutorial models are aimed at new and experienced users, stepping through the process of building and running TUFLOW and SWMM together. The main objective aims to demonstrate the ability of TUFLOW to link to 1D EPA SWMM in a variety of different use cases. If you are not familiar with TUFLOW already, we recommend first completing Module 1 and 2 of the <u>[[Tutorial_Introduction | "TUFLOW Only" Tutorials]]</u> to establish an understanding of 2D modelling, before progressing to learning how to link 1D EPA SWMM to 2D TUFLOW.
+
'''Note, if you are not already familiar with TUFLOW, we recommend first completing Module 1 and 2 of the <u>[[Tutorial_Introduction | "TUFLOW Only" Tutorials]]</u> to establish an understanding of 2D modeling, before progressing to learning how to link 1D EPA SWMM to 2D TUFLOW.'''<br>
<br>
+
<br>TUFLOW has supported 1D/2D dynamic coupling since its initial 2D solver development in 1989. Traditionally, 1D (1 Dimensional) linking and associated modeling has been applied using TUFLOW's 1D solver, ESTRY. As demonstrated in:
 +
:*<u>[[Tutorial_M03 | Module 3 - 1D Culverts]]</u>
 +
:*<u>[[Tutorial_M05 | Module 5 - Integrated Urban Pipe Network Drainage]]</u>
 +
:*<u>[[Tutorial_M11 | Module 11 - 1D Open Channel]]</u> <br>
 +
EPA SWMM's inclusion in TUFLOW does not replace ESTRY, rather both 1D solvers complement each other. Links to the TUFLOW SWMM tutorials are included in the section below.
  
=Requirements and Downloads=
+
=Software Requirements=
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>
+
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 modeling environment. Notably, QGIS does not experience the data load/visualization lag and display issues some other hydraulic modeling software GUI's are limited by when working with larger datasets.<br>
  
 
{| class="wikitable" width="75%"
 
{| class="wikitable" width="75%"
Line 20: Line 23:
 
! style="background-color:#005581; font-weight:bold; color:white;" | Download
 
! 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>
+
| '''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 or quadtree mesh of square elements.<br>
 
It is recommended to always use the latest release version of TUFLOW.<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 model does not require a TUFLOW license.<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>
+
This tutorial is configured to use a NVIDIA GPU card. If this is not available, your CPU can be used via the Hardware command. <br>
||The TUFLOW executable is provided within the <u>[https://wiki.tuflow.com/TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Data_Download Tutorial Download Dataset]</u>.
+
||The TUFLOW executable is provided within the <u>[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Data | Tutorial Download 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 || QGIS is the Geographic Information System (GIS) Graphical User Interface (GUI) used to build models and view results. The QGIS TUFLOW plugin includes numerous tools to increase workflow efficiency.
The TUFLOW plugin includes numerous tools to increase workflow efficiency. <br>
+
 
 +
 
 +
 
 +
This tutorial was developed using QGIS 3.34 and QGIS TUFLOW Plugin 3.11. Please use these or newer versions of QGIS and the plugin. Earlier releases will not include the TUFLOW SWMM automation tools demonstrated in the Tutorials.  
  
 
||<u>[https://qgis.org/en/site/forusers/download.html Latest 64-bit version of QGIS]</u>. <br><br>
 
||<u>[https://qgis.org/en/site/forusers/download.html Latest 64-bit version of QGIS]</u>. <br><br>
Line 35: Line 41:
 
<u>[[TUFLOW_QGIS_Plugin| QGIS TUFLOW Plugin Installation]]</u>.
 
<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>
+
| '''NotePad++''' <br><br>Syntax Highlighting || A text editor is required for creation of the TUFLOW control (script) files. This tutorial was developed with NotePad++. Ideally a text editor should be able to:<br>
*Colour code the TUFLOW control files;
+
*Color code the TUFLOW control files;
 
*Open other files from the active control file; and
 
*Open other files from the active control file; and
*Launch a TUFLOW simulation. <br><br>
+
*Launch a TUFLOW simulation. <br>
TUFLOW colour coding can be enabled using syntax highlighting.  
+
TUFLOW color 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://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://www.tuflow.com/Download/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 modeling, 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. ||  
+
| '''Microsoft Excel''' || A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created using Excel. ||  
 
|}
 
|}
  
 
<br>
 
<br>
  
=Tutorial Data Download=
+
=Tutorial Data=
To build the tutorial model, download the dataset below. This includes a digital elevation model (DEM), aerial photography, background model data for the tutorial model and a working version of the model. GeoPackage has been used as the GIS format for the model build tasks. For tips on using Geopackage see <u>[https://wiki.tuflow.com/GeoPackage_Tips GeoPackage Tips]</u>.  
+
To build the tutorial model, download the dataset below. This includes a digital elevation model (DEM), aerial photography, background model data for the tutorial model and a working version of the model. GeoPackage database has been used as the GIS format for the model build tasks. For tips on using GeoPackage databases see <u>[https://wiki.tuflow.com/GeoPackage_Tips GeoPackage Tips]</u>.  
:*<u>[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/Wiki_TUFLOW_SWMM_Tutorial_Models_QGIS_GPKG.zip  TUFLOW SWMM Tutorial Dataset - QGIS - GPKG]</u>
+
:*<u>[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/TUFLOW_SWMM_Tutorial_Models_QGIS_GPKG.zip  TUFLOW SWMM Tutorial Dataset - QGIS - GPKG]</u>
  
 
=Tutorial Modules=
 
=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, they can be created by running the model simulations. The folder should be placed in a location 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; they will be created when running the model simulations. 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 several modules. All modules can be completed independently, however new users are encouraged to undertake the modules in sequence:
  
 
:*<u>[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]]</u>  - 1D SWMM Culverts
 
:*<u>[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]]</u>  - 1D SWMM Culverts
:*<u>[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]]</u>  - 1D SWMM Pipe Network / 2D Direct Rainfall Hydrology
+
:*<u>[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]]</u>  - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
 
:*<u>[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]]</u>  - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
 
:*<u>[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]]</u>  - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
:*<u>[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]]</u>  - 1D SWMM Pipe Network / 1D SWMM Catchment Hydrology
+
:*<u>[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]]</u>  - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
 +
:*<u>[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]]</u>  - How to convert an XPSWMM model to TUFLOW SWMM.
 +
 
 +
== TUFLOW SWMM Documentation ==
 +
TUFLOW SWMM documentation can be found in the 2023-03-AD release notes for TUFLOW-SWMM and in the TUFLOW plugin documentation for the related QGIS tools.
 +
 
 +
* <u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/ TUFLOW 2023-03-AD Release notes - SWMM Section]</u>
 +
* <u>[[TUFLOW QGIS Plugin#Processing_Toolbox|TUFLOW QGIS Plugin Documentation including SWMM tools]]</u>
  
 
=Recommended Further Reading=
 
=Recommended Further Reading=
 
For users who wish to get a better understanding of either 1D EPA SWMM or 2D TUFLOW, the following resources may be of use:
 
For users who wish to get a better understanding of either 1D EPA SWMM or 2D TUFLOW, the following resources may be of use:
*[https://www.epa.gov/water-research/storm-water-management-model-swmm Storm Water Management Model (SWMM) User Manual]
+
<br><br>
*[https://www.tuflow.com/downloads/#tuflow TUFLOW User Manual and Release Notes]
+
'''EPA SWMM''': <u>[https://www.epa.gov/water-research/storm-water-management-model-swmm www.epa.gov]</u>
*[[Tutorial_Introduction | TUFLOW Tutorial Models]]
+
*<u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)]</u>
 +
*<u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics) ]</u>
 +
*<u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydraulics_Addendum-20220210mas2wr.pdf  SWMM5 Reference Manual - Volume 2 (Hydraulics Addendum) ]</u>
 +
*<u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume3_Water_Quality_P100P2NY.pdf  SWMM5 Reference Manual - Volume 3 (Water Quality) ]</u>
 +
*<u>[https://downloads.tuflow.com/SWMM/SWMM5_User%27s_Manual.pdf EPA SWMM5 User's Manual]</u>
 +
<br>
 +
'''TUFLOW''': <u>[https://www.tuflow.com www.tuflow.com]</u>
 +
*<u>[https://www.tuflow.com/downloads/#tuflow TUFLOW User Manual]</u>
 +
*<u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD TUFLOW 2023-03-AD release notes]</u>
 +
*<u>[[Tutorial_Introduction#Tutorial_Modules | TUFLOW Tutorial Models]]</u>
  
=Contact=
 
For comments, requests and feedback contact <font color="blue"><u>support@tuflow.com</u></font>.<br>
 
<br>
 
  
 
{{Tips Navigation
 
{{Tips Navigation
|uplink=[[Main_Page| Back to Main Page]]
+
|uplink=[[Main_Page| Back to Wiki Main Page]]
 
}}
 
}}

Revision as of 13:20, 24 April 2024

On request from USA XPSWMM users, TUFLOW linkage with 1D EPA Storm Water Management Model (SWMM) has been added as a supported feature in TUFLOW 2023-03-AD release or newer. EPA SWMM is used for simulating urban watershed hydrologic and 1D hydraulic behavior. Initially developed in the early 1970's by the USA Environmental Protection Agency (EPA), the software has since undergone numerous updates and enhancements to become one of the most used 1D stormwater runoff and water quality analysis tools in North America. The primary uses of EPA SWMM include designing and evaluating stormwater systems and also planning and assessment of low-impact developments (also known as Water Sensitive Urban Design). For more details about EPA SWMM, please visit: https://www.epa.gov/water-research/storm-water-management-model-swmm.


This EPA SWMM series of tutorials has been written in USA English for the predominantly USA SWMM user base.

Introduction

The following tutorial models are aimed at new and experienced users, stepping through the process of building and running TUFLOW SWMM together. The main objective aims to demonstrate the ability for TUFLOW to link to 1D EPA SWMM in a variety of different common use case scenarios.

Note, if you are not already familiar with TUFLOW, we recommend first completing Module 1 and 2 of the "TUFLOW Only" Tutorials to establish an understanding of 2D modeling, before progressing to learning how to link 1D EPA SWMM to 2D TUFLOW.

TUFLOW has supported 1D/2D dynamic coupling since its initial 2D solver development in 1989. Traditionally, 1D (1 Dimensional) linking and associated modeling has been applied using TUFLOW's 1D solver, ESTRY. As demonstrated in:

EPA SWMM's inclusion in TUFLOW does not replace ESTRY, rather both 1D solvers complement each other. Links to the TUFLOW SWMM tutorials are included in the section below.

Software Requirements

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 modeling environment. Notably, QGIS does not experience the data load/visualization lag and display issues some other hydraulic modeling software GUI's are limited by when working with larger datasets.

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 or quadtree mesh of square elements.

It is recommended to always use the latest release version of TUFLOW.

This tutorial model does not require a TUFLOW license.

This tutorial is configured to use a NVIDIA GPU card. If this is not available, your CPU can be used via the Hardware command.

The TUFLOW executable is provided within the Tutorial Download Dataset.
QGIS

QGIS TUFLOW plugin
QGIS is the Geographic Information System (GIS) Graphical User Interface (GUI) used to build models and view results. The QGIS TUFLOW plugin includes numerous tools to increase workflow efficiency.


This tutorial was developed using QGIS 3.34 and QGIS TUFLOW Plugin 3.11. Please use these or newer versions of QGIS and the plugin. Earlier releases will not include the TUFLOW SWMM automation tools demonstrated in the Tutorials.

Latest 64-bit version of QGIS.

QGIS TUFLOW Plugin Installation.

NotePad++

Syntax Highlighting
A text editor is required for creation of the TUFLOW control (script) files. This tutorial was developed with NotePad++. Ideally a text editor should be able to:
  • Color code the TUFLOW control files;
  • Open other files from the active control file; and
  • Launch a TUFLOW simulation.

TUFLOW color 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 modeling, see Notepad++ tips.

Microsoft Excel A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created using Excel.


Tutorial Data

To build the tutorial model, download the dataset below. This includes a digital elevation model (DEM), aerial photography, background model data for the tutorial model and a working version of the model. GeoPackage database has been used as the GIS format for the model build tasks. For tips on using GeoPackage databases see GeoPackage Tips.

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; they will be created when running the model simulations. The folder should be placed in a location with write permissions.

The tutorial model is presented in several modules. All modules can be completed independently, however new users are encouraged to undertake the modules in sequence:

TUFLOW SWMM Documentation

TUFLOW SWMM documentation can be found in the 2023-03-AD release notes for TUFLOW-SWMM and in the TUFLOW plugin documentation for the related QGIS tools.

Recommended Further Reading

For users who wish to get a better understanding of either 1D EPA SWMM or 2D TUFLOW, the following resources may be of use:

EPA SWMM: www.epa.gov


TUFLOW: www.tuflow.com


Up
Go-up.png Back to Wiki Main Page