Difference between revisions of "TUFLOW CATCH Tutorial Introduction"

From Tuflow
Jump to navigation Jump to search
 
(10 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
The following tutorial models are aimed at new and experienced users, stepping through the process of building and running TUFLOW CATCH together. These tutorials aim to demonstrate the power and flexibility of TUFLOW CATCH in simulating catchment-wide hydrologic, hydraulic, pollutant export, and receiving waterway processes. TUFLOW CATCH enables detailed simulation of surface and subsurface flows, pollutant transport, and downstream environmental impact without relying on lumped or average assumptions.
 
The following tutorial models are aimed at new and experienced users, stepping through the process of building and running TUFLOW CATCH together. These tutorials aim to demonstrate the power and flexibility of TUFLOW CATCH in simulating catchment-wide hydrologic, hydraulic, pollutant export, and receiving waterway processes. TUFLOW CATCH enables detailed simulation of surface and subsurface flows, pollutant transport, and downstream environmental impact without relying on lumped or average assumptions.
  
'''Note, if you are not already familiar with TUFLOW, we recommend first completing Module 1, 2, 3 and 6 of the <u>[[Tutorial_Introduction | TUFLOW Tutorials]]</u> to establish an understanding of 1D and 2D modeling, as well as direct rainfall models.'''<br>
+
'''Note: Users new to TUFLOW are encouraged to first complete Module 1, 2, 3 and 6 of the <u>[[Tutorial_Introduction | TUFLOW Tutorials]]</u>. These modules cover key concepts in 1D and 2D modeling, as well as direct rainfall models.'''
  
 
=Software Requirements=
 
=Software Requirements=
Line 18: Line 18:
 
This tutorial model does not require a TUFLOW license.<br>
 
This tutorial model does not require a TUFLOW license.<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>
+
This tutorial is configured to use a NVIDIA GPU card. If this is not available, your CPU can be used via the Hardware command.
 +
This tutorial is set up to use a NVIDIA GPU card. If this is not available, the simulations can be run on CPU using the <tt><font color=blue>Hardware </font><font color=red>==</font> CPU</tt> command.
 
||The TUFLOW executable is provided within the <u>[[TUFLOW_CATCH_Tutorial_Introduction#Tutorial_Data | Tutorial Download Dataset]]</u>.
 
||The TUFLOW executable is provided within the <u>[[TUFLOW_CATCH_Tutorial_Introduction#Tutorial_Data | Tutorial Download Dataset]]</u>.
 
|-
 
|-
Line 46: Line 47:
 
| '''Microsoft Excel''' || A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created using Excel. ||  
 
| '''Microsoft Excel''' || A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created using Excel. ||  
 
|}
 
|}
 
<br>
 
  
 
=Tutorial Data=
 
=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 models and a working version of each model.   
 
To build the tutorial model, download the dataset below. This includes a digital elevation model (DEM), aerial photography, background model data for the tutorial models and a working version of each model.   
:*<u>[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/TUFLOW_CATCH_Tutorial_Models_QGIS.zip TUFLOW CATCH Tutorial Dataset - QGIS]</u>
+
:*<u>[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/TUFLOW_CATCH_Tutorial_Models.zip TUFLOW CATCH Tutorial Dataset - QGIS]</u>
  
 
=Tutorial Modules=
 
=Tutorial Modules=
Line 58: Line 57:
 
There are four tutorial models. All models can be completed independently, however it is encourages to complete them in sequence:
 
There are four tutorial models. All models can be completed independently, however it is encourages to complete them in sequence:
  
:*<u>[[TUFLOW_CATCH_Tutorial_M01 | TUFLOW CATCH Module 1]]</u>  - Pollutant Export
+
:*<u>[[TUFLOW_CATCH_Tutorial_M01 | TUFLOW CATCH Tutorial 01]]</u>  - Pollutant Export
:*<u>TUFLOW CATCH Module 2</u>  - Hydrology (Coming soon)
+
:*<u>[[TUFLOW_CATCH_Tutorial_M02 | TUFLOW CATCH Tutorial 02]]</u>  - Interventions
:*<u>TUFLOW CATCH Module 3</u>  - Integrated (Coming soon)
+
:*<u>TUFLOW CATCH Tutorial 03</u>  - Hydrology (Coming soon)
:*<u>TUFLOW CATCH Module 4</u>  - Interventions (Coming soon)
+
:*<u>TUFLOW CATCH Tutorial 04</u>  - Integrated (Coming soon)
  
 
== TUFLOW CATCH Documentation ==
 
== TUFLOW CATCH Documentation ==
Line 69: Line 68:
 
* <u>[https://docs.tuflow.com/catch/changelog/ TUFLOW CATCH Changelog]</u>
 
* <u>[https://docs.tuflow.com/catch/changelog/ TUFLOW CATCH Changelog]</u>
  
=Recommended Further Reading=
+
=Contact=
For users who wish to get a better understanding of either 1D EPA SWMM or 2D TUFLOW, the following resources may be of use:
 
<br><br>
 
'''EPA SWMM''': <u>[https://www.epa.gov/water-research/storm-water-management-model-swmm www.epa.gov]</u>
 
*<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/swmm-users-manual-version-5.2.pdf EPA SWMM5 User's Manual]</u>
 
 
 
  
 +
For comments, requests and feedback contact <u>[mailto:support@tuflow.com support@tuflow.com]</u>.<br>
 
<br>
 
<br>
'''TUFLOW''': <u>[https://www.tuflow.com www.tuflow.com]</u>
 
*<u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW 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>
 
 
  
 
{{Tips Navigation
 
{{Tips Navigation
 
|uplink=[[Main_Page| Back to Wiki Main Page]]
 
|uplink=[[Main_Page| Back to Wiki Main Page]]
 
}}
 
}}

Latest revision as of 10:26, 29 May 2025

Introduction

The following tutorial models are aimed at new and experienced users, stepping through the process of building and running TUFLOW CATCH together. These tutorials aim to demonstrate the power and flexibility of TUFLOW CATCH in simulating catchment-wide hydrologic, hydraulic, pollutant export, and receiving waterway processes. TUFLOW CATCH enables detailed simulation of surface and subsurface flows, pollutant transport, and downstream environmental impact without relying on lumped or average assumptions.

Note: Users new to TUFLOW are encouraged to first complete Module 1, 2, 3 and 6 of the TUFLOW Tutorials. These modules cover key concepts in 1D and 2D modeling, as well as direct rainfall models.

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. This tutorial is set up to use a NVIDIA GPU card. If this is not available, the simulations can be run on CPU using the Hardware == CPU command.

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

QGIS TUFLOW plugin

QGIS TUFLOW CATCH 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 QGIS TUFLOW CATCH plugin includes CATCH specific tools.


This tutorial was developed using QGIS 3.42, QGIS TUFLOW plugin 3.14 and QGIS TUFLOW CATCH plugin 0.48. Please use these or newer versions of QGIS and the plugins.

Latest 64-bit version of QGIS.

QGIS TUFLOW Plugin Installation.

QGIS TUFLOW CATCH Plugin. For instructions on installing a plugin from a ZIP, see Install from ZIP.

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 models and a working version of each model.

Tutorial Modules

The download dataset contains the input files and working version of the tutorial models 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.

There are four tutorial models. All models can be completed independently, however it is encourages to complete them in sequence:

TUFLOW CATCH Documentation

TUFLOW CATCH documentation can be found in the TUFLOW CATCH Manual and the TUFLOW CATCH Changelog.

Contact

For comments, requests and feedback contact support@tuflow.com.

Up
Go-up.png Back to Wiki Main Page