Tuflow - User contributions [en]

Education Licence New User Guide

2026-05-05T05:40:17Z

Chris Huxley:

There are a number of options available for University education and research purposes:
* Teach TUFLOW using the licence free TUFLOW tutorials.
* Teach TUFLOW or conduct research using your own dataset via TUFLOW's free education (demo) mode.
* Purchase a licence for unrestricted use.

The following information is not applicable to commercial use of TUFLOW. 

=TUFLOW Tutorial Models=
Educators are welcome to use the licence free TUFLOW tutorial models and documentation as an education dataset. The benefit of this approach is that there will be no licencing complications for the students. Students will be able to run simulations on any computer at any time. Visit [[Tutorial_Introduction | TUFLOW Wiki Self-teach Tutorials]]. 

Educators are welcome to create course content from this dataset. Alternatively, the TUFLOW Team have previously created 10 weeks worth of university teaching material, including 2 weeks worth of assessment, using the tutorial dataset for the guided modelling tasks. If you would like assistance creating similar teaching material please email [mailto:training@tuflow.com training@tuflow.com].

=TUFLOW's Free Education (Demo) Mode=

Universities are welcome to use TUFLOW's licence free Demo mode for research or education purposes. The free Demo option is included within the standard TUFLOW executable. It is fully enabled, will function in any geographic region, though has the following limits:
:*100,000 total cells and 30,000 active (potentially flooded) cells
:*100 1D channels
:*There can only be one CPU 2D domain (M2D is not supported). HPC Quadtree is supported.
:*A simulation time of 10 minutes.
:*CPU and GPU compute are supported.
The free Demo mode is called using the TUFLOW Control File (TCF) command: <tt>Demo Model </tt> <tt>== </tt><tt>ON</tt> 

Educators who would like to teach TUFLOW can create course content that works within the limits of the Demo mode. If you would like assistance creating teaching material using this simulation mode please email [mailto:training@tuflow.com training@tuflow.com].

=TUFLOW Licence=
To purchase a licence, please email [mailto:sales@tuflow.com sales@tuflow.com] for a quote.

Education Licence New User Guide

2026-05-05T05:39:40Z

Chris Huxley:

There are a number of options available for University education and research purposes:
* Teach TUFLOW using the licence free TUFLOW tutorials.
* Teach TUFLOW or conduct research using your own dataset via TUFLOW's free education (demo) mode.
* Purchase a licence.

The following information is not applicable to commercial use of TUFLOW. 

=TUFLOW Tutorial Models=
Educators are welcome to use the licence free TUFLOW tutorial models and documentation as an education dataset. The benefit of this approach is that there will be no licencing complications for the students. Students will be able to run simulations on any computer at any time. Visit [[Tutorial_Introduction | TUFLOW Wiki Self-teach Tutorials]]. 

Educators are welcome to create course content from this dataset. Alternatively, the TUFLOW Team have previously created 10 weeks worth of university teaching material, including 2 weeks worth of assessment, using the tutorial dataset for the guided modelling tasks. If you would like assistance creating similar teaching material please email [mailto:training@tuflow.com training@tuflow.com].

=TUFLOW's Free Education (Demo) Mode=

Universities are welcome to use TUFLOW's licence free Demo mode for research or education purposes. The free Demo option is included within the standard TUFLOW executable. It is fully enabled, will function in any geographic region, though has the following limits:
:*100,000 total cells and 30,000 active (potentially flooded) cells
:*100 1D channels
:*There can only be one CPU 2D domain (M2D is not supported). HPC Quadtree is supported.
:*A simulation time of 10 minutes.
:*CPU and GPU compute are supported.
The free Demo mode is called using the TUFLOW Control File (TCF) command: <tt>Demo Model </tt> <tt>== </tt><tt>ON</tt> 

Educators who would like to teach TUFLOW can create course content that works within the limits of the Demo mode. If you would like assistance creating teaching material using this simulation mode please email [mailto:training@tuflow.com training@tuflow.com].

=TUFLOW Licence=
To purchase a licence, please email [mailto:sales@tuflow.com sales@tuflow.com] for a quote.

Education Licence New User Guide

2026-05-05T05:39:27Z

Chris Huxley: /* TUFLOW Research Licence */

There are a number of options available for University education and research purposes:
* Teach TUFLOW using the licence free TUFLOW tutorials.
* Teach TUFLOW or conduct research using your own dataset via TUFLOW's free education (demo) mode.
* Purchase a research licence.

The following information is not applicable to commercial use of TUFLOW. 

=TUFLOW Tutorial Models=
Educators are welcome to use the licence free TUFLOW tutorial models and documentation as an education dataset. The benefit of this approach is that there will be no licencing complications for the students. Students will be able to run simulations on any computer at any time. Visit [[Tutorial_Introduction | TUFLOW Wiki Self-teach Tutorials]]. 

Educators are welcome to create course content from this dataset. Alternatively, the TUFLOW Team have previously created 10 weeks worth of university teaching material, including 2 weeks worth of assessment, using the tutorial dataset for the guided modelling tasks. If you would like assistance creating similar teaching material please email [mailto:training@tuflow.com training@tuflow.com].

=TUFLOW's Free Education (Demo) Mode=

Universities are welcome to use TUFLOW's licence free Demo mode for research or education purposes. The free Demo option is included within the standard TUFLOW executable. It is fully enabled, will function in any geographic region, though has the following limits:
:*100,000 total cells and 30,000 active (potentially flooded) cells
:*100 1D channels
:*There can only be one CPU 2D domain (M2D is not supported). HPC Quadtree is supported.
:*A simulation time of 10 minutes.
:*CPU and GPU compute are supported.
The free Demo mode is called using the TUFLOW Control File (TCF) command: <tt>Demo Model </tt> <tt>== </tt><tt>ON</tt> 

Educators who would like to teach TUFLOW can create course content that works within the limits of the Demo mode. If you would like assistance creating teaching material using this simulation mode please email [mailto:training@tuflow.com training@tuflow.com].

=TUFLOW Licence=
To purchase a licence, please email [mailto:sales@tuflow.com sales@tuflow.com] for a quote.

WIBU Software Licence Update Request

2026-03-17T05:41:02Z

Chris Huxley:

Software licences are an alternative option to hardware USB licences. Please select the license host carefully as the software based dongle will be bound to it. If over time you decide you want to move to another computer we will need to re-issue you with a new software license (which will incur a small administration fee).

If you already have a software lock established, please skip to bullet point 4. If this is the first time you are establishing a software lock, complete all steps.
<ol>
<li> Email [mailto:sales@tuflow.com sales@tuflow.com] to request a software licence. You will be sent an empty licence container file (*.wibucmlif).
<li> If you do not already have Codemeter installed, install [[Wibu_Dongles#Installing_CodeMeter_RunTime_Kit | Codemeter Control Centre]]. 
<li> Open Codemeter Control Centre (from the start menu) and drag and drop the provided .wibucmlif onto it. This will import an empty licence container onto the computer (it will show with a grey icon in the licence tab).
<li> With the licence container selected on the left, click the “Licence Update” option, as per the image below. 
 
[[File:Software_licence_001c.png]] 
 
<li> Select “Next” at the next dialogue. 
 
[[File:Software_licence_002c.png]] 
 
<li> Select “Create Licence Request”. 
 
[[File:Software_licence_003c.png]] 
 
<li> Save the licence request file to your computer. 
 
[[File:Software_licence_004c.png]] 
 
<li> Email the licence request file (.WibuCmRaC) file to [mailto:sales@tuflow.com sales@tuflow.com].
</ol>

WIBU Configure Network Server

2026-01-15T22:51:25Z

Chris Huxley: /* Method */

=Introduction=
This page contains instructions for configuring a network TUFLOW licence. It requires that you have the CodeMeter Runtime kit installed on the server, see [[Wibu_Dongles#Installing_CodeMeter_RunTime_Kit |Installing CodeMeter Runtime Kit]]. 

For the network license server, during the CodeMeter Runtime kit installation, please select the "Network Server" option. Doing so, CodeMeter will configure TCP and UDP protocols in the Windows Firewall for the server. 
[[File:CodeMeter_Network_Server_install_02.png|550px]]

=Method=
<ol>
<li>Open the CodeMeter Control Centre. This can be done via the icon on the taskbar: 
[[File:CodeMeter TaskBar.jpg]]
 
Or via the start menu: 
[[File:CodeMeter ProgramFiles.jpg|200px]]
</li>
<li>Open the '''WebAdmin''' via the button in the lower right.</li>
[[File:Codemeter_v6.40d_control_center.JPG|400px|]]
 
This can also be accessed by pointing an internet browser to: [[http://localhost:22352/ http://localhost:22352/]] or [[http://localhost:22353/ http://localhost:22353/]] if you have https configured and provided CodeMeter with a certificate (Note that the port number can be adjusted by your administrator).
 
The following CodeMeter webpage will appear.
 
[[File:Codemeter_v6.40d_WebAdmin.JPG|800px|]]
<li>Navigate to the '''Configuration >> Server >> Server Access''' tab and enable the '''Network Server''' checkbox and hit Apply.</li>
[[File:Codemeter_v6.40d_Network_Server.JPG|800px]]
<li> In CodeMeter WebAdmin navigate to the '''Configuration >> Basic >> Sever Search List''' tab:
<ol>
* Select "add new Server"
* Enter the code: 127.0.0.1
* Click Apply </li>
[[File:Codemeter_Network_LocalHost.jpg|800px]]
</ol>
<li>The network licence should now be available. This can be tested on the server by double clicking the TUFLOW Executable (for example TUFLOW_iSP_w64.exe). A console window should open. Review the licence information listed. Check the licence types and numbers associated with your configuration (the licence types and numbers will be different to the example shown below). 
[[File:TUFLOW_DOS_Test1.JPG|600px]] </li>
<li> The next install steps will involve configuring client (modelling) computers to communicate with the server. The client computer will use the IP address of the server for the communication connection. To avoid the server IP address changing due to future actions (such as the server computer being restarted), we recommend configuring the server to use a static IP address.
<li> Configure client (modelling) computers to communicate with the server: [[WIBU_Configure_Network_Client | Configure Network Client]] .
</ol>

=Troubleshooting=
If your licences are not listed in the console window when you test whether the server configuration has been successful:
<ol>
<li> Check whether you have the latest version of Codemeter User Runtime installed. If you do not, update to the latest version: [https://www.wibu.com/support/user/downloads-user-software.html https://www.wibu.com/support/user/downloads-user-software.html]
<li> If you are unable to change your version of Codemeter User Runtime, in CodeMeter WebAdmin navigate to the '''Configuration >> Basic >> Sever Search List''' tab and enter the server name, computer IP address, or the code: 127.0.0.1 in the '''Server Search''' list. After entering the details, click "Add" to save the change. This was a configuration requirement in some old versions of Codemeter User Runtime.</li>
<li> If issues persist, email [mailto:sales@tuflow.com sales@tuflow.com] </ol>

WIBU Configure Network Server

2026-01-15T22:51:08Z

Chris Huxley: /* Method */

=Introduction=
This page contains instructions for configuring a network TUFLOW licence. It requires that you have the CodeMeter Runtime kit installed on the server, see [[Wibu_Dongles#Installing_CodeMeter_RunTime_Kit |Installing CodeMeter Runtime Kit]]. 

For the network license server, during the CodeMeter Runtime kit installation, please select the "Network Server" option. Doing so, CodeMeter will configure TCP and UDP protocols in the Windows Firewall for the server. 
[[File:CodeMeter_Network_Server_install_02.png|550px]]

=Method=
<ol>
<li>Open the CodeMeter Control Centre. This can be done via the icon on the taskbar: 
[[File:CodeMeter TaskBar.jpg]]
 
Or via the start menu: 
[[File:CodeMeter ProgramFiles.jpg|200px]]
</li>
<li>Open the '''WebAdmin''' via the button in the lower right.</li>
[[File:Codemeter_v6.40d_control_center.JPG|400px|]]
 
This can also be access by pointing an internet browser to: [[http://localhost:22352/ http://localhost:22352/]] or [[http://localhost:22353/ http://localhost:22353/]] if you have https configured and provided CodeMeter with a certificate (Note that the port number can be adjusted by your administrator).
 
The following CodeMeter webpage will appear.
 
[[File:Codemeter_v6.40d_WebAdmin.JPG|800px|]]
<li>Navigate to the '''Configuration >> Server >> Server Access''' tab and enable the '''Network Server''' checkbox and hit Apply.</li>
[[File:Codemeter_v6.40d_Network_Server.JPG|800px]]
<li> In CodeMeter WebAdmin navigate to the '''Configuration >> Basic >> Sever Search List''' tab:
<ol>
* Select "add new Server"
* Enter the code: 127.0.0.1
* Click Apply </li>
[[File:Codemeter_Network_LocalHost.jpg|800px]]
</ol>
<li>The network licence should now be available. This can be tested on the server by double clicking the TUFLOW Executable (for example TUFLOW_iSP_w64.exe). A console window should open. Review the licence information listed. Check the licence types and numbers associated with your configuration (the licence types and numbers will be different to the example shown below). 
[[File:TUFLOW_DOS_Test1.JPG|600px]] </li>
<li> The next install steps will involve configuring client (modelling) computers to communicate with the server. The client computer will use the IP address of the server for the communication connection. To avoid the server IP address changing due to future actions (such as the server computer being restarted), we recommend configuring the server to use a static IP address.
<li> Configure client (modelling) computers to communicate with the server: [[WIBU_Configure_Network_Client | Configure Network Client]] .
</ol>

=Troubleshooting=
If your licences are not listed in the console window when you test whether the server configuration has been successful:
<ol>
<li> Check whether you have the latest version of Codemeter User Runtime installed. If you do not, update to the latest version: [https://www.wibu.com/support/user/downloads-user-software.html https://www.wibu.com/support/user/downloads-user-software.html]
<li> If you are unable to change your version of Codemeter User Runtime, in CodeMeter WebAdmin navigate to the '''Configuration >> Basic >> Sever Search List''' tab and enter the server name, computer IP address, or the code: 127.0.0.1 in the '''Server Search''' list. After entering the details, click "Add" to save the change. This was a configuration requirement in some old versions of Codemeter User Runtime.</li>
<li> If issues persist, email [mailto:sales@tuflow.com sales@tuflow.com] </ol>

WIBU Licence Update Softlock Import

2026-01-09T00:40:45Z

Chris Huxley: /* Troubleshooting */

=Introduction=
This page describes the process for importing a licence update file for a Wibu dongle. In order to perform the update, you will need a .WibuCmRaU file that will have been emailed to you by TUFLOW staff, this should be saved on your computer. If you have this file you can begin the process below!
=Common Questions=
'''I have TUFLOW simulations running, will it stop these?''' 
No, we have found that the process below should work, even if simulations are currently running. If you are worried, simply hold off until your simulations have finished. 
 
'''Do I need to update the licence on each computer that will use TUFLOW?''' 
No, the update file modifies the dongle coding itself, once applied the changes will apply to all computer that use the dongle. If you try to apply an update file more than once an error will be generated. 
 
'''If I update the Wibu licence for a new version of TUFLOW, will I still be able to use current / previous versions of TUFLOW?''' 
Yes, if you update the licence for the 2015 maintenance period, you can still use previous versions of TUFLOW such as the 2013 TUFLOW release.
=Method=
<ol>
<li>Open the Code Meter Control Centre from the taskbar by double clicking on the following icon [[File:CM CM Stick Green.jpg|20px]]. This can also be opened from the Start Menu. Once opened the Control Centre should look like the below:</li>
<li> Select the license container item from the list on the left, then Click on the '''Licence Update''' button.</li>
[[File:CodeMeter Update01.jpg|600px]]
<li>At the welcome to the CmFAS Assistant screen, bit next to proceed.</li>
[[File:CodeMeter Update02.jpg|600px]]
<li>When prompted to chose the desired action, select '''Import Licence Update''' and hit next.</li>
[[File:CodeMeter Update10.jpg|600px]]
<li>Navigate to the .WibuCmRaU file send to you by TUFLOW staff and select this. Click commit to process the update.</li>
[[File:CodeMeter Update11.jpg|600px]]
<li>After a few seconds, you should get a message to say that the licence update has been successful.
* If this update is associated with deleting a licence and sales@tuflow.com have requested a receipt from you, please click the create receipt "here" link before pressing "Finish".
* Otherwise, if this is a standard update and sales@tuflow.com have not requested a receipt, press "Finish".
* If you receive a pop-up message that states the licence update was not sucessful, please see the troubleshooting section below.
[[File:Codemeter_Licence_Update_Complete_MSG.png|800px]]
</ol>

=Troubleshooting=
The following errors are based on emails we've received, if you receive a different message or are unable to import an update please see email [mailto:support@tuflow.com support@tuflow.com]. Please include screen images of any relevant error messages. 
 
'''Error 229 - Update could not be imported. Contents of CmStick is newer than update''' 
This indicates the contents of the dongle are newer than the update being applied. This could occur if: 
* The licence update has already been imported
* An incorrect (old) update file was applied by mistake

WIBU Licence Update Import

2026-01-09T00:40:15Z

Chris Huxley: /* Troubleshooting */

=Introduction=
This page describes the process for importing a licence update file for a Wibu dongle. In order to perform the update, you will need a .WibuCmRaU file that will have been emailed to you by TUFLOW staff, this should be saved on your computer. If you have this file you can begin the process below!
=Common Questions=
'''I have TUFLOW simulations running, will it stop these?''' 
No, we have found that the process below should work, even if simulations are currently running. If you are worried, simply hold off until your simulations have finished. 
 
'''Do I need to update the licence on each computer that will use TUFLOW?''' 
No, the update file modifies the dongle coding itself, once applied the changes will apply to all computer that use the dongle. If you try to apply an update file more than once an error will be generated. 
 
'''If I update the Wibu licence for a new version of TUFLOW, will I still be able to use current / previous versions of TUFLOW?''' 
Yes, if you update the licence for the 2015 maintenance period, you can still use previous versions of TUFLOW such as the 2013 TUFLOW release.
=Method=
<ol>
<li> sales@tuflow.com should have emailed you a .WibuCmRaU file for your licence update. Save the file to your computer. Note down the folder location where you have saved it, you will need it to import the file into Code Meter Control Centre. </li>
<li>With the dongle inserted into your computer. Open the Code Meter Control Centre from the taskbar by double clicking on the following icon [[File:CM CM Stick Green.jpg|20px]]. This can also be opened from the Start Menu. Once opened the Control Centre should look like the below:</li>
<li> Click on the '''Licence Update''' button.</li>
[[File:CodeMeter Update01.jpg|600px]]
<li>At the welcome to the CmFAS Assistant screen, bit next to proceed.</li>
[[File:CodeMeter Update02.jpg|600px]]
<li>When prompted to choose the desired action, select '''Import Licence Update''' and hit next.</li>
[[File:CodeMeter Update10.jpg|600px]]
<li>Navigate to the .WibuCmRaU file send to you by TUFLOW staff and select this. Click commit to process the update.</li>
[[File:CodeMeter Update11.jpg|600px]]
<li>After a few seconds, you should get a message to say that the licence update has been successful. </li>
* If this update is associated with deleting a licence and sales@tuflow.com have requested a receipt from you, please click the create receipt "here" link before pressing "Finish".
* Otherwise, if this is a standard update and sales@tuflow.com have not requested a receipt, press "Finish".
* If you receive a pop-up message that states the licence update was not sucessful, please see the troubleshooting section below.
[[File:Codemeter_Licence_Update_Complete_MSG.png|800px]]
</ol>

=Troubleshooting=
The following errors are based on emails we've received, if you receive a different message or are unable to import an update please see email [mailto:support@tuflow.com support@tuflow.com]. Please include screen images of any relevant error messages. 
 
'''Error 229 - Update could not be imported. Contents of CmStick is newer than update''' 
This indicates the contents of the dongle are newer than the update being applied. This could occur if: 
* The licence update has already been imported
* An incorrect (old) update file was applied by mistake

WIBU Licence for Linux

2026-01-09T00:39:27Z

Chris Huxley: /* Using the installed licenses */

This article describes the process of setting up a licence container (software licence only) and installing licence updates (network and software licences) from a Linux command line interface, like you would access on an SSH console.

The Linux commands used on this wiki should work on most modern Linux distributions, but were tested on CentOS and Debian. This article assumes you have downloaded and installed an appropriate version of the [https://www.wibu.com/support/user/user-software.html CodeMeter Runtime (download)] for your Linux host and CodeMeter is running as a service. If you are uncertain, you can run <pre>systemctl | grep codemeter</pre> and you should see both `codemeter.service` and `codemeter-webadmin.service` as `running` or `exited`. For the CodeMeter service, you can also check <pre>/etc/init.d/codemeter status</pre> which should report "CodeMeter Server is running.". By default, your CodeMeter Control Center web application would be hosted on [http://localhost:22350/ http://<your hostname>:22350/].

For a basic setup of CodeMeter on Linux, refer to [[Installing_Wibu_CodeMeter_Linux | Installing Wibu CodeMeter on Linux]].

Software licences are an alternative option to hardware USB dongle licences. Please select the licence host carefully as a software based dongle will be bound to it when it is first imported. If over time you decide you want to move to another computer we will need to re-issue you with a new software licence (which will incur a small administration fee).

==Setting up a new licence container (software licence only)==

Email [mailto:sales@tuflow.com sales@tuflow.com] to request a software licence. You will be sent an empty licence container file (*.WibuCmLif).

Install the licence container file with:
<pre>cmu --import --file Universal_Firm_Code_CmActLicense_6000224.WibuCmLif</pre>
Which should result in something like:
<pre>cmu - CodeMeter Universal Support Tool.
Version 6.60a of 2018-Feb-26 (Build 2878) for Linux
Copyright (C) 2007-2018 by WIBU-SYSTEMS AG. All rights reserved.

The file contains 1 Update:
CmActLtLicense binding information: FirmCode 6000224

Execute Update ...
The file contains 1 Update:
CmActLtLicense update: Serial number xxx-xxxxxxxxxx, FirmCode 6000224.
--> successful
1 successful update done</pre>

After installing the licence container file, the CodeMeter WebAdmin interface may report an error if you try to check the new container (e.g. 'Error 407: Unknown error'). This can be resolved by restarting the CodeMeter service after installing the licence container:
<pre>sudo systemctl restart codemeter.service</pre>

Make a note of the serial number displayed. You can list serial numbers of installed dongles and software licence containers with the command:
<pre>cmu --list</pre>

==Updating licences (network and software licences)==

Once you have an existing licence container, either from a plugged in network dongle or imported software container, you will need to create a licence update request:
* Network licence:
<pre>cmu --context 101139 --serial x-xxxxxxx --file x-xxxxxxx.WibuCmRaC</pre>
* Software licence:
<pre>cmu --context 6000224 --serial xxx-xxxxxxxxxx --file xxx-xxxxxxxxxx.WibuCmRaC</pre>

Where "x-xxxxxxx" or "xxx-xxxxxxxxxx" is the serial number of your licence container.

E-mail the created licence request file (.WibuCmRaC) file to [mailto:sales@tuflow.com sales@tuflow.com].

Once your licence request is processed, you will receive a licence update file (.WibuCmRaU) in return, which you can install with:
* Network licence:
<pre>cmu --import --file x-xxxxxxx.WibuCmRaU</pre>
* Software licence:
<pre>cmu --import --file xxx-xxxxxxxxxx.WibuCmRaU</pre>
Which should result in something like:
<pre>cmu - CodeMeter Universal Support Tool.
Version 6.60a of 2018-Feb-26 (Build 2878) for Linux
Copyright (C) 2007-2018 by WIBU-SYSTEMS AG. All rights reserved.

The file contains 1 Updates:
CmActLtLicense binding information: FirmCode 6000224
CmDongle update for 130-3796453031 (FirmCode 6000224).

Execute Update ...
The file contains 1 Updates:
CmActLtLicense update: Serial number xxx-xxxxxxxxxx, FirmCode 6000224.
--> successful
1 successful update done</pre>

Once your licence update has been imported, you should see your installed licences in the CodeMeter WebAdmin. If they fail to show up, restart the CodeMeter Service:
<pre>sudo systemctl restart codemeter.service</pre> or <pre>sudo /etc/init.d/codemeter restart</pre>

==Using the installed licenses==
If you are running a model on another machine and have installed the license on a remote license host, refer to [[WIBU_Configure_Network_Server|Wibu Configure Network Server]] and [[WIBU_Configure_Network_Client|Wibu_Configure Network Client]] to learn how to connect to it.

If the software license container is the only license container (i.e. you have no dongle installed), you can test using the installed license by simply starting a model run that requires it (i.e. some run other than a benchmark or tutorial model).

However, if you have both a dongle and software license container installed, you can ensure TUFLOW prefers the software license by creating a license control file (.lcf) for your model, with the line: <pre>WIBU Firm Code Search Order == 6000224 101139</pre> This ensures that TUFLOW will prefer a software license container (6000224) over a dongle license container (101139) to obtain a license. You can learn more about where such a file can be placed and what the followed logic for obtaining a license is in the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual].

WIBU Licence Update Request Uncoded

2026-01-09T00:39:11Z

Chris Huxley: /* Troubleshooting */

=Introduction=
This page contains instructions for creating a licence update request for an uncoded or non BMT-WBM Wibu licence. Unless instructed by TUFLOW staff, the instructions on the following page should be followed instead [[WIBU_Licence_Update_Request | WIBU Licence Update Request]]. 
=Method=
<ol>
<li> If you do not already have Codemeter installed, install [[Wibu_Dongles#Installing_CodeMeter_RunTime_Kit | Codemeter Control Centre]]. 
<li>With the dongle inserted into your computer. Open the Code Meter Control Centre from the taskbar by double clicking on the following icon [[File:CM CM Stick Green.jpg|20px]]. This can also be opened from the Start Menu. Once opened the Control Centre should look like the below:</li>
<li> Click on the '''Licence Update''' button.</li>
[[File:CodeMeter Update01.jpg|600px]]
<li>At the welcome to the CmFAS Assistant screen, bit next to proceed.</li>
[[File:CodeMeter Update02.jpg|600px]]
<li>When prompted to chose the desired action, select '''Create Licence Request''' and hit next.</li>
[[File:CodeMeter Update03.jpg|600px]]
<li>As the dongle is a new or uncoded dongle you will need to choose '''Add Licence of New Producer''' and select next.</li>
[[File:CodeMeter Update08.jpg|600px]]
<li>When prompted to "Enter the Firm Code", enter '''101139'''. 
</li>
[[File:CodeMeter Update09.jpg|600px]]
<li>You will be asked to set the output file name and location. When the licence update is processed, this will create a file which you will need to email, so please '''save in a location that you will remember!''' 
Once you have set an output filename, select '''Commit''' to create the licence request.</li>
[[File:CodeMeter Update06.jpg|600px]]
<li>After committing, the following screen will be displayed to confirm the licence request has been created. Select '''Finish''' to close this screen.</li>
[[File:CodeMeter Update07.jpg|600px]]
<li>The licence update request can now be emailed to TUFLOW. Please email the created .WibuCmRaC file through to [mailto:sales@tuflow.com sales@tuflow.com]. This file will be saved in the location set in step 7.</li>
</ol>

=Troubleshooting=
If the dongle has been previously used for TUFLOW simulations, then you do not need to add a new producer, and instead the following procedure can be used [[WIBU_Licence_Update_Request | WIBU Licence Update Request (normal)]]. 
 
If you have any other issues with the licence update request, please email [mailto:support@tuflow.com support@tuflow.com]. Please include screen images of any relevant error messages.

WIBU Licence Update Request

2026-01-09T00:38:50Z

Chris Huxley: /* Troubleshooting */

=Introduction=
This page contains instructions for creating a licence update request for an existing TUFLOW Wibu (CodeMeter) licence.
=Method=
<ol>
<li> If you do not already have Codemeter installed, install [[Wibu_Dongles#Installing_CodeMeter_RunTime_Kit | Codemeter Control Centre]]. 
<li>With the dongle inserted into your computer. Open the Code Meter Control Center from the taskbar by double clicking on the following icon [[File:CM CM Stick Green.jpg|20px]]. This can also be opened from the Start Menu (under All Programs --> Code Meter --> Code Meter Control Center). Once opened the Control Center should look like the below:</li>
<li> Click on the '''Licence Update''' button.</li>
[[File:CodeMeter Update01.jpg|600px]]
<li>At the welcome to the CmFAS Assistant screen, bit next to proceed.</li>
[[File:CodeMeter Update02.jpg|600px]]
<li>When prompted to choose the desired action, select '''Create Licence Request''' and hit next.</li>
[[File:CodeMeter Update03.jpg|600px]]
<li>Unless you have been instructed by TUFLOW staff, choose '''Extend Existing Licence''' and select next.</li>
[[File:CodeMeter Update04.jpg|600px]]
<li>When prompted to "Choose the producer", select the '''BMT WBM (101139)'''. 
This may be the only option, however, if multiple choices are available, please uncheck all except for '''BMT WBM (101139)'''. 
If you do not see BMT WBM as a valid licence producer, this could mean that your licence is through a third party (such as Aquaveo) or that your dongle has not yet been coded. If you are unsure please contact [mailto:support@tuflow.com support@tuflow.com].</li>
[[File:CodeMeter Update05.jpg|600px]]
<li>You will be asked to set the output file name and location. When the licence update is processed, this will create a file which you will need to email, so please '''save the file in a location that you will remember!''' 
Once you have set an output filename, select '''Commit''' to create the licence request.</li>
[[File:CodeMeter Update06.jpg|600px]]
<li>After committing, the following screen will be displayed to confirm the licence request has been created. Select '''Finish''' to close this screen.</li>
[[File:CodeMeter Update07.jpg|600px]]
<li>The licence update request can now be emailed to TUFLOW. Please email the created .WibuCmRaC file through to [mailto:sales@tuflow.com sales@tuflow.com]. This file will be saved in the location set in step 7.</li>
</ol>

=Troubleshooting=
It is important to note that this process needs to be followed for each update request. If you send through an old file that has already been processed, the licence update will fail. 
 
If you have any other issues with the licence update request, please email [mailto:support@tuflow.com support@tuflow.com]. Please include screen images of any relevant error messages.

Installing Wibu CodeMeter Linux

2026-01-09T00:38:19Z

Chris Huxley:

This article provide a basic set of instructions to install the Wibu CodeMeter Runtime on a Linux host through the command line interface (CLI). For more information about using Wibu dongles or software licenses, refer to [[Wibu_Dongles|Wibu Dongles]].

The Linux commands used on this wiki should work on most modern Linux distributions, but were tested on CentOS and Debian. Note that these instructions are provided as a courtesy to users new to Linux, please ensure you understand what the commands mean before you run them and be aware of the [[Tuflow:General_disclaimer|general disclaimer]].

==Getting the CodeMeter Runtime==

The appropriate version of the CodeMeter Runtime can be obtained from the Wibu website at [https://www.wibu.com/support/user/downloads-user-software.html https://www.wibu.com/support/user/downloads-user-software.html].

If you are using Debian, Ubuntu, Mint or another Linux distribution in the Debian family of distributions, you should obtain a copy of the `.deb` installer for your hardware. If you are using Red Hat (RHEL), Fedora, CentOS or another Linux distribution in the Red Hat family of distributions, you should obtain a copy of the `.rpm` installer for your hardware. If your hardware supports 64-bit software (which is likely for modern systems), using that version is recommended. From here on, we'll refer to 'Debian' or 'Red Hat' to mean any distribution in that family.

Depending on your level of access to the machine running Linux and whether or not it is running a graphical user interface, you may have some trouble getting the file onto your machine. You can download the file directly from the command line with: <pre>wget -O codemeter.rpm <direct link></pre> where "<direct link>" is the 'direct link' provided on the Wibu download page for the version you are downloading.

The download page also provides an MD5 checksum. You can run <pre>md5sum codemeter.rpm</pre> and verify that the file you downloaded was downloaded correctly by comparing this checksum.

If your Linux distribution does not provide `wget`, you can obtain a copy on Debian with `sudo apt-get install wget` and on Red Hat with `sudo yum install wget`.

==Installing the CodeMeter Runtime==

On Red Hat, using `yum`, you can install the CodeMeter Runtime with <pre>sudo yum localinstall codemeter.rpm</pre>

On Debian, using `dpkg` and `apt-get`, you can install the CodeMeter Runtime with <pre>sudo dpkg -i codemeter.deb</pre> If that fails due to missing dependencies, you can instead attempt <pre>sudo apt-get -f codemeter.deb</pre>

Once these commands complete (on either Debian or Red Hat), you can start, stop and restart the services with `systemctl`: <pre>sudo systemctl restart codemeter.service</pre>

Alternatively, if `systemctl` is not available to you, you can use: <pre>sudo /etc/init.d/codemeter restart</pre>

==Configuring the CodeMeter Runtime==

Refer to the CodeMeter manual for instructions on configuring CodeMeter.

However, if you are installing CodeMeter as a client for network licenses, the following is an example of a section you can add to the `/etc/wibu/CodeMeter/Server.ini`: <pre>[ServerSearchList]
UseBroadcast=1

[ServerSearchList\Server1]
Address=<ip number of your license host></pre>
You can add multiple `ServerSearchList\Server<n>` sections, one for each license host you have, with the IP address of the license host. Once you update and save the configuration file, restart the CodeMeter service and your licenses from the network server should then be available locally.

If you are setting up a license host, which you wish to access from another machine, you will need to install the CodeMeter Runtime on that machine as well and you need to ensure the firewall allows requests to the license host on port 22350.

On Red Hat, you can achieve this with:<pre>sudo firewall-cmd --get-active-zones
sudo firewall-cmd --zone=public --add-port=22350/tcp --permanent
sudo firewall-cmd --reload</pre>
This assumes you see the `public` zone after the first command.

On Debian, you can run:<pre>sudo iptables -A INPUT -p tcp -m tcp --dport 22350 -j ACCEPT</pre>

Similarly, if you want users to be able to access the web admin interface for code meter on the server, you would need to ensure the firewall allows request on port 22352 (for http) and/or 22353 (for https). However, access to the web admin interface from other machines is not required for obtaining a license and in typical configurations, you would be able to access the web admin interface on the host itself (localhost) without additional firewall rules.

Installing Wibu CodeMeter Windows

2026-01-09T00:37:57Z

Chris Huxley:

* Download the latest CodeMeter Runtime Kit for Windows installer from: [https://www.wibu.com/support/user/downloads-user-software.html https://www.wibu.com/support/user/downloads-user-software.html]
[[File:Installing Wibu CodMeter_001.png]]
* Install the software
:* If you are using a local licence or have a network licence and are installing CodeMeter on a network client computer (i.e. a modelling computer, not the network host/server) please use the default install settings.
:* If a computer is used as a network licence server, please select the "Network Server" option during the installation. Selecting this option will configure the appropriate TCP and UDP protocols in the Windows Firewall. 
[[File:Installing WibuCodMeter_002.png]]

* Silent Install: It is possible to do a silent install of the CodeMeter Runtime kit. CodeMeter support staff have advised that this can be done with the following parameters: 
<tt>CodeMeterRuntime.exe /ComponentArgs "*":"/qn"</tt>

TUFLOW Simulation Speed

2025-12-10T01:19:30Z

Chris Huxley:

= Common Questions Answered (FAQ)=
==How can I speed up my TUFLOW model, make it more storage efficient and reduce RAM requirements?==
The following tips provide advice on how to make TUFLOW models initialise, run and write results faster. Most of the suggestions will also ensure the model output size is kept to minimum, minimising required disk space.
* Initialisation:
** Use XF files to speed up the model initialisation (the default).
** Use TIF or FLT grids for grid inputs instead of ASC as they are faster to read. FLT files are ESRI binary (float) version of the ASC files, their size is about 1/2 to 1/5 of an ASC file. To convert ASC to FLT, use -conv switch with our [[ASC_to_ASC#Convert | ASC_to_ASC utility]].
* Writing check files:
** Writing check files to a local solid state drive usually take less time than to a network drive.
** Make sure there is enough free space as drives slow down when they are nearing to being full.
** Suppress unnecessary check files - some check files, such as zpt, uvpt and grd check file, can take a relatively long time to write. If some check files are not changing, they can just be written once and excluded for subsequent simulations with the below command. Any check file can be excluded, example of such command is <tt>Write Check Files EXCLUDE</tt> <tt>==</tt><tt> zpt uvpt grd</tt>.
** Use output zones to write localised check files when specific areas of a model domain are of interest.
* Simulation:
** Use single precision version of TUFLOW if double precision is not required. More information on single and double versions [[TUFLOW_General_Discussion#What_is_the_difference_between_single_and_double_precision_and_when_should_I_use_them.3F | here]].
** If using TUFLOW HPC, review the [[HPC_Model_Review#dt_Map_Output | minimum dt map output]] to check for locations with low timestep and whether any improvements can be applied to speed up the simulation.
* Writing results:
** Writing results to a local solid state drive usually take less time than to a network drive. This also applies to running models on a cloud. From our testing, writing outputs on a local drive of the virtual machine is noticeably faster than using network storage.
** Make sure there is enough free space as drives slow down when they are nearing to being full.
** Use output zones to write localised results when specific areas of a model domain are of interest.
** Use TIF or FLT for grid results instead of ASC as they are more efficient in terms of write speed and file size.
** Specify XMDF for temporal output instead of DAT as they are more compressed and faster to write.
** Use appropriate <tt>Map Output Interval</tt> for XMDF, e.g. around 100 output increments for the whole simulation unless an animation of high temporal resolution is to be created.
** Output only maximum TIF or FLT grids with <tt>FLT Map Output Interval </tt> <tt>== </tt><tt>0</tt> instead of every <tt>Map Output Interval</tt>. Keep the temporal output only as XMDF.
** Specify only <tt>Map Output Data Types </tt> that are needed.
** For further details, see [https://www.youtube.com/watch?v=-CsKKjG7jpQ&ab_channel=TUFLOW Output Management Advice] webinar.
* Hardware:
** Consider using multiple resources:
*** TUFLOW HPC is parallelised and can run on multiple devices. By default, TUFLOW HPC running on GPU uses one GPU card, to increase the number see [[HPC_Running_and_Converting_Models#Running_HPC_on_Multiple_GPU_Devices | Running HPC on multiple GPU devices]]. TUFLOW HPC running on CPU uses by default four CPU threads, to increase the number see [[HPC_Running_and_Converting_Models#Running_HPC_on_Multiple_CPU_Threads | Running HPC on multiple CPU threads]]. Note that model initialisation, 1D calculations and writing results are being processed on the CPU side even if GPU resources are used for the 2D simulation and currently these processes only use one CPU thread.
*** TUFLOW Classic isn't parallelised and only uses a single CPU thread for every simulation. Model initialisation, 1D calculations and writing results are also limited to only one CPU thread.
** The better the hardware, the faster TUFLOW model would run. To see how different hardware compares to each other, see [[Hardware_Benchmarking_-_Results#CPU_Results | Hardware Benchmarking Results]].
** For more information on hardware specification, see [[Hardware_Selection_Advice | Hardware Selection Advice]]. 
Reducing RAM requirements:
* Model domain should be as tight to the model code (active areas) as possible - search the .tlf for "Isolating redundant perimeter sections", this will tell you how much larger the domain is than it needs to be as a percentage.
* Using Quadtree may decrease RAM requirement as with Quadtree mesh only active code polygon is processed instead of the whole model domain rectangle used for HPC and Classic. Also, judicious refinement and using larger cells in non-focus areas will decrease the number of active cells and therefore the RAM requirement.
* The larger cell size, the less RAM is required. [https://www.youtube.com/watch?v=1jWyIXHR_lM Cell size sensitivity testing] can be carried out to find out the largest cell size without compromising model accuracy.
* Using Sub Grid Sampling (SGS) increases the RAM requirement compared to a non SGS model with the same cell size. If SGS increases the RAM beyond what is desired, consider the following:
<ol>
* Increase your 2D cell size. Thanks to SGS the cell size can typically be increased whilst still achieving a good cell size convergence.
* Review your SGS Sample Frequency in the TLF. Typically, a value of 11 or less is all that is necessary to set the SGS parameterisation to a level that achieves excellent accuracy. If the SGS Sample Frequency is excessively large, test reducing the default value by using either the <tt>SGS Sample Frequency</tt> <tt>or <tt>SGS Sample Sample Target Distance </tt><tt>commands.
</ol>
* Inputs might be clipped if their extent is much larger than the code, e.g. grids, material layers and so on. For example if a 100GB DEM is being input to TUFLOW with the majority of the DEM being outside the TUFLOW model, TUFLOW allocates memory to read the entire DEM in for processing. Memory for reading inputs is only used temporarily and is released after the processing of the input, e.g. the DEM.
* Large DEM and material grids can use up a lot of memory during model initialisation as the entire grid is read for processing. Re-tiling the grid into smaller sections will use up less memory as each smaller grid will be processed at the time avoiding high memory peaks.
* Inspecting .tlf file can help recognising which model features require the most RAM and more RAM efficient methods might be considered. For example, using gridded rainfall is more RAM efficient than using large number of rainfall polygons. Other features such as soil infiltration, hazard outputs and output zones all require additional memory.
* Grid (raster) outputs from TUFLOW (including DEM check files and Map Output Formats ASC, FLT, NC, TGO and WRR), require significant memory for storing interpolation factors. An interpolation is required as these outputs are all north-south aligned, while TUFLOW models can include rotation, water level lines and varying cell sizes. By default the grid output resolution is half the 2D cell size. Increasing the output cell size with the .tcf command <tt>Grid Output Cell Size </tt> <tt>==</tt><tt> <grid_output_cell_size></tt> can reduce the amount of memory required for this. Refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] for more information on grid outputs.
* When using Quadtree the .qcf command <tt>Quadtree Mesh Processing Method </tt> <tt>==</tt><tt> Memory Efficient</tt> can reduce the amount of memory, although the model initialisation might take longer.

Other processes can slow TUFLOW simulations down if they are competing for resources. A few potential causes:
* Running another model at the same time (as the CPU RAM is shared between both simulations)
* Scheduled computer back ups
* Operating system updates
* Antivirus scans
* Others activities (e.g. copying large files, writing large files).

 
{{Tips Navigation
|uplink=[[ TUFLOW_Modelling_Guidance | Back to TUFLOW Modelling Guidance]]
}}

TUFLOW Simulation Speed

2025-12-10T01:18:21Z

Chris Huxley: /* Common Questions Answered (FAQ) */

= Common Questions Answered (FAQ)=
==How can I speed up my TUFLOW model, make it more storage efficient and reduce RAM requirements?==
The following tips provide advice on how to make TUFLOW models initialise, run and write results faster. Most of the suggestions will also ensure the model output size is kept to minimum, minimising required disk space.
* Initialisation:
** Use XF files to speed up the model initialisation (the default).
** Use TIF or FLT grids for grid inputs instead of ASC as they are faster to read. FLT files are ESRI binary (float) version of the ASC files, their size is about 1/2 to 1/5 of an ASC file. To convert ASC to FLT, use -conv switch with our [[ASC_to_ASC#Convert | ASC_to_ASC utility]].
* Writing check files:
** Writing check files to a local solid state drive usually take less time than to a network drive.
** Make sure there is enough free space as drives slow down when they are nearing to being full.
** Suppress unnecessary check files - some check files, such as zpt, uvpt and grd check file, can take a relatively long time to write. If some check files are not changing, they can just be written once and excluded for subsequent simulations with the below command. Any check file can be excluded, example of such command is <tt>Write Check Files EXCLUDE</tt> <tt>==</tt><tt> zpt uvpt grd</tt>.
** Use output zones to write localised check files when specific areas of a model domain are of interest.
* Simulation:
** Use single precision version of TUFLOW if double precision is not required. More information on single and double versions [[TUFLOW_General_Discussion#What_is_the_difference_between_single_and_double_precision_and_when_should_I_use_them.3F | here]].
** If using TUFLOW HPC, review the [[HPC_Model_Review#dt_Map_Output | minimum dt map output]] to check for locations with low timestep and whether any improvements can be applied to speed up the simulation.
* Writing results:
** Writing results to a local solid state drive usually take less time than to a network drive. This also applies to running models on a cloud. From our testing, writing outputs on a local drive of the virtual machine is noticeably faster than using network storage.
** Make sure there is enough free space as drives slow down when they are nearing to being full.
** Use output zones to write localised results when specific areas of a model domain are of interest.
** Use TIF or FLT for grid results instead of ASC as they are more efficient in terms of write speed and file size.
** Specify XMDF for temporal output instead of DAT as they are more compressed and faster to write.
** Use appropriate <tt>Map Output Interval</tt> for XMDF, e.g. around 100 output increments for the whole simulation unless an animation of high temporal resolution is to be created.
** Output only maximum TIF or FLT grids with <tt>FLT Map Output Interval </tt> <tt>== </tt><tt>0</tt> instead of every <tt>Map Output Interval</tt>. Keep the temporal output only as XMDF.
** Specify only <tt>Map Output Data Types </tt> that are needed.
** For further details, see [https://www.youtube.com/watch?v=-CsKKjG7jpQ&ab_channel=TUFLOW Output Management Advice] webinar.
* Hardware:
** Consider using multiple resources:
*** TUFLOW HPC is parallelised and can run on multiple devices. By default, TUFLOW HPC running on GPU uses one GPU card, to increase the number see [[HPC_Running_and_Converting_Models#Running_HPC_on_Multiple_GPU_Devices | Running HPC on multiple GPU devices]]. TUFLOW HPC running on CPU uses by default four CPU threads, to increase the number see [[HPC_Running_and_Converting_Models#Running_HPC_on_Multiple_CPU_Threads | Running HPC on multiple CPU threads]]. Note that model initialisation, 1D calculations and writing results are being processed on the CPU side even if GPU resources are used for the 2D simulation and currently these processes only use one CPU thread.
*** TUFLOW Classic isn't parallelised and only uses a single CPU thread for every simulation. Model initialisation, 1D calculations and writing results are also limited to only one CPU thread.
** The better the hardware, the faster TUFLOW model would run. To see how different hardware compares to each other, see [[Hardware_Benchmarking_-_Results#CPU_Results | Hardware Benchmarking Results]].
** For more information on hardware specification, see [[Hardware_Selection_Advice | Hardware Selection Advice]]. 
Reducing RAM requirements:
* Model domain should be as tight to the model code (active areas) as possible - search the .tlf for "Isolating redundant perimeter sections", this will tell you how much larger the domain is than it needs to be as a percentage.
* Using Quadtree may decrease RAM requirement as with Quadtree mesh only active code polygon is processed instead of the whole model domain rectangle used for HPC and Classic. Also, judicious refinement and using larger cells in non-focus areas will decrease the number of active cells and therefore the RAM requirement.
* The larger cell size, the less RAM is required. [https://www.youtube.com/watch?v=1jWyIXHR_lM Cell size sensitivity testing] can be carried out to find out the largest cell size without compromising model accuracy.
* Using Sub Grid Sampling (SGS) increases the RAM requirement compared to a non SGS model with the same cell size. If SGS increases the RAM beyond what is desired, consider the following:
<ol>
* Increase your 2D cell size. Thanks to SGS the cell size can typically be increased whilst still achieving a good cell size convergence.
* Review your SGS Sample Frequency in the TLF. Typically, a value of 11 or less is all that is necessary to set the SGS parameterisation to a level that achieves excellent accuracy. If the SGS Sample Frequency is excessively large, test reducing the default value by using either the <tt>SGS Sample Frequency </tt> <tt>==</tt><tt> or <tt>SGS Sample Sample Target Distance </tt> <tt>==</tt><tt> commands.
</ol>
* Inputs might be clipped if their extent is much larger than the code, e.g. grids, material layers and so on. For example if a 100GB DEM is being input to TUFLOW with the majority of the DEM being outside the TUFLOW model, TUFLOW allocates memory to read the entire DEM in for processing. Memory for reading inputs is only used temporarily and is released after the processing of the input, e.g. the DEM.
* Large DEM and material grids can use up a lot of memory during model initialisation as the entire grid is read for processing. Re-tiling the grid into smaller sections will use up less memory as each smaller grid will be processed at the time avoiding high memory peaks.
* Inspecting .tlf file can help recognising which model features require the most RAM and more RAM efficient methods might be considered. For example, using gridded rainfall is more RAM efficient than using large number of rainfall polygons. Other features such as soil infiltration, hazard outputs and output zones all require additional memory.
* Grid (raster) outputs from TUFLOW (including DEM check files and Map Output Formats ASC, FLT, NC, TGO and WRR), require significant memory for storing interpolation factors. An interpolation is required as these outputs are all north-south aligned, while TUFLOW models can include rotation, water level lines and varying cell sizes. By default the grid output resolution is half the 2D cell size. Increasing the output cell size with the .tcf command <tt>Grid Output Cell Size </tt> <tt>==</tt><tt> <grid_output_cell_size></tt> can reduce the amount of memory required for this. Refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] for more information on grid outputs.
* When using Quadtree the .qcf command <tt>Quadtree Mesh Processing Method </tt> <tt>==</tt><tt> Memory Efficient</tt> can reduce the amount of memory, although the model initialisation might take longer.

Other processes can slow TUFLOW simulations down if they are competing for resources. A few potential causes:
* Running another model at the same time (as the CPU RAM is shared between both simulations)
* Scheduled computer back ups
* Operating system updates
* Antivirus scans
* Others activities (e.g. copying large files, writing large files).

 
{{Tips Navigation
|uplink=[[ TUFLOW_Modelling_Guidance | Back to TUFLOW Modelling Guidance]]
}}

TUFLOW SWMM Tutorial Introduction

2025-11-25T01:56:33Z

Chris Huxley: /* TUFLOW SWMM Documentation */

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 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 [[Tutorial_Introduction | "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:
:*[[Tutorial_M03 | Module 3 - 1D Culverts]]
:*[[Tutorial_M05 | Module 5 - Integrated Urban Pipe Network Drainage]]
:*[[Tutorial_M11 | Module 11 - 1D Open Channel]] 
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. 

{| 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 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 [[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Data | 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.

||[https://qgis.org/download/ Latest 64-bit version of QGIS]. 

[[TUFLOW_QGIS_Plugin| 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.
|| [https://notepad-plus-plus.org/downloads/ Latest 64-bit version of Notepad++]. 

[https://downloads.tuflow.com/_archive/Miscellaneous/NPP_TUFLOW_Syntax_Highlighting.zip TUFLOW syntax highlighting for Notepad++]. 

For instructions on configuring Notepad++ for TUFLOW modeling, see [[NotepadPlusPlus_Tips |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 [https://wiki.tuflow.com/GeoPackage_Tips GeoPackage Tips].
:*[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/TUFLOW_SWMM_Tutorial_Models_QGIS_GPKG.zip TUFLOW SWMM Tutorial Dataset - QGIS - GPKG]

=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_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
:*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
:*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
:*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
:*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM: Automated (Recommended) Approach]] - How to convert an XPSWMM model to TUFLOW SWMM: Automated XPX Conversion Tool Approach.
:*[[XPSWMM_to_TUFLOW-SWMM_Archive | XPSWMM to TUFLOW SWMM: Manual Approach]] - How to convert an XPSWMM model to TUFLOW SWMM: Manual Approach.

== TUFLOW SWMM Documentation ==
TUFLOW SWMM documentation can be found in the TUFLOW Manual and in the TUFLOW plugin documentation for the related QGIS tools.

* [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]
* [[TUFLOW QGIS Plugin#Processing_Toolbox|TUFLOW QGIS Plugin Documentation including SWMM 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''': [https://www.epa.gov/water-research/storm-water-management-model-swmm www.epa.gov]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics) ]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydraulics_Addendum-20220210mas2wr.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics Addendum) ]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume3_Water_Quality_P100P2NY.pdf SWMM5 Reference Manual - Volume 3 (Water Quality) ]
*[https://downloads.tuflow.com/SWMM/swmm-users-manual-version-5.2.pdf EPA SWMM5 User's Manual]

 
'''TUFLOW''': [https://www.tuflow.com www.tuflow.com]
*[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]
*[[Tutorial_Introduction#Tutorial_Modules | TUFLOW Tutorial Models]]

=Contact=
For comments, requests and feedback contact [mailto:support@tuflow.com support@tuflow.com]. 
For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 

{{Tips Navigation
|uplink=[[Main_Page| Back to Wiki Main Page]]
}}

TUFLOW SWMM Tutorial Introduction

2025-11-25T01:56:03Z

Chris Huxley: /* Recommended Further Reading */

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 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 [[Tutorial_Introduction | "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:
:*[[Tutorial_M03 | Module 3 - 1D Culverts]]
:*[[Tutorial_M05 | Module 5 - Integrated Urban Pipe Network Drainage]]
:*[[Tutorial_M11 | Module 11 - 1D Open Channel]] 
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. 

{| 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 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 [[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Data | 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.

||[https://qgis.org/download/ Latest 64-bit version of QGIS]. 

[[TUFLOW_QGIS_Plugin| 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.
|| [https://notepad-plus-plus.org/downloads/ Latest 64-bit version of Notepad++]. 

[https://downloads.tuflow.com/_archive/Miscellaneous/NPP_TUFLOW_Syntax_Highlighting.zip TUFLOW syntax highlighting for Notepad++]. 

For instructions on configuring Notepad++ for TUFLOW modeling, see [[NotepadPlusPlus_Tips |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 [https://wiki.tuflow.com/GeoPackage_Tips GeoPackage Tips].
:*[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/TUFLOW_SWMM_Tutorial_Models_QGIS_GPKG.zip TUFLOW SWMM Tutorial Dataset - QGIS - GPKG]

=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_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
:*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
:*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
:*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
:*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM: Automated (Recommended) Approach]] - How to convert an XPSWMM model to TUFLOW SWMM: Automated XPX Conversion Tool Approach.
:*[[XPSWMM_to_TUFLOW-SWMM_Archive | XPSWMM to TUFLOW SWMM: Manual Approach]] - How to convert an XPSWMM model to TUFLOW SWMM: Manual Approach.

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

* [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]
* [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/ TUFLOW 2023-03-AD Release notes - SWMM Section]
* [[TUFLOW QGIS Plugin#Processing_Toolbox|TUFLOW QGIS Plugin Documentation including SWMM 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''': [https://www.epa.gov/water-research/storm-water-management-model-swmm www.epa.gov]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics) ]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydraulics_Addendum-20220210mas2wr.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics Addendum) ]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume3_Water_Quality_P100P2NY.pdf SWMM5 Reference Manual - Volume 3 (Water Quality) ]
*[https://downloads.tuflow.com/SWMM/swmm-users-manual-version-5.2.pdf EPA SWMM5 User's Manual]

 
'''TUFLOW''': [https://www.tuflow.com www.tuflow.com]
*[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]
*[[Tutorial_Introduction#Tutorial_Modules | TUFLOW Tutorial Models]]

=Contact=
For comments, requests and feedback contact [mailto:support@tuflow.com support@tuflow.com]. 
For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 

{{Tips Navigation
|uplink=[[Main_Page| Back to Wiki Main Page]]
}}

XPSWMM to TUFLOW-SWMM

2025-11-25T01:27:33Z

Chris Huxley: /* TUFLOW Simulation Execution */

= Introduction =
This Wiki page outlines recommended steps for the conversion of an XPSWMM model to TUFLOW. 

XPSWMM is a flood and urban stormwater drainage modeling software developed by Autodesk (previously Innovyze and XP Solutions). The XPSWMM solution uses EPA SWMM for its 1D calculations, dynamically linked to TUFLOW for its 2D calculations. The software functions within a custom build Graphical User Interface (GUI). Unknown to many XPSWMM modelers, during simulation, XPSWMM processes its inputs into TUFLOW files and also calls TUFLOW for the 2D calculations. As XPSWMM uses TUFLOW for its 2D engine, like-for-like results can be achieved using this software. The modeling workflow in TUFLOW differs from XPSWMM, as TUFLOW modeling is integrated with QGIS (Geographical Information System) GIS software instead of embedded within a software specific Graphical User Interface.

If you are building a TUFLOW SWMM model from scratch, not from XPSWMM, please refer to the [[TUFLOW_SWMM_Tutorial_Introduction | TUFLOW SWMM Tutorials]]. Tutorials are provided for the following topics:
* [[TUFLOW SWMM Tutorial M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
* [[TUFLOW SWMM Tutorial M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
* [[TUFLOW SWMM Tutorial M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
* [[TUFLOW SWMM Tutorial M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.

== Dataset Download ==
The dataset used for this model conversion demonstration is available for download here: [https://downloads.tuflow.com/SWMM/XPSWMM_XPX_to_TUFLOW_Conversion.zip XPSWMM XPX to TUFLOW Conversion Dataset]. 
This dataset contains the XPSWMM model and the resulting TUFLOW model that is created. These can be found in the '''XPSWMM''' and '''Complete_Conversion''' folders respectively. 

'''If you are using this example conversion dataset, please rerun the XPSWMM model in the location where you save the dataset before beginning your own TUFLOW model conversion.''' Rerunning the model is necessary because XPSWMM will write TUFLOW files during its preprocessing, subsequently defining the correct file path information (for the location where you saved your files) in the newly written TUFLOW files. We also recommend creating your own TUFLOW model in a different folder from the provided TUFLOW dataset so you can easily compare your model against it. 

If you do not have access to a XPSWMM license and the XPSWMM Application, please refer to the [[XPSWMM_to_TUFLOW-SWMM_Troubleshooting#Model_Conversion_Without_a_XPSWMM_License |XPSWMM to TUFLOW SWMM Troubleshooting]] page. 

= XPSWMM to TUFLOW Model Conversion =
== Export Data From XPSWMM Model ==
'''Digital Terrain Model (DTM) Data''' 
XPSWMM reads its 2D DTM data in one of two ways:
* The DTM data can be directly specified in the '2D Model Settings', or
* The DTM data can be internally processed by XPSWMM using its terrain tools and DTM builder.
Depending on which method is applied to your XPSWMM model, the steps required to will vary. Review which method is used:
<ol>
<li> Open your existing model in XPSWMM.
<li> In the top dropdown menu options, go to Configuration > Job Control > 2D Model Settings. This will open a dialog.
<li> Under '2D Hydraulics Job Control', select 'Surface & Sampling'.
<li> Review the options in the 'Surface' section:
:* If 'Use DTM' is selected: Continue to the section below ([[XPSWMM_to_TUFLOW-SWMM#Export_DTM_Data_from_XPSWMM |Export DTM Data from XPSWMM]]) and complete the steps.
:* If 'Use Grid File for Topography' is selected and a 'Grid file' is specified, the steps outlined in the 'Export DTM Data From XPSWMM' section can be skipped. Go to the [[XPSWMM_to_TUFLOW-SWMM#Export_XPX_Data_From_XPSWMM|Export XPX Data From XPSWMM]] section.
'''Note:''' If you have a .tif elevation file, you can continue to the [[XPSWMM_to_TUFLOW-SWMM#Export_XPX_Data_From_XPSWMM|Export XPX Data From XPSWMM]] section. The conversion process will be identical however, once converted, you will have to create the '''TUFLOW\model\grid''' folder manually and copy the .tif file into it.
 
{{Video|name=Animation_XPtoTUFLOW_Export_Data_01b.mp4|width=1350}}
 
</ol>

=== Export DTM Data From XPSWMM ===
If 'Use DTM' was selected, XPSWMM preprocesses its Digital Terrain Model (DTM) into a binary XPTIN elevation dataset for inclusion in the TUFLOW model. XPTIN is a binary format that can't readily be used in GIS software. For this reason, the following steps outline how to obtain a DTM dataset in a GIS friendly form.
<ol>
<li> In the XPSWMM Layers panel, under 'Topography', right click on '''DTM''' and select 'Export DTM Data'.
:* Input TIN File: Select the relevant XPSWMM Input TIN file.
:* Output File Format: 'ASCII Grid File Format'.
:* Cell Size Value: Choose a suitable DTM resolution. This resolution should be finer than the hydraulic model resolution. Typically, a DTM resolution is 1/5th to 1/10th of the hydraulic model 2D cell size is common (1 in the example dataset).
''Note: XPSWMM requires an integer cell size value for this export step. For example, Cell Size Values of 1, 2, 3, 4, 5 ... are suitable. The XPSWMM export will not function if you specify a decimal cell size value (eg. 0.5, 2.5, etc.).''
<li> Click 'Export'.
<li> Save the file under an appropriate name (e.g. '''1D2D_Urban_Grid.asc''') to the folder where XPSWMM writes the .tcf during its simulation preprocessing. By default, this is the '''2D\Data''' folder. 
If this folder does not exist, either:
:* The XPSWMM model has not run, so the TUFLOW control files have not been created by XPSWMM. Run the XPSWMM model (go to Analyze > Solve... in top dropdown menu options).
:* Non-default output settings have been specified in XPSWMM. To determine the output location, in the top dropdown menu options, go to Configuration > Job Control > 2D Model Settings > Folder Options. Ensure the following 'Folder Locations' are selected.
::[[File: XPSWMM_to_TUFLOW_2DJobControl_FolderOptions_Dialog_01e.png]] 

<li> In the top dropdown menu options, navigate to Configuration > Job Control > 2D Model Settings. This will open a dialog, under '2D Hydraulics Job Control', select 'Surface & Sampling'.
<li> Tick on 'Use grid file for topography' and select '...' to navigate to the Grid file saved in the '''2D\Data''' folder. This file will be read directly into TUFLOW.
<li> Click 'OK' to save the settings.
<li> Run the XPSWMM model to rewrite the TUFLOW files (including the new linkage to the DTM dataset) to the Data folder (go to Analyze > Solve... in top dropdown menu options).
 
{{Video|name=Animation_XPtoTUFLOW_Export_Data_02b.mp4|width=1350}}
 
</ol>

=== Export XPX Data From XPSWMM ===
A XPX file is a simple command line file that contains the information needed to create link and node objects. To export this data from the XPSWMM model:
<ol>
<li> In XPSWMM, in the top dropdown menu options, navigate to File > Import/Export Data > Export XPX Data. This will open a dialog. Leave all options as default and click 'Export'.
<li> When prompted, save the file under an appropriate name (eg '''1D2D_Urban_001.xpx''') to the folder where the XPSWMM model is located.
 
{{Video|name=Animation_XPtoTUFLOW_Export_Data_03b.mp4|width=1350}}
 
</ol>

== Convert XPSWMM Model to TUFLOW SWMM ==
Ensure you have QGIS and have the QGIS TUFLOW Plugin installed:
*Install QGIS 3.34 or later: [https://www.qgis.org/download/ Latest 64-bit version of QGIS].
*Install the QGIS TUFLOW Plugin by following the instructions, [[TUFLOW_QGIS_Plugin | QGIS TUFLOW Plugin Installation]].

The following steps outline the process of converting a XPSWMM model to TUFLOW SWMM using the '[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]' processing tool.

<ol>
<li> Open QGIS and go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li> Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]'. This opens the dialog shown below.
:* XPSWMM Exported XPX File: Click '...' and navigate to the exported XPX data (e.g. '''1D2D_Urban_001.xpx'''). This should be located in the same folder as the XPSWMM model.
:* TUFLOW TCF Filename: Click '...' and navigate to the XPSWMM .tcf. This should be located in the '''2D\Data''' folder (e.g. '''2D\Data >> 1D2D_Urban_001.tcf''').
:* SWMM File Prefix: Choose an appropriate prefix for the SWMM files (e.g. '''1D2D_Urban_swmm''').
:* Output Solution Scheme: 'HPC'
:* Output Hardware Specification: 'GPU' (if GPU is not available, select 'CPU')
:* Output Vector Format: 'GPKG'
:* Output Raster Format: 'GTIFF'
:* Output Profile: Any option can be used. 'ALL IN ONE' is used in this example for model design consistency with the [[Tutorial_Introduction | TUFLOW SWMM Tutorials]].
:* Event name if no global storms: Choose an appropriate event name if applicable (100yr in the example dataset).
:* BC width for created 1D/2D connections (HX/SX): This value should be approximately 2 times the width of the hydraulic model 2D cell size (10 in the example dataset).
:* BC offset distance for created 1D/2D connections (HX/SX): Distance from the channel endpoint to the midpoint of the BC line (2 in the example dataset).
:* Output Folder: Click '...' and navigate to an appropriate location to save your TUFLOW model. In this location, create a new folder called '''TUFLOW''' and select it.
:* Output CRS: Select an appropriate Coordinate Reference System (CRS) for the model. For the demonstration model, the CRS is 'EPSG:32760 - WGS 84 / UTM zone 60S'.
<li> Click 'Run'. Once the tool is finished, click 'Close'.
 
{{Video|name=Animation_XPtoTUFLOW_Convert_01c.mp4|width=1350}}
 
</ol>

Inspect the output of the '[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]' processing tool and load the TUFLOW model into QGIS:
<ol>
<li> In Windows File Explorer, inspect the files output by the processing tool. In particular:
* The '''TUFLOW\bc_dbase''' folder contains the BC Database which will contain any curves used in BC conditions, for easy extending to other events.
* The '''TUFLOW\model''' folder contains the TUFLOW SWMM Control File (TSCF) which holds all commands specific to SWMM, including links to the converted SWMM INP file.
* The '''TUFLOW\model\swmm''' folder contains a GeoPackage database ('''*_convert_messages.gpkg'''). This GeoPackage contains locations and descriptions of any errors or warnings that occurred during the conversion process.
: '''Note:''' Conversion messages are addressed in further detail here [[XPSWMM_to_TUFLOW-SWMM_Troubleshooting#Common_Conversion_Issues |XPSWMM to TUFLOW SWMM Troubleshooting]].
* The '''TUFLOW\runs''' folder contains the TCF. If event(s) are specified, the TCF filename with have event placeholder(s), i.e. '_~e1~_~e2~_' (e.g. '''1D2D_Urban_001_~e1~.tcf'''). Again, if event(s) are used, this folder also contains the TUFLOW Event File (TEF) with the event(s) specified. 
{{Video|name=Animation_XPtoTUFLOW_Convert_02b.mp4|width=800}}
 
<li> Open QGIS, and click on the ‘Load TUFLOW Layers from TCF’ symbol from the QGIS TUFLOW Plugin toolbar.
 
[[File: Tuflow_plugin_load_tcf_layers.png]] 
 
<li> Navigate to the location of the TUFLOW model and go to the '''TUFLOW\runs''' folder. Select the TCF.
<li> In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally
<li> Click ‘Open’ and ‘OK’.
<li> Change the symbology of the DTM dataset:
* In the QGIS Layers panel, right click on the DTM Grid file and select 'Properties'.
* In the Symbology tab, under 'Band Rendering', set the 'Render type' to 'Hillshade' and the 'Z Factor' to 3.
<li> Inspect the output GIS layers.
 
{{Video|name=Animation_XPtoTUFLOW_Convert_03b.mp4|width=1350}}
 
</ol>

== Recommended Additional Conversion Steps ==
While the bulk of the XPSWMM to TUFLOW SWMM model conversion is automated by the '[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]' processing tool, some required or recommended conventions must be implemented/updated manually. Therefore, it is highly recommended to complete the additional conversion steps: [[XPSWMM_to_TUFLOW-SWMM_Recommended_Additional_Conversion_Steps|Recommended Additional Conversion Steps]]. 
These steps can help improve model stability and they may also be helpful to address any messages that occurred when using the conversion tool.
 

== TUFLOW Simulation Execution ==
Set up a simple batch file (.bat) to run TUFLOW. This approach calls the TUFLOW executable file (.exe) and runs the TCF file.
<ol>
<li>Create a new text file in the '''TUFLOW\runs''' folder and save as '''_run_HPC.bat'''.
<li>Open the '''_run_HPC.bat''' in a text editor and include a file path to the TUFLOW executable and the TCF name: 
<tt>set exe="..\..\exe\2025.2.1\TUFLOW_iSP_w64.exe" 
<tt>set run=start "TUFLOW" /wait %exe% -b 
%run% -e1 100yr 1D2D_Urban_001_~e1~.tcf</tt></tt> 
 
'''Note:''' A relative path is used for the executable and the TCF, full file path can also be used.
<li>Save the batch file and double click it in Windows File Explorer to run the simulation. This will open the TUFLOW Console Window and the simulation should be executed.
</ol>

TUFLOW simulations can be executed via numerous ways. A comprehensive summary of the most commonly used approaches is documented in the [[Running_TUFLOW | Running TUFLOW]] Wiki page.

=== Troubleshooting ===
Did your TUFLOW SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]]. 

= TUFLOW SWMM Result Viewing =
Are you familiar with loading and viewing TUFLOW results in QGIS? If not, we strongly recommend self-registering and completing our free eLearning:
[https://www.tuflow.com/training/training-course-catalogue/tt001-e-introduction-to-qgis-for-tuflow-elearning/ Introduction to QGIS for TUFLOW]. 

Our [[TUFLOW_SWMM_Tutorial_Introduction | TUFLOW SWMM Tutorials]] also demonstrate working with TUFLOW SWMM results.

= Recommended Further Reading =
For users who wish to get a better understanding of either 2D TUFLOW or 1D EPA SWMM, the following resources may be of use: 
'''TUFLOW''': [https://www.tuflow.com www.tuflow.com]
*[https://www.tuflow.com/downloads/#tuflow TUFLOW User Manual]
*[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/ TUFLOW 2023-03-AD release notes]
*[[Tutorial_Introduction#Tutorial_Modules | TUFLOW Tutorial Models]]

 
'''EPA SWMM''': [https://www.epa.gov/water-research/storm-water-management-model-swmm www.epa.gov]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics) ]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydraulics_Addendum-20220210mas2wr.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics Addendum) ]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume3_Water_Quality_P100P2NY.pdf SWMM5 Reference Manual - Volume 3 (Water Quality) ]
*[https://downloads.tuflow.com/SWMM/swmm-users-manual-version-5.2.pdf EPA SWMM5 User's Manual]

=Contact=
For comments, requests and feedback contact [mailto:support@tuflow.com support@tuflow.com]. 
For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 

{{Tips Navigation
|uplink=[[Main_Page| Back to Wiki Main Page]]
}}

TUFLOW SWMM Tutorial M04

2025-11-25T01:27:04Z

Chris Huxley: /* Running the Simulation */

= Introduction =
This tutorial, Module 4 of the TUFLOW SWMM tutorial dataset will demonstrate TUFLOW's in-built event management functionality. This powerful functionality runs multiple event combinations (e.g. magnitude, duration, temporal patterns, climate change) using a single set of control files, rather than creating a new set of control files for every event simulation. This tutorial demonstrates how event management can be used on a smaller scale, running only 6 models. 
The real power of event management is seen when running a model of a much greater size. For example, without implementing event management, a project requiring simulation of the following event combinations would require 144 TCF and bc_dbase files:
:*6 x Event Magnitude: 01%, 2%, 5%, 10%, 20% and 50% Annual Exceedance Probability (AEP)
:*8 x Event Duration: 1, 2, 3, 6, 9, 12, 18 and 24 hour storm
:*3 x Climate Change Planning Horizon: current climate, 2050, 2100
Using predefined naming conventions, with TUFLOW's event management functionality, all the events can be executed from a single TCF and bc_dbase file!

This feature of TUFLOW makes management of the model files easier, ensures consistency between the simulations and improves project quality control by reducing the likelihood of human error associated with incorrect file referencing. 

TUFLOW SWMM Tutorial Module 4 builds from the model created in [[TUFLOW_SWMM_Tutorial_M03|TUFLOW SWMM Tutorial Module 3]]. The completed TUFLOW SWMM Module 3 model is provided in the '''''TUFLOW_SWMM_Module_04\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW SWMM linking, we recommend completing TUFLOW SWMM Modules 1, 2 and 3 prior to starting this tutorial. 

= Simulation Control Files =
TUFLOW's automated event management operates by introducing wildcard referencing into the boundary condition database. 
A new control file, called the 'TUFLOW Event File' (TEF) is added. It lists all event titles that are applied to the wildcard character in the boundary condition database. It also lists unique commands to associate with the specific events. 
Models are executed using a batch file, with the event specifically listed as a variable in the batch file syntax.

This tutorial example will upgrade our single simulation model to run six event simulations. The simulations will cater for three Annual Exceedance Probability (AEP) event magnitudes: 5%, 2% and 1% AEP. In Average Recurrence Interval (ARI) terminology, this translates to the 1 in 20, 50 and 100 year ARI events. These three design events will be simulated for two event storm durations: 1 and 2 hours. 

=== TUFLOW Boundary Condition Database (bc_dbase) ===
The first task when upgrading a model to include Event Management functionality is to decide on a naming convention for the event wildcard characters to be used in the bc_dbase.csv.
*Event Magnitude: '''AEP'''
*Event Duration: '''DUR'''
Update the bc_dbase with event magnitude and event duration wildcard characters.
<ol>
<li>Navigate to the '''TUFLOW_SWMM_Module_04\Tutorial_Data''' folder. Copy and paste the following files to the '''TUFLOW_SWMM_Module_04\TUFLOW\bc_dbase''' folder. These files contain the inflows and rainfall for each event magnitude and duration.
:*'''TS04_inflow_05p1hr.csv'''
:*'''TS04_inflow_05p2hr.csv'''
:*'''TS04_inflow_02p1hr.csv'''
:*'''TS04_inflow_02p2hr.csv'''
:*'''TS04_inflow_01p1hr.csv'''
:*'''TS04_inflow_01p2hr.csv'''
:*'''TS04_rainfall_05p1hr.csv'''
:*'''TS04_rainfall_05p2hr.csv'''
:*'''TS04_rainfall_02p1hr.csv'''
:*'''TS04_rainfall_02p2hr.csv'''
:*'''TS04_rainfall_01p1hr.csv'''
:*'''TS04_rainfall_01p2hr.csv''' 
The files with 'inflow' in their name are flow hydrograph boundary conditions sourced from an external hydrology model, such as HEC-HMS, RORB, URBS, WBNM etc. 
The files with 'rainfall' in their name are rainfall depth hyetographs used to define rainfall timeseries in the SWMM urban hydrology section of the model.

<li>Save a copy of the '''bc_dbase_TS03_001.csv''' as '''bc_dbase_TS04_001.csv'''.
<li>Open the file and make the following updates to the 'Source' column. The 'AEP' and 'DUR' wildcards must be between the special character '~' to function as a variable. Note, columns E to I are to remain blank. The final '''bc_dbase_TS04_001.csv''' should look like this: 
 
[[File:SWMM_M04_event_bcdbase_01a.png]] 
 
<li>Save '''bc_dbase_TS04_001.csv'''.
 
{{Video|name=Animation_TS4_Sim_Control_01b.mp4|width=1236}}
 
</ol>

=== TUFLOW Event File (TEF) ===
<ol>
<li>Navigate to the '''TUFLOW_SWMM_Module_04\Tutorial_Data''' folder. Copy the '''TS04_Event_File.tef''' to the '''TUFLOW_SWMM_Module_04\TUFLOW\runs''' folder.
<li>Open the TEF in a Text Editor (Notepad++ is recommended). There are three event magnitudes and two event durations listed:
:*Event Magnitudes: 5% , 2% and 1% AEP
:*Event Durations: 1hr and 2hrs
<li>The event specific commands are contained between the <tt>Define Event</tt> and <tt>End Define</tt> commands.
<li>The <tt>BC Event Source</tt> command is linked to the bc_dbase file ('''bc_dbase_TS04_001.csv'''). In the below examples, any occurrence of '~AEP~' in '''bc_dbase_TS04_001.csv''' will be replaced with '05p' and any occurrence of '~DUR~' in '''bc_dbase_TS04_001.csv''' will be replaced with '1hr'. Also, when the 1 hour event is called the simulation, the end time will be set to 2 hours (instead of 3 hours, as per the other simulations). 
<tt>! EVENT MAGNITUDES</tt> 
<tt>Define Event</tt> <tt> == </tt> <tt>05p</tt>
<ol><tt> BC Event Source </tt> <tt>==</tt> <tt> ~AEP~ | 05p</tt>
</ol><tt>End Define</tt> 
<tt>! EVENT DURATIONS</tt> 
<tt>Define Event</tt> <tt> == </tt> <tt>1hr</tt>
<ol><tt> BC Event Source </tt> <tt>==</tt> <tt> ~DUR~ | 1hr</tt> 
<tt> End Time </tt> <tt>==</tt> <tt> 2</tt>
</ol><tt>End Define</tt>
<li> When TUFLOW runs a simulation, it reads all of the defined events in the TEF, though only uses the event variables specified in the batch file. We will create a compatible batch file shortly.
 
{{Video|name=Animation_TS4_Sim_Control_02c.mp4|width=1236}}
 
</ol>

=== TUFLOW Control File (TCF) ===
<ol>
<li>Open '''TS03_5m_001.tcf''' in a Text Editor (Notepad++ is recommended). Save the file as '''TS04_5m_~e1~_~e2~_001.tcf''' in the '''TUFLOW_SWMM_Module_04\TUFLOW\runs''' folder.
<li>Make the following reference update: 
<tt>BC Database </tt> <tt>== </tt> <tt>..\bc_dbase\bc_dbase_TS04_001.csv</tt> <tt> ! Reference the Boundary Conditions Database</tt> 
<li>Add the following commands to reference the TEF at the end of the TCF: 
<tt>! EVENTS</tt> 
<tt>Event File </tt> <tt>== </tt> <tt>TS04_Event_File.tef</tt> <tt> ! Reference the TUFLOW Event File</tt> 
The location of this command in the TCF is important. If there are any commands associated with an event which overwrite other existing commands (such as <tt>End Time</tt> <tt>==</tt>), the TEF file needs to be processed last for it to take precedence over other commands fulfilling the same purpose. Referencing this file in the last line in the TCF ensures this order of operation occurs as intended. 
<li>Save the TCF.
 
{{Video|name=Animation_TS4_Sim_Control_03c.mp4|width=1236}}
 
</ol>

= Running the Simulation =
<ol>
<li>Save a copy of '''_run_TS03_HPC.bat''' as '''_run_TS04_HPC.bat''' in the '''TUFLOW_SWMM_Module_04\TUFLOW\runs''' folder.

<li>Update the batch file to reference the '''TS04_5m_~e1~_~e2~_001.tcf''' and include event switches (-e1, -e2) defining event magnitude and event duration: 
<tt>'''set'''</tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2025.2.1\TUFLOW_iSP_w64.exe"</tt> 
<tt>'''set'''</tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait</tt> <tt> %exe%</tt> <tt> -b</tt> 
<tt>%run% </tt> <tt> -e1 05p -e2 1hr TS04_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 05p -e2 2hr TS04_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 02p -e2 1hr TS04_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 02p -e2 2hr TS04_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 01p -e2 1hr TS04_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 01p -e2 2hr TS04_5m_~e1~_~e2~_001.tcf </tt> 
<li>Save the batch file and double click it in Windows File Explorer to run the simulation. 
If the model simulation doesn't run, here is a link to some common [[Tutorial_Troubleshooting_QGIS | Trouble Shooting]] advice.
 
{{Video|name=Animation_TS4_Run_Sim_01c.mp4|width=1236}}
 
</ol>

== Troubleshooting ==
Did your TUFLOW SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]]. 

=Advanced Looping Batch File (Optional)=
Looping batch files are a powerful tool to enable high volume simulation management with the least amount syntax, and subsequently manual effort. For example, the following looped batch file executed 1440 simulation using 15 lines of syntax!
 
[[File:SWMM_M04_advanced_looping_batch_01c.png]] 
 

We will convert our sequential formatted batch file to a looped format:
<ol>
<li>Save a copy of '''_run_TS04_HPC.bat''' as '''_run_TS04_HPC_loop.bat''' in the '''TUFLOW_SWMM_Module_04\TUFLOW\runs''' folder.
<li>Add the following commands. Indentation is important in batch files, insert tabs to match the below spacing: 
<tt>echo </tt> <tt>off</tt> 
<tt>set </tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2023-03-AF\TUFLOW_iSP_w64.exe"</tt> 
<tt>set </tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait </tt><tt>%exe%</tt><tt> -b</tt> 
 
<tt>set</tt> <tt> AEP</tt><tt>=</tt><tt>05p 02p 01p</tt> 
<tt>set</tt> <tt> DUR</tt><tt>=</tt><tt>1hr 2hr</tt> 
 
<tt>for </tt><tt>%%a</tt><tt> in </tt><tt>(</tt><tt>%AEP%</tt><tt>)</tt><tt> do </tt><tt>(</tt> 
<ol><tt> for </tt><tt>%%b</tt><tt> in </tt><tt>(</tt><tt>%DUR%</tt><tt>)</tt><tt> do </tt><tt>( </tt> 
<ol><ol><tt> echo </tt><tt>Running </tt><tt>%%a %%b </tt> 
<tt> %run% </tt><tt>-e1 </tt><tt>%%a</tt><tt> -e2 </tt><tt>%%b </tt><tt>TS04_5m_~e1~_~e2~_001.tcf</tt> 
</ol></ol>) 
</ol>) 
'''Note:''' The 'AEP' and 'DUR' are user defined batch file variables. Projects may use different variable names. The 'AEP' refers to an event magnitude (Annual Exceedance Probability) and 'DUR' refers to an event duration.

<li>Save the batch file and double click it in Windows File Explorer to run the simulation.
If the model simulation doesn't run, here is a link to some common [[Tutorial_Troubleshooting_QGIS | Trouble Shooting]] advice.
 
{{Video|name=Animation_TS4_Run_Sim_02b.mp4|width=1236}}
 
</ol>

= Check and Result Files =
When the TUFLOW models were executed via the batch file, the names of check and result files should have been updated to include the event variables from the simulation. For example:

{| class="wikitable" width="60%" style="text-align:center"
!style="background-color:#005581; font-weight:bold; color:white;"| TCF
!style="background-color:#005581; font-weight:bold; color:white;"| Event 1 (-e1)
!style="background-color:#005581; font-weight:bold; color:white;"| Event 2 (-e2)
!style="background-color:#005581; font-weight:bold; color:white;"| Check and Result filename
|-
|rowspan="6"|TS04_5m_'''~e1~_~e2~'''_001.tcf
| 05p || 1hr || TS04_5m_'''05p_1hr'''_001
|-
| 05p || 2hr || TS04_5m_'''05p_2hr'''_001
|-
| 02p || 1hr || TS04_5m_'''02p_1hr'''_001
|-
| 02p || 2hr || TS04_5m_'''02p_2hr'''_001
|-
| 01p || 1hr || TS04_5m_'''01p_1hr'''_001
|-
| 01p || 2hr || TS04_5m_'''01p_2hr'''_001
|}

==Check Sucessful Completion of Multiple Simulations==
Open '''_TUFLOW Simulations.log''' from the '''TUFLOW_SWMM_Module_04\TUFLOW\runs''' folder. Confirm 'Finished' is tagged next to the entry for each of the six simulations we executed. This log confirms the model simulation was completed. 
 
{{Video|name=Animation_TS4_Results_01b.mp4|width=1350}}
 

==Viewing Multiple Simulation Results==
===Load Results===
Open the simulation results in QGIS. When loading multiple simulations which include 1D results (all with the same object IDs), a two step load workflow is recommended to avoid filling the QGIS layer panel with duplicate 1D object entries.
<ol>
<li> Open TUFLOW Viewer from the TUFLOW Plugin toolbar. 
 
[[File:tuflow_plugin_tuflow_viewer.png]] 
 
<li> Open 1D and 2D results: Select File > Load Results. Navigate to the '''TUFLOW\runs''' folder and select '''TS04_5m_~e1~_~e2~_001.tcf'''.
<li> When asked which simulation to load, select '''TS04_5m_01p_1hr_001'''.
<li> When asked 'Do you want to open result GIS layer?', select 'Yes'.
<li> After '''TS04_5m_01p_1hr_001''' has loaded, open the remaining result files:
* Select File > Load Results. Navigate to the '''TUFLOW\runs''' folder and select '''TS04_5m_~e1~_~e2~_001.tcf'''.
* When asked which simulation to load, select all remaining results (except '''TS04_5m_01p_1hr_001''').
* When asked 'Do you want to open result GIS layer?', select 'No'. The results will still be loaded, though will all be associated with the GIS objects loaded for the '''TS04_5m_01p_1hr_001''' simulation.
<li> In the QGIS Layers Panel, move the GIS vector (line and point) layers to the top of the list. This will ensure these layers are displayed above all mesh result layers in the project.
 
{{Video|name=Animation_TS4_Results_02c.mp4|width=1350}}
 
</ol>

===Mesh Results (Map Output)===
Inspect the results for all events.
<ol>
<li>Zoom in to the pipe network area.
<li>Click on the scalar dataset 'Depth' under the 'Result Type' in the TUFLOW Viewer 'Map Outputs' list. Toggle on the maximum depth output by clicking the [[File: max_output_icon.png]] symbol.
<li>Click through the results in the 'Open Results' list to observe the different max depth values.
 
{{Video|name=Animation_TS4_Results_03c.mp4|width=1350}}
 
</ol>

===Vector Results (Pipe Network Output)===
<ol>
<li>In the QGIS Layers Panel, right click '''TS04_5m_01p_1hr_001_swmm_ts_L''', and select 'Show Labels'.
<li>Use the 'Select Features' tool to highlight 'Pipe 3'.
<li>In the 'Open Results' list, select all 1hr duration event results (hold Ctrl to select multiple).
<li>Click on a scalar dataset 'Flow' under the 'Result Type' in the TUFLOW Viewer 'Time Series' list.
<li>Try multiple combinations of the simulation results to observe how the different events impacted flow through 'Pipe 3'.
<li>Click the 'Refresh Current Plot' [[File: Refreshplotblack.png || 20px]] button to update the plot window after making new selections.
<li>Click the 'Clear Current Plot' [[File: QGIS_Plugin_Icon_ClearPlot.png || 20px]] button to remove all data from the plot window if needed prior to making a new selection.
 
{{Video|name=Animation_TS4_Results_04c.mp4|width=1350}}
 
</ol>

= Conclusion =
*Automated Event Management functionality was added to the TUFLOW SWMM model.
*Multiple event simulations were run in sequence from a batch file.
*Creation of looped batch file was demonstrated for the efficient execution of bulk simulations.
*Multiple event simulation results were inspected using the QGIS TUFLOW Viewer.
*For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 

=Other TUFLOW SWMM Tutorials=
*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]] - How to convert an XPSWMM model to TUFLOW SWMM.
 
{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Back to TUFLOW SWMM Tutorial Introduction Main Page]]
}}

TUFLOW SWMM Tutorial M03

2025-11-25T01:26:34Z

Chris Huxley: /* Running the Simulation */

= Introduction =
This tutorial, Module 3 of the TUFLOW-SWMM tutorial dataset, demonstrates how to add SWMM urban hydrology to a 1D SWMM stormwater pipe network / 2D TUFLOW HPC catchment model. TUFLOW-SWMM Tutorial Module 3 builds from the model created in [[TUFLOW_SWMM_Tutorial_M02|TUFLOW SWMM Tutorial Module 2]]. The completed TUFLOW-SWMM Module 2 model is provided in the '''''TUFLOW_SWMM_Module_03\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW-SWMM linking, we recommend completing TUFLOW-SWMM Modules 1 and 2 prior to starting this tutorial. 

= Project Initialization =
==QGIS==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.11 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see [https://wiki.tuflow.com/TUFLOW_QGIS_Plugin Installation of TUFLOW Plugin]. 
Define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<ol>
<li>Open QGIS.
<li>Go to Project > Properties…
<li>In the CRS tab, type ‘WGS 84 / UTM Zone 60S’.
<li>Select the matching projection in the 'Predefined Coordinate Reference Systems' section.
<li>Click ‘Apply’ and ‘OK’.
<li>Ensure that the projection is set correctly by viewing the bottom right hand corner of the workspace. It should read ‘EPSG:32760’.
</ol>
 
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}} 

==TUFLOW Model==
===Load and Style TUFLOW Model Files===
Load in the project GIS layers:
<ol>
<li>Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
 
[[File: Tuflow_plugin_load_tcf_layers.png]] 
 
<li>Navigate to the '''TUFLOW_SWMM_Module_03\TUFLOW\runs''' folder and select '''TS02_5m_001.tcf'''.
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally
<li>Click ‘Open’ and ‘OK’.
</ol>
 
Style the TUFLOW layers. Suggested styling steps were provided in [[TUFLOW_SWMM_Tutorial_M01#Load_and_Style_TUFLOW_Model_Files|TUFLOW SWMM Tutorial M01]]. They have not been duplicated here. 
 

===TUFLOW Plugin===
Next we need to configure the QGIS TUFLOW Plugin settings to link with the project folder where we will build our model: 
<ol>
<li>Open the 'Configure TUFLOW Project' tool by selecting Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.
<li>Set the CRS (Coordinate Reference System) by selecting one of the vector layers associated with the opened model using the drop menu list. For example, ''2d_bc_M01_001_L''.
<li>To set the location of the TUFLOW folder, click 'Browse...' and navigate to the '''TUFLOW_SWMM_Module_03''' folder. Click 'Select Folder'.
<li>To set the location of the TUFLOW single precision executable file, click 'Browse...' and navigate to the '''exe\2023-03-AF''' folder. Select '''TUFLOW_iSP_w64.exe''' and click 'Open'.
<li>Select 'GPKG' as the GIS Format.
<li>Select 'TUFLOW Classic / HPC' as the TUFLOW Engine.
<li>Tick on 'Save Default Settings Globally'.
<li>Click 'OK'. 
 
[[File: TS3_Configure_Project_01a.png]] 
</ol>
 

=== Increment TUFLOW GeoPackage File ===
We will now save a copy of '''TS02_001.gpkg''' with a new name, '''TS03_001.gpkg'''. This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''2d_bc_M01_001_L'''.
<li>Click on the 'Increment Selected Layer' symbol from the TUFLOW Plugin toolbar. This opens the dialog shown below.
 
[[File:tuflow_plugin_increment_layer.png]] 
 
:*Source Layer: Automatically set to the selected layer, '''2d_bc_M01_001_L'''.
:*Output Database: Click 'Browse...'. This will automatically open to the '''TUFLOW\model\gis''' folder. Set the new output database name to '''TS03_001.gpkg''' and click 'Save'.
:*Output Layer Name: This will automatically increment to '''2d_bc_M01_00''2''_L'''. Change the name back to '''2d_bc_M01_00''1''_L'''.
:*Delete the pre-filled 'Incremented Layer' entry in the table. We do not wish to modify the version number associated with the 2d_bc file. This current exercise will not change the version number of any of the GIS layer inputs, it is simply establishing a copy of the existing GeoPackage where future edits will be saved to.
:*Select 'Remove Source Layer from Workspace'.
:*Select 'Increment Layer and Preserve Database'.
<li>Click 'OK'.
<li>The GeoPackage database, '''TS03_001.gpkg''' will now be in the '''TUFLOW_SWMM_Module_03\TUFLOW\model\gis''' folder.
 
{{Video|name=Animation_TS3_Initialization_02b.mp4|width=1236}}
 
</ol>

=== Increment SWMM GeoPackage File ===
SWMM pipe network junction attributes need to be updated when converting a TUFLOW 2D direct rainfall / SWMM 1D model ([[TUFLOW_SWMM_Tutorial_M02|TUFLOW SWMM Tutorial Module 2]]). into a format that uses SWMM hydrology instead of direct rainfall. Similar to above (incrementing the TUFLOW GeoPackage file), we will increment the SWMM pipe network database name so we do not alter the inputs necessary for '''TS02_5m_001.tcf''' to function without issue.
<ol>
<li> In the QGIS Layers Panel, open the '''TS02_001.tscf''' group. In the '''sw02_001.inp''' group, right click '''Links--Conduits'''.
<li> Select TUFLOW > SWMM - Increment GeoPackage. This opens the dialog shown below.
:*Output File: Click the '...'. This will automatically open to the '''TUFLOW\model\swmm''' folder. Set the output database name to '''sw03_001.gpkg''' and click 'Save'.
:*Existing GeoPackage Layers: 'Unload -- do not move'.
<li> Select 'OK'.
<li> The tool will automatically load '''sw03_001.gpkg''' into the QGIS workspace and remove '''sw02_001.inp''' from the QGIS workspace.
<li> In the QGIS Layers Panel, move '''sw03_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project.
 
{{Video|name=Animation_TS3_Initialization_03b.mp4|width=1236}}
 
</ol>

===Save QGIS Project Workspace===
<ol>
<li>Go to Project > Save As.
<li>Navigate to the '''TUFLOW_SWMM_Module_03''' folder and type '''SWMM_M03''' as the filename with the extension .qgz.
</ol>
 

= GIS Inputs =
==Update SWMM GeoPackage Spatial Database==
In previous tutorials we have created new SWMM GeoPackage databases for our new entries. This tutorial will demonstrate a different update approach. Instead of creating a new SWMM GeoPackage database, we will update the existing database, '''sw03_001.gpkg''' by adding new SWMM Sections for the hydrology elements we will be incorporating into the model in this tutorial.

<ol>
<li>Go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_GeoPackage_Add_Sections |GeoPackage - Add sections]]'. This opens the dialog shown below.
:*GPKG filename modify: Click the ... and navigate to the '''TUFLOW_SWMM_Module_03\TUFLOW\model\swmm''' folder. Select '''sw03_001.gpkg'''.
:*CRS for GeoPackage: Click the drop down menu and select 'Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S'.
:*SWMM Sections to add: Click the ..., and tick on:
::*'''Hydrology--Raingages'''
::*'''Hydrology--Subcatchments'''
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
 
{{Video|name=Animation_TS3_SWMM_Inputs_01b.mp4|width=1236}}
 
</ol>

The above steps have added the new sections to the SWMM GeoPackage database, '''sw03_001.gpkg'''. However, the new sections are not currently displayed in the QGIS Layers Panel. We need to close the database and reopen it to view the changes.
<ol>
<li>In the QGIS Layers Panel, right click '''sw03_001''' and select 'Remove Group...'.
<li>In Windows File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''sw03_001.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select 'Add Layers' to open all vectors within '''sw03_001.gpkg'''. By default, all items in the available list should have been selected.
<li>In the QGIS Layers Panel, move '''sw03_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project when we are making edits.
<li>In the QGIS Layers Panel, within the '''sw03_001''' group, move '''Hydrology--Subcatchments''' to the bottom. This will ensure that the other data within this database can be seen.
 
{{Video|name=Animation_TS3_SWMM_Inputs_02b.mp4|width=1236}}
 
</ol>

== SWMM GIS Data Entry ==

A GeoPackage called '''Urban_Hydrology.gpkg''' is provided in the '''TUFLOW_SWMM_Module_03\Tutorial_Data''' folder. It contains one SWMM input layer and one TUFLOW input layer:
:*'''SWMM_Subcatchments''': defines the 1D SWMM urban hydrology subcatchment delineation and associated parameters.
:*'''TUFLOW_Subcatchments''': defines the remaining 2D TUFLOW catchment hydrology subcatchment delineation. 

To populate the SWMM GeoPackage created in the previous section:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_03\Tutorial_Data''' folder. Drag and drop the '''Urban_Hydrology.gpkg''' into QGIS.
<li>When prompted by QGIS select '''SWMM_Subcatchments'''. Click 'Add Layers'.
<li>In the QGIS Layers Panel, right click on the '''SWMM_Subcatchments''' layer and select 'Zoom to Layer(s)'.
<li>Use the 'Select Features' tool to highlight all items included in '''SWMM_Subcatchments'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
<li>In the QGIS Layers Panel, select (left click) the '''sw03_001 >> Hydrology--Subcatchments''' layer.
<li>Make the '''sw03_001 >> Hydrology--Subcatchments''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle the editing off to save the edits.
<li>Remove '''Urban_Hydrology''' from the QGIS Layers Panel.
 
{{Video|name=Animation_TS3_SWMM_Inputs_03b.mp4|width=1236}}
 

</ol>

==SWMM GIS Data Updates==
The following updates are being made to the objects and layers within '''sw03_001.gpkg'''.

===Update SWMM Hydrology Raingages===
The text information within '''Hydrology--Raingages''' defines the pluviographs in the catchment. We will link to two different rain gages in this example. 
'''Note:''' 'Gage' is the American spelling of 'Gauge' in Oxford English.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''Hydrology--Raingages''' and toggle on editing.
<li>Right click '''Hydrology--Raingages''' and select 'Open Attribute Table'.
<li>Click 'Add Feature' twice. Enter the following attributes (leave all other fields as ''NULL''):
{| class="wikitable" width="60%"
!style="background-color:#005581; font-weight:bold; color:white;"| Name
!style="background-color:#005581; font-weight:bold; color:white;"| Form
!style="background-color:#005581; font-weight:bold; color:white;"| Intevl
!style="background-color:#005581; font-weight:bold; color:white;"| SnowCatchDeficiency
!style="background-color:#005581; font-weight:bold; color:white;"| Format
!style="background-color:#005581; font-weight:bold; color:white;"| Tseries
|-
| RF_G1 || Volume || 0.1 || 1 || TIMESERIES || RF_FC04
|-
| RF_G2 || Volume || 0.1 || 1 || TIMESERIES || RF_FC07
|}
For a summary of the attributes associated with '''Hydrology--Raingages''', refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Raingages TUFLOW 2023-03-AD Release Notes (Table A.11)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)]. 
Note, the spatial locations where the gage information is applied is covered in the following section.
<li> Turn off editing and save the information.
 
{{Video|name=Animation_TS3_SWMM_Inputs_04b.mp4|width=1236}}
 
</ol>

===Update SWMM Hydrology Subcatchments===
The information within '''Hydrology--Subcatchments''' defines the subcatchment parameters (including catchment area, width, slope, percent impervious, outlet specification and infiltration details). All required data entries have been pre-filled in the supplied dataset except the 'Area' information, which we will determine using QGIS. SWMM requires the hydrology subcatchment area information in hectares.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Hydrology--Subcatchments''' and toggle on editing.
<li>Right click '''Hydrology--Subcatchments''' and select 'Open Attribute Table'.
<li>Choose 'Area' as the target field and type the calculation expression, 'area($geometry) / 10000'.
:* 'area($geometry) ': Extracts the area of each region (subcatchment) in '''Hydrology--Subcatchments'''.
:* '/ 10000': Converts the area values into hectares. 
'''Note:''' The projection used in these tutorials is measured in meters. Thus, when QGIS extracts the area from a region, it reports the area in m2. If using a projection that is measured in feet, QGIS would extract the area in ft2.
<li>Click 'Update All'.
<li>Turn off editing and save the information.
<li>Inspect the attribute information within '''Hydrology--Subcatchments''' to familiarize yourself with the data. A few demonstration features have been included in the dataset.
:*Two rainfall gages are linked to the subcatchments. Downstream subcatchments linked to rain gage 'RF_G1'. Upstream subcatchments are linked to rain gage 'RF_G2'.
:*Subcatchments 'SPit11A' and 'SPit11A' are being routed to subcatchment 'SPit11C' before entering the SWMM pipe network. All other hydrology subcatchments route directly to a SWMM '''Node--Junctions'''. 
For a summary of the attributes associated with the layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Subcatchments TUFLOW 2023-03-AD Release Notes (Table A.38)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)].
 
{{Video|name=Animation_TS3_SWMM_Inputs_05b.mp4|width=1236}}
 
</ol>

===SWMM Options===
SWMM '''Project--Options''' defines the SWMM simulation controls, such as hydrology computation timestep. '''Project--Options''' are not required in the new GeoPackage database we are creating for this Tutorial. This is because this model will be constructed from multiple SWMM input (INP) files:
:*'''sw01_001.inp''' (road culverts).
:*'''sw03_001.inp''' (underground pipe network inputs and SWMM hydrology).
When TUFLOW processes SWMM inputs, it combines the multiple INP files into one single INP prior to simulation. For this model, the simulation control parameters defined in Module 1 ('''sw01_001 > Project--Options''') will apply. The options relevant to this tutorial that have already been defined in the Module 1 input include:
:*'''flow_units''': set to metric.
:*'''infiltration''' method: set to Green Ampt.
We need to change the SWMM hydrology timestep details. Updating this setting in the '''sw01_001.inp''' does not impact any of the previous tutorial modules, as they did not include any hydrology components.
<ol>
<li>In the QGIS Layers Panel, open the '''TS02_001.tscf''' group and select (left click) '''sw01_001 >> Project--Options''' and toggle on editing.
<li>Right click '''Project--Options''' and select 'Open Attribute Table'.
<li>Update the following hydrology timestep options:
:*WET_STEP: 00:01:00
:*DRY_STEP: 00:01:00
<li>Turn off editing to save the edits.
 
{{Video|name=Animation_TS3_SWMM_Inputs_06b.mp4|width=1236}}
 
</ol>

== Export SWMM INP File ==
We will now create a new INP file for the pipe network and SWMM urban hydrology inputs and update '''sw01_001.inp''' to reflect the changes made to the hydrology options above.

<ol>
<li>In the QGIS Layers Panel, right click '''Hydrology--Subcatchments''' (or any other SWMM layer in the same GeoPackage) and select 'TUFLOW' > 'SWMM - Export inp file'.
<li>This will open the '[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]' processing tool, prepopulated with the filename of the layer's GeoPackage. 
'''Note:''' This tool can also be activated from the Processing Toolbox.
<li>Click 'Run'.
<li>Once the tool is finished, update the 'GeoPackage Input File' parameter. Click '...', and navigate to the '''TUFLOW\model\gis''' folder. Select '''sw01_001.gpkg'''.
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>This tool will save the SWMM inp files in the same folder location and with the same name as the GeoPackage input file. In this case, it will save '''sw03_001.inp''' and '''sw01_001.inp''' to the '''TUFLOW\model\swmm''' folder.
 
{{Video|name=Animation_TS3_SWMM_Inputs_07b.mp4|width=1236}}
 
</ol>

==TUFLOW GIS Updates==
We will be reverting the TUFLOW model back to a configuration that uses inflows from an external hydrology model (as per Module 1), instead of 2D direct rainfall (Module 2), in the areas not covered by SWMM urban hydrology. Instead of reusing the input from Module 1, we will need to use a new TUFLOW source area inflow layer. This will ensure that we do not double count the flow generated over the area now represented by SWMM.

<ol>
<li>Click on the ‘Import Empty File’ symbol from the TUFLOW plugin toolbar. 
[[File:tuflow_plugin_import_empty_file.png]] 
 
<li>Select '2d_sa' from the Empty Type list.
<li>In the Run ID box write 'TS03_001'.
<li>Tick the 'Regions' Geometry Type.
<li>In the Spatial Database Options, select 'All to one'. Navigate to the '''TUFLOW_SWMM_Module_03\TUFLOW\model\gis''' folder and select '''TS03_001.gpkg'''. Click Save and hit 'OK'.
<li>The '''2d_sa_TS03_001_R''' appears in the QGIS Layers Panel. 
 
[[File:TS3_import_empty_2d_sa_01a.png]] 
 
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_03\Tutorial_Data''' folder. Drag and drop the '''Urban_Hydrology.gpkg''' into QGIS.
<li>When prompted by QGIS, select '''TUFLOW_Subcatchments'''. Click 'Add Layers'.
<li>In the QGIS Layers Panel, select (left click) the '''TUFLOW_Subcatchments''' layer.
<li>Use the 'Select Features' tool to highlight the four regions included in '''TUFLOW_Subcatchments'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
<li>In the QGIS Layers Panel, select (left click) the '''2d_sa_TS03_001_R''' layer.
<li>Make the '''2d_sa_TS03_001_R''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle off editing to save the edits.
<li>Remove '''Urban_Hydrology.gpkg'''. 
The polygon entry we have updated refers to a new subcatchment name for the region adjacent to the SWMM subcatchments. The new name is 'FC06.62', instead of 'FC06'. When we update the TUFLOW Control files we will configure the file references so we are sourcing data from a new flow file obtained from an external hydrology model that has been updated with the reduced catchment area, in recognition of SWMM being used for the flow estimate in the proposed urban development area. 
'''Note:''' Common hydrology software used in combination with TUFLOW by modelers include: HEC-HMS, RORB, Drains, WBNM, URBS and more.''
 
{{Video|name=Animation_TS3_TUFLOW_Inputs_01b.mp4|width=1236}}
 
</ol>

==TUFLOW Boundary Updates==
As a result of the changes made to the TUFLOW inflows, new TUFLOW Boundary Condition csv files are also needed. Updated files have been provided in the '''TUFLOW_SWMM_Module_03\Tutorial_Data''' folder. These files provide the values and model linkages to the new hydrology inflows, which include the 'FC06.62' entry.
<ol>
<li>Copy '''bc_dbase_TS03_001.csv''' and '''TS03_01p2hr.csv''' from the '''TUFLOW_SWMM_Module_03\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_03\TUFLOW\bc_dbase''' folder.
 
{{Video|name=Animation_TS3_TUFLOW_Boundary_01b.mp4|width=1236}}
 
</ol>

=Simulation Control Files=
To avoid the potential risk of overwriting existing control files accidentally, we will start by saving new control files where we will be making subsequent syntax updates during the following steps.
<ol>
<li>Open '''TS02_5m_001.tcf''' in a Text Editor (Notepad++ is recommended). Save the file as '''TS03_5m_001.tcf''' in the '''TUFLOW_SWMM_Module_03\TUFLOW\runs''' folder.
<li>Using the 'Open File' function in Notepad++:
:*Open '''TS02_001.tbc,''' and save the file as '''TS03_001.tbc''' in the '''TUFLOW\model''' folder.
:*Open '''TS02_001.tscf,''' and save the file as '''TS03_001.tscf''' in the '''TUFLOW\model''' folder.
 
</ol>

===TUFLOW Control File (TCF)===
<ol>
<li>Edit '''TS03_5m_001.tcf''' by making the following reference updates: 
<tt>Spatial Database </tt> <tt>== </tt> <tt>..\model\gis\TS03_001.gpkg</tt> <tt> ! Specify the location of the GeoPackage Spatial Database</tt> 
<tt>BC Control File</tt> <tt> == </tt> <tt>..\model\TS03_001.tbc</tt> <tt> ! Reference the TUFLOW Boundary Condition Control File</tt> 
<tt>BC Database</tt> <tt> == </tt> <tt>..\bc_dbase\bc_dbase_TS03_001.csv</tt> <tt> ! Reference the Boundary Condition Database</tt> 
<tt>SWMM Control File</tt> <tt> == </tt> <tt>..\model\TS03_001.tscf</tt> <tt> ! Reference the SWMM (1D) Control File</tt> 
<li> Add the following command to the '<tt>Time Control</tt>' section. This command is necessary for many TUFLOW-SWMM models, especially when using SWMM hydrology. The 2D timestep dictates the SWMM 1D timestep. Generally, this timestep is adequate for SWMM but in cases where the flows are contained in the 1D, the timestep may become too large for SWMM. This command forces it into the appropriate range. If this command is neglected, some models will experience very high mass errors. The range of timesteps used is reported in the SWMM .rpt file ('''TS03_5m_001_swmm.rpt''') in the '''TUFLOW\results''' folder. 
<tt>Timestep Maximum </tt> <tt>== </tt> <tt>3</tt> <tt> ! Specifies a maximum timestep of 3 seconds</tt> 
<li> Comment out the 'Map Cuttoff Depth' command by placing a '!' at the beginning of the line. This command is only necessary for 2D direct rainfall (rain on grid) modelling (SWMM Tutorial 2). 
<tt>! Map Cutoff Depth == 0.05</tt> 
 
{{Video|name=Animation_TS3_Sim_Control_01b.mp4|width=1236}}
 
</ol>

===TUFLOW Boundary Control File (TBC)===
<ol>
<li>Edit '''TS03_001.tbc'''.
<li>Comment out the 'Global Rainfall BC' command by placing a '!' at the beginning of the line. This command is only necessary for 2D direct rainfall (rain on grid) modelling (SWMM Tutorial 2). 
<tt>! Global Rainfall BC == RF_FC04</tt>
 
<li>Add the following additional command: 
<tt>Read GIS SA</tt><tt> == </tt><tt>2d_sa_TS03_001_R </tt><tt>! Reads in 2D source area - Excluding SWMM areas</tt> 
 
{{Video|name=Animation_TS3_Sim_Control_02c.mp4|width=1236}}
 
</ol>

===TUFLOW SWMM Control File (TSCF)===
<ol>
<li>Edit '''TS03_001.tscf'''.
<li>Replace <tt>Read SWMM</tt><tt> == </tt><tt>swmm\sw02_001.inp</tt> with the following command: 
<tt>Read SWMM</tt><tt> == </tt><tt>swmm\sw03_001.inp</tt> 
<li>As we are pushing flows from the subcatchments straight to the pipe network, the water level of the ponded water at the nodes can become much higher than the 2D water levels. The inlet will surcharge but the flow is throttled. The following command will pull water out of the 2D if the 1D ponded water level goes beyond 0.1 m higher than the 2D (not needed for rain on grid simulations). Add the following command: 
<tt>Maximum Inlet Ponded Depth</tt><tt> == </tt><tt>0.1 </tt><tt>! Pull ponded water out of the 1D domain as needed</tt> 
<li>Add the following command: 
<tt>Read BC Timeseries</tt><tt> == </tt><tt>RF_FC04 | RF_FC07 </tt><tt>! TUFLOW BC Database / SWMM Rain Gage Linkage</tt> 
 
{{Video|name=Animation_TS3_Sim_Control_03c.mp4|width=1236}}
 
</ol>

=Running the Simulation=
<ol>
<li>Save a copy of '''_run_TS02_HPC.bat''' as '''_run_TS03_HPC.bat''' in the '''TUFLOW_SWMM_Module_03\TUFLOW\runs''' folder.
<li>Update the batch file to reference the '''TS03_5m_001.tcf''' : 
<tt>'''set'''</tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2025.2.1\TUFLOW_iSP_w64.exe"</tt> 
<tt>'''set'''</tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait</tt> <tt> %exe%</tt> <tt> -b</tt> 
<tt>%run% </tt> <tt>TS03_5m_001.tcf </tt>

<li>Save the batch file and double click it in Windows File Explorer to run the simulation. 
<li>Did your TUFLOW-SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]]. 
 
{{Video|name=Animation_TS3_Run_Sim_01c.mp4|width=1236}} 
</ol>

= Check Files =
Review the SWMM INP and simulation report file from the '''TUFLOW_SWMM_Module_03\TUFLOW\results''' folder to confirm the new hydrology inputs are being processed correctly:
* View '''TS03_5m_001_swmm.inp''' in a text editor to confirm the combining of the two input INP files has occurred correctly. Also use the QGIS Processing tool, [[QGIS_SWMM_GeoPackage_Create_from_SWMM_inp |GeoPackage - Create from SWMM inp ]], to view the information in QGIS.
* View '''TS03_5m_001_swmm_curves.inp''' in a text editor to confirm the rainfall time series that has been used by the SWMM hydrology engine matches the input dataset.
* View '''TS03_5m_001_swmm.rpt''' in a text editor to confirm the model computation is healthy in term of mass conservation.

= Results Output =
Complete the steps outlined in following link to review the simulation results from the TUFLOW SWMM model simulation:

[[TUFLOW_SWMM_Tutorial_M03_Results_QGIS | TUFLOW SWMM Tutorial 03 Results]] 

= Conclusion =
*EPA SWMM urban hydrology was added to the model (replacing 2D drect rainfall / rain-on-grid).
*The 1D SWMM pipe urban pipe network junction attributes were updated to accomodate for the change in model configuration, from 2D direct rainfall to 1D SWMM hydrology.
*Check and result files associated with the SWMM hydrology modelling were inspected.
*For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com].
 

=Other TUFLOW SWMM Tutorials=
*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]] - How to convert an XPSWMM model to TUFLOW SWMM.
 
{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Return to TUFLOW SWMM Tutorial Introduction Main Page]]
}}

TUFLOW SWMM Tutorial M02

2025-11-25T01:25:42Z

Chris Huxley: /* Running the Simulation */

= Introduction =
This tutorial, Module 2 of the TUFLOW SWMM tutorial dataset will demonstrate how to model underground stormwater pipe networks using SWMM, linked to the TUFLOW HPC 2D solution scheme. Boundary condition inflows to the model are defined using TUFLOW's 2D direct rainfall (rain on grid) approach. TUFLOW SWMM Tutorial Module 2 builds from the model created in [[TUFLOW_SWMM_Tutorial_M01|TUFLOW SWMM Tutorial Module 1]]. The completed TUFLOW SWMM Module 1 model is provided in the '''''TUFLOW_SWMM_Module_02\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW SWMM linking, we recommend completing TUFLOW SWMM Module 1 prior to starting this tutorial. 

= Project Initialization =
==QGIS==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.11 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see [https://wiki.tuflow.com/TUFLOW_QGIS_Plugin Installation of TUFLOW Plugin]. 
Define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<ol>
<li>Open QGIS.
<li>Go to Project > Properties…
<li>In the CRS tab, type ‘WGS 84 / UTM Zone 60S’.
<li>Select the matching projection in the 'Predefined Coordinate Reference Systems' section.
<li>Click ‘Apply’ and ‘OK’.
<li>Ensure that the projection is set correctly by viewing the bottom right hand corner of the workspace. It should read ‘EPSG:32760’.
</ol>
 
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}} 

==TUFLOW Model==
===Load and Style TUFLOW Model Files===
Load in the project GIS layers:
<ol>
<li>Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
 
[[File: Tuflow_plugin_load_tcf_layers.png]] 
 
<li>Navigate to the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder and select '''TS01_5m_001.tcf'''.
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally
<li>Click ‘Open’ and ‘OK’.
</ol>
 
Style the TUFLOW layers. Suggested styling steps were provided in [[TUFLOW_SWMM_Tutorial_M01#Project_Initialization|TUFLOW SWMM Tutorial M01]]. They have not been duplicated here. 
 

===TUFLOW Plugin===
Next we need to configure the QGIS TUFLOW Plugin settings to link with the project folder where we will build our model: 
<ol>
<li>Open the 'Configure TUFLOW Project' tool by selecting Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.
<li>Set the CRS (Coordinate Reference System) by selecting one of the vector layers associated with the opened model using the drop menu list. For example, ''2d_bc_M01_001_L''.
<li>To set the location of the TUFLOW folder, click 'Browse...' and navigate to the '''TUFLOW_SWMM_Module_02''' folder. Click 'Select Folder'.
<li>To set the location of the TUFLOW single precision executable file, click 'Browse...' and navigate to the '''exe\2023-03-AF''' folder. Select '''TUFLOW_iSP_w64.exe''' and click 'Open'.
<li>Select 'GPKG' as the GIS Format.
<li>Select 'TUFLOW Classic / HPC' as the TUFLOW Engine.
<li>Tick on 'Save Default Settings Globally'.
<li>Click 'OK'. 
 
[[File: TS2_Configure_Project_01a.png]] 
</ol>
 

=== Increment TUFLOW GeoPackage File ===
We will now save a copy of '''TS01_001.gpkg''' with a new name, '''TS02_001.gpkg'''. This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''2d_bc_M01_001_L'''.
<li>Click on the 'Increment Selected Layer' symbol from the TUFLOW Plugin toolbar. This opens the dialog shown below.
 
[[File:tuflow_plugin_increment_layer.png]] 
 
:*Source Layer: Automatically set to the selected layer, '''2d_bc_M01_001_L'''.
:*Output Database: Click 'Browse...'. This will automatically open to the '''TUFLOW\model\gis''' folder. Set the new output database name to '''TS02_001.gpkg''' and click 'Save'.
:*Output Layer Name: This will automatically increment to '''2d_bc_M01_00''2''_L'''. Change the name back to '''2d_bc_M01_00''1''_L'''.
:*Delete the pre-filled 'Incremented Layer' entry in the table. We do not wish to modify the version number associated with the 2d_bc file. This current exercise will not change the version number of any of the GIS layer inputs, it is simply establishing a copy of the existing GeoPackage where future edits will be saved to.
:*Select 'Remove Source Layer from Workspace'.
:*Select 'Increment Layer and Preserve Database'.
<li>Click 'OK'.
<li>The GeoPackage database, '''TS02_001.gpkg''' will now be in the '''TUFLOW_SWMM_Module_02\TUFLOW\model\gis''' folder.
 
{{Video|name=Animation_TS2_Initialization_02c.mp4|width=1236}}
 
</ol>

===Save QGIS Project Workspace===
<ol>
<li>Go to Project > Save As.
<li>Navigate to the '''TUFLOW_SWMM_Module_02''' folder and type '''SWMM_M02''' as the filename with the extension .qgz.
</ol>
 

= GIS Inputs =
==Create SWMM GeoPackage Spatial Database==
We will create a new SWMM GeoPackage database for our pipe network feature entries:
<ol>
<li>Go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_GeoPackage_Create |GeoPackage - Create]]'. This opens the dialog shown below.
:*To set the ‘CRS for GeoPackage’: Click the drop down menu and select ‘Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S’.
:*To set the ‘Initial SWMM Sections’: Click the …, and tick on (if not already ticked):
::*'''Nodes--Junctions''', '''Nodes--Outfalls.'''
::*'''Links--Conduits, Links--Streets.'''
::*'''Inlets--Inlets.'''
:*To define the ‘GPKG filename to create’: Click the …, select ‘Save to File’. Navigate to the '''TUFLOW\model\swmm''' folder and save the GeoPackage Database as '''sw02_001.gpkg'''.
::'''Note:''' In Module 1 we also included '''Nodes--Storage''', '''Project--Title''', '''Project--Options''', and '''Project--Report''' in the GeoPackage file. '''Project--Options''' is not required this time as this tutorial model will use two SWMM INP files. The file created during Module 1 (for the road culverts) and the INP is to be created from this GeoPackage (for the underground pipe network inputs). When TUFLOW processes SWMM inputs, it combines the multiple INP files into one before simulation. As such, the details from the Module 1 '''Project--Options''' input will be used in this tutorial. If '''Project--Options''' are included in multiple Geopackage/INP files, the entry that is referenced lowest in the TUFLOW SWMM Control file (TSCF) will be used. '''Nodes--Storage''' will not be used in this tutorial, as these are only needed to represent detention, or for nodes connected using HX boundaries.
<li>Click 'Run'.
<li>Once the tool has finished, click ‘Close’.
<li>In Windows File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''sw02_001.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select 'Add Layers' to open all vectors within '''sw02_001.gpkg'''. By default, all items in the available list should have been selected.
<li>In the QGIS Layers Panel, move '''sw02_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project.
</ol>
 
{{Video|name=Animation_TS2_SWMM_Inputs_01e.mp4|width=1236}}

 

== GIS Data Entry ==

A GeoPackage called '''Urban_Development.gpkg''' is provided in the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder. It contains three SWMM input layers (and five other geometry input layers to be used later in the module):
:*'''Pipes''': defines the underground pipe network location, type and geometry.
:*'''Junctions''': defines the pipe network inlets.
:*'''Outfalls''': defines the pipe network outlet.

 
To populate the GeoPackage database created in the previous section:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder. Drag and drop the '''Urban_Development.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select '''Pipes''', '''Junctions''' and '''Outfalls''' (hold Ctrl to select multiple). Click 'Add Layers'.
<li>In the QGIS Layers Panel, right click on the '''Pipes''' layer and select 'Zoom to Layer(s)'.
<li>Use the 'Select Features' tool to highlight all items included in '''Pipes'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
<li>In the QGIS Layers Panel, select (left click) the '''Links--Conduits''' layer.
<li>Make the '''Links--Conduits''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle the editing off to save the edits.
 
{{Video|name=Animation_TS2_SWMM_Inputs_02d.mp4|width=1236}} 
<li>Similarly, copy the objects from '''Junctions''' into '''Nodes--Junctions'''. Junctions are considered inlets, and should be defined at the upstream end of isolated culverts and all upstream ends of pipes within a network.
<li>Also copy the objects from '''Outfalls''' into '''Nodes--Outfalls'''. Outfalls are treated as outlets, and are required at the downstream end of isolated culverts and the most downstream end of a pipe network.
<li>Toggle off editing to save the edits.
<li>Remove '''Urban_Development.gpkg'''.
 
{{Video|name=Animation_TS2_SWMM_Inputs_03c.mp4|width=1236}} 
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.
 
{{Video|name=Animation_TS2_SWMM_Inputs_04c.mp4|width=1236}} 
</ol>

== GIS Data Updates ==
The provided GIS data requires numerous updates, prior to our model simulation. We have built these updates into this tutorial to demonstrate some of the available TUFLOW SWMM model built processing tools.

The following updates are being made to objects and layers within '''sw02_001.gpkg'''.
===Update SWMM Inlet Usage Layer Details===
An Inlet Usage Layer defines the physical location of inlets to the pipe network. It also defines some of the site specific geometry, such as inlet type, street cross-section reference, surface inlet elevation, placement type (on-sag and on-grade). To reduce data entry requirements for this tutorial, a complete Inlet Usage Layer has been provided, '''swmm_iu_TS02_001'''. It includes a variety of on-sag and on-grade inlets. On-sag inlets are used in locations where the inlet is located in an area of minimal longtudial slope. In this situation ponded surface water enters the pipe network. On-grade inlets are used where bypass flow is expected due to the inlet location being on a slope. For on-grade inlets, TUFLOW SWMM captures a percentage of the “approach flow” based on several factors including the total 2D approach flow, velocity and depth. 

<ol>
<li>Navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder and save a copy of '''swmm_iu_TS02_001''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\model\swmm''' folder. 
<li>Navigate to the '''TUFLOW\model\swmm''' folder. Drag and drop '''swmm_iu_TS02_001''' into the QGIS workspace.
</ol>

When you progress from this tutorial to project modeling, you will need to create an Inlet Usage Layer yourself. The template file for this is available from '''model\gis\empty\swmm_iu_empty.gpkg'''. The file is created during the initial 'Write Empty' step of the model build process (refer to [[Tutorial_M01#Project_Initialisation | TUFLOW Tutorial Model 1]]). A summary of the attributes within the Inlet Usage Layer is documented in [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-TUFLOW-1.html#tab:tab-SWMMinletusage TUFLOW 2023-03-AD Release Notes (Table 4.1)]

The 'Inlet' Attribute within '''swmm_iu_TS02_001''' is an ID reference to inlet geometry and associated information listed within '''sw02_001.gpkg''' >> '''Inlets--Inlets'''. A single inlet type, 'Combo1', was referenced in '''swmm_iu_TS02_001''' (the provided Inlet Usage Layer). In recognition of this, we need to create the entry for 'Combo1' in the '''Inlets--Inlets''' layer.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Inlets--Inlets''' and toggle on editing.
<li>Right click '''Inlets--Inlets''' and select 'Open Attribute Table'.
<li>Click 'Add Feature'. Enter the following attributes (leave all other fields as ''NULL''):
:*Name: Combo1
:*Type: COMBINATION
:*Grate_Length: 0.6
:*Grate_Width: 0.3
:*Grate_Type: P_BAR-50
:*Curb_Length: 0.9
:*Curb_Height: 0.15
:*Curb_Throat: VERTICAL
For a summary of the attributes associated with the '''Inlets--Inlets''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Inlets TUFLOW 2023-03-AD Release Notes (Table A.16)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydraulics_Addendum-20220210mas2wr.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics Addendum) ]

<li>Turn off editing to save the edits.
 
{{Video|name=Animation_TS2_SWMM_Inputs_05c.mp4|width=1236}}
 
</ol>

===Update Streets Details===

Street cross-section information is needed for SWMM on-grade inlet flow calculations. A single street cross-section type named 'Xsec1', is referenced in '''swmm_iu_TS02_001''' (the Inlet Usage Layer) using the 'StreetXSEC' field. 
We will now define this street cross-section type and its attributes.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Streets''' and toggle on editing.
<li>Right click '''Links--Streets''' and select 'Open Attribute Table'.
<li>Click 'Add Feature'. Enter the following attributes:
:*Name: Xsec1
:*Tcrown: 7
:*Hcurb: 0.2
:*Sx: 4
:*nRoad: 0.014
:*a: 0
:*W: 0
:*Sides: 1
:*Tback: 5
:*Sback: 2
:*nBack: 0.016
For a summary of the attributes associated with the '''Links--Streets''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Streets TUFLOW 2023-03-AD Release Notes (Table A.24)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)].

<li>Turn off editing to save the edits.
 
{{Video|name=Animation_TS2_SWMM_Inputs_06c.mp4|width=1236}}
 
</ol>

===Update Conduit Details===
====Node Details====

The 'From Node' and 'To Node' attribute information in '''Links---Conduits''' is necessary to build the 1D SWMM network. It defines the link/node connections. The information we will be adding to '''Links--Conduits''' is extracted from '''Nodes--Junctions''' and '''Nodes--Outfalls''' automatically using the '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool from the Processing Toolbox.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]]. This allows the editing of an existing layer, instead of the creation of a new layer.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]'. This opens the dialog shown below.
<li>Tick on the SWMM Node Layers: '''sw02_001 >> Nodes--Junctions''' and '''sw02_001 >> Nodes--Outfalls'''.
<li>Select 'Modify All Features'.
<li>Once the tool has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Links--Conduits''' to verify the data processing has been completed correctly. The 'From Node' and 'To Node' attribute information is now configured correctly. 
For a broader understanding of the other attributes associated with the '''Links--Conduits''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Conduits TUFLOW 2023-03-AD Release Notes (Table A.19)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)]. 
'''Tip:''' In a future modeling project, if you wish to only update selected objects, rather than the entire '''Links--Conduits''' dataset, select the target objects first using the 'Select Features by Area' tool. The '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool will provide an option to 'Modify Selected Features', instead of 'Modify All Features.'
 
{{Video|name=Animation_TS2_SWMM_Inputs_07c.mp4|width=1236}}
 
</ol>

====Update Losses====

Update the loss attributes in the '''Links--Conduits''' layer. These values will be entered automatically using the '[[QGIS_SWMM_Conduits_Assign_Losses |Conduits - Assign losses]]' tool from the Processing Toolbox.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox, ensure the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]] is still selected.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Conduits_Assign_Losses |Conduits - Assign losses]]'. This opens the dialog shown below.
:*Input inlet usage layers: '''swmm_iu_TS02_001'''.
:*Culvert opening - Entrance loss: 0.5
:*Culvert or pipe network outlet - Exit loss: 1.0
:*Pipe Network (manholes and pit inlets):
:::*Entrance loss: 0.2
:::*Exit loss: 0.4
<li>Select 'Modify All Features'.
<li>After the tool processing has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Links--Conduits''' to verify the data processing has been completed correctly. The 'losses_Kentry', 'losses_Kexit' and 'losses_Kavg' attribute information is now configured.
 
{{Video|name=Animation_TS2_SWMM_Inputs_08d.mp4|width=1236}}
 
</ol>

===1D/2D Linking===
The 1D SWMM / 2D TUFLOW linkage locations to connect the pipe network inlets to the surface have been already automatically defined in the SWMM Inlet Usage Layer, '''swmm_iu_TS02_001''', using the 'Conn1D_2D' attribute.
 
<ol>
 
[[File:swmm_iu_TS02_001_attribute_table_Conn1D2D.png]]
 
</ol>
 
To complete the pipe network, 1D/2D linkage is needed at the outlet of the pipe network. The '[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections |BC - Create channel endpoint 1D/2D connections]]' tool will be used to automate this process.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits'''.
<li>Use the 'Select Features' tool to select the most downstream object in '''Links--Conduits'''.
<li>In the Processing Toolbox, go to TUFLOW >> SWMM and select '[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections |BC - Create channel endpoint 1D/2D connections]]'. This opens the dialog shown below.
:*Input Conduits Layer: '''Links--Conduits'''
:*Tick on 'Selected features only'
:*Create connections at: 'Downstream end'
:*Offset Distance: 2
:*Length of BC lines: 10
:*Tick on 'Set 2D cell elevation to 1D culvert invert at 1D/2D connection cells if needed'.
:*Output Layer:
<ol>
::<li>Click the ... and select 'Save to GeoPackage'.
::<li>Navigate to the '''TUFLOW\model\gis''' folder and select '''TS02_001.gpkg'''. Click 'Save'.
::<li>A dialog will open. In the layer name box, write '''2d_bc_SWMM_Pipe_Network_Connections_001_L'''.
::<li>Click 'OK'.
</ol>
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>The '''2d_bc_SWMM_Pipe_Network_Connections_001_L''' appears in the QGIS Layers Panel.
<li>Click the 'Apply TUFLOW Styles to Current Layer' symbol from the TUFLOW Plugin toolbar to style the '''2d_bc_SWMM_Pipe_Network_Connections_001_L''' layer.
 
{{Video|name=Animation_TS2_SWMM_Inputs_09e.mp4|width=1236}}
 
</ol>

===Update SWMM Junction Details===

<ol>
<li>In the QGIS Layers Panel, select (left click) '''Nodes--Junctions''' and toggle on editing.
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool. This allows the editing of an existing layer, instead of the creation of a new layer.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Junctions_Set_Attributes |Junctions - Set attributes ]]' processing tool. This opens the dialog shown below.
:*Input Inlet Usage Layers: '''swmm_iu_TS02_001'''
:*Input BC Connection Layers: '''2d_bc_SWMM_Pipe_Network_Connections_001_L'''
:*General Options:
:::*Maximum Depth Option (Ymax): 'Set to 0.0'.
:::*Nodes receiving subcatchment flows option (if connected to 2D): 'Based on options selected below'.
:*Nodes connected to 2D without Inlets:
:::*None - leave defaults
:*Nodes connected to 2D with Inlets:
:::*Maximum depth (Ymax) option: 'Use global option'
:::*Ysur: 0 (ignored because ponding > 0.0)
:::*Area of Ponding (Apond): 5
:*Nodes without 2D Connection:
:::*Surcharge Depth: 50
:::*Area of Ponding (Apond): 0.0

<li>Select 'Modify All Features'.
<li>Once the tool has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Nodes--Junctions''' to verify the data processing has been completed correctly. 
For a summary of the attributes associated with the '''Nodes--Junctions''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Junctions TUFLOW 2023-03-AD Release Notes (Table A.30)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)].
 
{{Video|name=Animation_TS2_SWMM_Inputs_10d.mp4|width=1236}}
 
</ol>

==SWMM Options==
The model we are building will use two SWMM INP files.
*'''sw01_001.inp''' was already created in TUFLOW SWMM Tutorial Module 1. It contained details defining the three culverts under the roads in the model. It also contained the associated 1D SWMM / 2D TUFLOW connection layer objects and the '''Project--Options''' necessary to execute the SWMM simulation. '''sw01_001.inp''' has been included in the base model we are using for Module 2. No changes will be made to it.
* We will create a new INP file for the SWMM pipe network inputs (covered in the next section). As SWMM Options are already included in '''sw01_001.inp''', they are not needed in this second (new) INP file. As such, no new SWMM Option commands are necessary for this tutorial.
'''Note:''' If '''Project--Options''' are included in multiple GeoPackage/INP files, the entry that is referenced lowest in the TUFLOW SWMM Control File (TSCF) will be used.
 

== Export SWMM INP File ==
We will now create a new INP file for the SWMM pipe network inputs. To do this, we need to convert '''sw02_001.gpkg''' into a SWMM INP file.

<ol>
<li>Right click on the '''Links--Conduits''' layer in the '''sw02_001''' group (or any other SWMM layer in the same GeoPackage) and select 'TUFLOW' > 'SWMM - Export inp file'.
<li>This will open the '[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]' processing tool, prepopulated with the filename of the layer's GeoPackage. 
'''Note:''' This tool can also be activated from the Processing Toolbox.
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>This tool will save the SWMM inp file in the same folder location and with the same name as the GeoPackage input file. In this case, it will save '''sw02_001.inp''' to the '''TUFLOW\model\swmm''' folder.
 
{{Video|name=Animation_TS2_SWMM_Inputs_11e.mp4|width=1236}}
 
</ol>

== TUFLOW Boundary Updates ==
We will be using TUFLOW's 2D direct rainfall (also known as rain on grid) functionality for the catchment inflow boundary condition approach to demonstrate flows into the pipe network inlets. There is a wide range of direct rainfall options built into TUFLOW, including:
*'''Globally uniform rainfall:''' This method applies temporally varied rainfall uniformly (spatially) over the entire model.
*'''Spatially varying rainfall:''' This method applies temporally varied rainfall with spatial variation defined using polygon delineation, grid raster files or inbuilt TUFLOW TIN triangulation routines. 
 
The focus of this tutorial is not to demonstrate the available direct rainfall options. As such, we will be using the simplest approach, globally uniform rainfall. It does not require any GIS updates to implement the boundary condition change. Updates will be limited to the Boundary Condition Database reference and Control File syntax updates. Both are addressed in the next section. If you are interested in learning about the available direct rainfall options, please refer to [[Tutorial_M06 |TUFLOW Tutorial Module 6]].
 
<ol>
<li>Copy '''rainfall_stations.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\bc_dbase''' folder.
<li>Copy '''bc_dbase_TS02_001.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\bc_dbase''' folder.
</ol>
 
It is common to use depth varying manning's roughness when using direct rainfall. A Materials File using depth varying inputs has been provided.
<ol>
<li>Copy '''materials_TS02_001.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\model''' folder.
 
{{Video|name=Animation_TS2_TUFLOW_Boundary_01a.mp4|width=1235}}
 
</ol>

== TUFLOW Geometry Update ==
We will update TUFLOW's 2D elevation and landuse to represent changes associated with the urban development. The updates will be consolidated within '''TS02_001.gpkg'''.

Copy the following TUFLOW geometry inputs to GeoPackage '''TS02_001.gpkg''':
<ol>
<li>Right click anywhere in the QGIS Toolbar Panel and tick on 'Browser Panel' from the 'Panels' options.
<li>Within the QGIS Browser Panel, there is a dropdown directory, 'Project Home'. This directory is a shortcut to the location where the QGIS workspace is saved. In this case, it is a shortcut to the '''TUFLOW_SWMM_Module_02''' folder.
<li>In the 'Project Home' directory, navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder.
<li>Drag the following layers (hold Ctrl to select multiple) from the '''Urban_Development.gpkg''' and drop them into the '''TS02_001.gpkg''' contained within the '''TUFLOW_SWMM_Module_02\TUFLOW\model\gis''' folder:
:*'''2d_mat_TS02_Dev_Buildings_001_R'''
:*'''2d_mat_TS02_Dev_Lots_001_R'''
:*'''2d_ztin_TS02_Dev_001_L'''
:*'''2d_ztin_TS02_Dev_001_P'''
:*'''2d_ztin_TS02_Dev_001_R'''
</ol>
'''Note:''' The focus of this tutorial is not to demonstrate 2D geometry updates. If you are interested in learning about the above '''2d_ztin''' and '''2d_mat''' changes, please refer to [[Tutorial_M02 |TUFLOW Tutorial Module 2]].
 
<ol>
{{Video|name=Animation_TS2_TUFLOW_Geometry_01f.mp4|width=1236}}
 
</ol>

= Simulation Control Files =
To avoid the potential risk of overwriting existing control files accidentally, we will start by saving new control files where we will be making subsequent syntax updates during the following steps.
<ol>
<li>Open '''TS01_5m_001.tcf''' in a Text Editor (Notepad++ is used here). Save the file as '''TS02_5m_001.tcf''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder.
<li>Using the 'Open File' function in Notepad++:
:*Open '''M02_001.tgc,''' and save the file as '''TS02_001.tgc''' in the '''TUFLOW\model''' folder.
:*Open '''TS01_001.tbc,''' and save the file as '''TS02_001.tbc''' in the '''TUFLOW\model''' folder.
:*Open '''TS01_001.tscf,''' and save the file as '''TS02_001.tscf''' in the '''TUFLOW\model''' folder.
 
</ol>

===TUFLOW Control File (TCF)===
<ol>
<li>Open '''TS02_001.tcf''' and make the following reference updates: 
<tt>Spatial Database </tt> <tt>== </tt> <tt>..\model\gis\TS02_001.gpkg</tt> <tt> ! Specify the location of the GeoPackage Spatial Database</tt> 
<tt>Geometry Control File</tt> <tt>== </tt> <tt>..\model\TS02_001.tgc</tt> <tt> ! Reference the TUFLOW Geometry Control File</tt> 
<tt>BC Control File </tt> <tt>== </tt> <tt>..\model\TS02_001.tbc</tt> <tt> ! Reference the TUFLOW Boundary Condition Control File</tt> 
<tt>BC Database </tt> <tt>== </tt> <tt>..\bc_dbase\bc_dbase_TS02_001.csv</tt> <tt> ! Reference the Boundary Condition Database</tt> 
<tt>Read Materials File </tt> <tt>== </tt> <tt>..\model\materials_TS02_001.csv</tt> <tt> ! Reference the Materials Definition File</tt> 
<tt>SWMM Control File </tt> <tt>== </tt> <tt> ..\model\TS02_001.tscf </tt> <tt> ! Reference the SWMM (1D) Control File</tt> 
<li>Add the following line in the '<tt>Output Settings</tt>' section: 
<tt>Map Cutoff Depth </tt> <tt>== </tt> <tt> 0.05 </tt> <tt>! Sets map cutoff depth of 0.05 meters</tt> 
<li> Save the TCF.
 
{{Video|name=Animation_TS2_Sim_Control_01d.mp4|width=1235}}
 
</ol>

=== TUFLOW Geometry Control File (TGC) ===
<ol>
<li>Open '''TS02_001.tgc'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li>Add the following command to the the '<tt>Topography</tt>' section below the below the existing '<tt>Read GIS Z Shape</tt>' command: 
<tt>Create TIN Zpts </tt> <tt>== </tt> <tt>2d_ztin_TS02_Dev_001_R | 2d_ztin_TS02_Dev_001_L | 2d_ztin_TS02_Dev_001_P</tt> <tt> ! Urban Development Topography TIN</tt> 
<li>Add the following lines in the '<tt>Materials</tt>' section, below the existing material commands : 
<tt>Read GIS Mat </tt> <tt>== </tt> <tt>2d_mat_TS02_Dev_Lots_001_R</tt><tt> ! Urban Development Landuse 1</tt> 
<tt>Read GIS Mat </tt> <tt>== </tt> <tt>2d_mat_TS02_Dev_Buildings_001_R</tt> <tt> ! Urban Development Landuse 2</tt> 
<li>Save the TGC.
 
{{Video|name=Animation_TS2_Sim_Control_02b.mp4|width=1235}}
 
</ol>

=== TUFLOW Boundary Control File (TBC) ===
<ol>
<li>Open '''TS02_001.tbc'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li> Comment out the 'Read GIS SA' command by placing '!' before the command: 
<tt>! Read GIS SA == 2d_sa_M01_001_R</tt> 
<li>Add the following additional command lines: 
<tt>Global Rainfall BC </tt> <tt>== </tt> <tt>RF_FC04</tt><tt> ! Reads in global rainfall</tt> 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>2d_bc_SWMM_Pipe_Network_Connections_001_L</tt> <tt> ! Links the 1D Pipe Network Outlets to the 2D domain</tt> 
<li>Save the TBC.
 
{{Video|name=Animation_TS2_Sim_Control_03d.mp4|width=1235}}
 
</ol>

=== TUFLOW SWMM Control File (TSCF) ===
<ol>
<li>Open '''TS02_001.tscf'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li>Add the following command lines after '<tt>Read SWMM </tt> <tt>== </tt> <tt>swmm\sw01_001.inp</tt>': 
<tt>Read SWMM </tt> <tt>== </tt> <tt>swmm\sw02_001.inp</tt> <tt> ! 1D SWMM Pipe Network Input File</tt> 
<tt>Read GIS SWMM Inlet Usage </tt> <tt>== </tt> <tt>swmm\swmm_iu_TS02_001.gpkg >> swmm_iu_TS02_001</tt> <tt> ! 1D SWMM Pipe Network Inlet Usage Layer</tt> 
<li>Save the TSCF.
 
{{Video|name=Animation_TS2_Sim_Control_04b.mp4|width=1235}}
 
</ol>

= Running the Simulation =
<ol>
<li>Save a copy of '''_run_TS01_HPC.bat''' as '''_run_TS02_HPC.bat''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder.
<li>Update the batch file to reference the '''TS02_5m_001.tcf''' : 
<tt>'''set'''</tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2025.2.1\TUFLOW_iSP_w64.exe"</tt> 
<tt>'''set'''</tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait</tt> <tt> %exe%</tt> <tt> -b</tt> 
<tt>%run% </tt> <tt>TS02_5m_001.tcf </tt>

<li>Save the batch file and double click it in Windows File Explorer to run the simulation.
<li>Did your TUFLOW SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]]. 
 
{{Video|name=Animation_TS2_Run_Sim_01c.mp4|width=1236}} 
</ol>

= Check Files and Results Output=
Complete the steps outlined in following links to review check files and simulation results from the TUFLOW SWMM model simulation:

[[TUFLOW_SWMM_Tutorial_M02_Check_QGIS | TUFLOW SWMM Tutorial 02 Check Files]] 
[[TUFLOW_SWMM_Tutorial_M02_Results_QGIS | TUFLOW SWMM Tutorial 02 Results]] 

= Conclusion =
* 1D EPA SWMM pipe network features and 2D direct rainfall (rain on grid) hydrology have been added to the tutorial model.
* Check files were used to review the 1D SWMM pipe network model features.
* Simulation results in the 1D SWMM pipe network were viewed in time series and long section plot format.
* For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com].
 

=Other TUFLOW SWMM Tutorials=
*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]] - How to convert an XPSWMM model to TUFLOW SWMM.

 
{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Back to TUFLOW SWMM Tutorial Introduction Main Page]]
}}

TUFLOW SWMM Tutorial M01

2025-11-25T01:24:49Z

Chris Huxley: /* Running the Simulation */

= Introduction =
In this module, three culverts are added to represent flow through three separate road embankments. EPA SWMM is used as the solution scheme for the 1D culvert flow calculations, dynamically linked with the TUFLOW HPC 2D solution scheme. 

TUFLOW SWMM Tutorial Module 1 builds from the model created in [[Tutorial_M02 |TUFLOW Tutorial Module 2]] (in the TUFLOW Only tutorial dataset). The completed TUFLOW Module 2 model is provided in the '''''TUFLOW_SWMM_Module_01\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW, we recommend first completing Module 1 and 2 of the [[Tutorial_Introduction | "TUFLOW Only" Tutorials]] to establish an understanding of 2D modeling, before progressing to learning how to link 1D EPA SWMM to 2D TUFLOW. 

= Project Initialization =
Three steps are required for the project initialization:
<ol>
<li> Setting the QGIS Project Coordinate Reference System (CRS).
<li> Configuring the QGIS TUFLOW Plugin.
<li> Establishing the new TUFLOW model GeoPackage file that will include new GIS inputs associated with this model update.
</ol>

== QGIS ==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.11 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see [https://wiki.tuflow.com/TUFLOW_QGIS_Plugin Installation of TUFLOW Plugin]. 
Firstly, define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<ol>
<li>Open QGIS.
<li>Go to Project > Properties…
<li>In the CRS tab, type ‘WGS 84 / UTM Zone 60S’.
<li>Select the matching projection in the 'Predefined Coordinate Reference Systems' section.
<li>Click ‘Apply’ and ‘OK’.
<li>Ensure that the projection is set correctly by viewing the bottom right hand corner of the workspace. It should read ‘EPSG:32760’.
</ol>
 
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}} 

==TUFLOW Model==
===Load and Style TUFLOW Model Files===
Load and Style the GIS layers from the TUFLOW model:
<ol>
<li>Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
 
[[File: Tuflow_plugin_load_tcf_layers.png]] 
 
<li>Navigate to the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder and select '''M02_5m_001.tcf'''.
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally
<li>Click ‘Open’ and ‘OK’.
</ol>
 

Style the TUFLOW layers however you desire. Common steps to do this are:
<ol>
<li>Click on the ‘Apply TUFLOW Styles to Open Layers’ symbol from the TUFLOW Plugin toolbar.
 
[[File:tuflow_plugin_styles_open_layers.png]] 
 
<li>Change the symbology of the DEM:
*Right click on the '''DEM''' file in the QGIS Layers Panel and select 'Properties'.
*From the Symbology tab, under 'Band Rendering' select the following options:
:*Render type: Singleband pseudocolor
:*Color ramp: Spectral
:*Color ramp: Invert Color Ramp
:*Mode: Equal Interval
*From the Transparency tab, set the Global Opacity to 75%.
*Click 'Apply' and 'OK'.
 
{{Video|name=Animation_TS1_Initialization_03d.mp4|width=1235}}
 

<li>Create a hillshade of the DEM:
*Right click on the '''DEM''' file in the QGIS Layers Panel and select 'Duplicate Layer'.
*Right click on the '''DEM_copy''' and select 'Rename Layer'. Rename the layer to '''DEM_Hillshade'''.
*Right click on the '''DEM_Hillshade''' and select 'Properties'.
*From the Symbology tab, under 'Band Rendering' select the following options:
:*Render type: Hillshade
:*Z Factor: 3
*Click 'Apply' and 'OK'.
 
{{Video|name=Animation_TS1_Initialization_04b.mp4|width=1235}}
 

</ol>

===TUFLOW Plugin===
Next we need to configure the QGIS TUFLOW Plugin settings to link with the project folder where we will build our model: 
<ol>
<li>Open the 'Configure TUFLOW Project' tool by selecting Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.
<li>Set the CRS (Coordinate Reference System) by selecting one of the vector layers associated with the opened model using the drop menu list. For example, ''2d_bc_M01_001_L''.
<li>To set the location of the TUFLOW folder, click 'Browse...' and navigate to the '''TUFLOW_SWMM_Module_01''' folder. Click 'Select Folder'.
<li>To set the location of the TUFLOW single precision executable file, click 'Browse...' and navigate to the '''exe\2023-03-AF''' folder. Select '''TUFLOW_iSP_w64.exe''' and click 'Open'.
<li>Select 'GPKG' as the GIS Format.
<li>Select 'TUFLOW Classic / HPC' as the TUFLOW Engine.
<li>Tick on 'Save Default Settings Globally'.
<li>Click 'OK'. 
 
[[File: TS1_Configure_Project_01a.png]] 
</ol>
 

=== Increment Model GeoPackage File ===
We will now save a copy of '''M02_001.gpkg''' with a new name, '''TS01_001.gpkg'''. This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''2d_bc_M01_001_L'''.
<li>Click on the 'Increment Selected Layer' symbol from the TUFLOW Plugin toolbar. This opens the dialog shown below.
 
[[File:tuflow_plugin_increment_layer.png]] 
 
:*Source Layer: Automatically set to the selected layer, '''2d_bc_M01_001_L'''.
:*Output Database: Click 'Browse...'. This will automatically open to the '''TUFLOW\model\gis''' folder. Set the new output database name to '''TS01_001.gpkg''' and click 'Save'.
:*Output Layer Name: This will automatically increment to '''2d_bc_M01_00''2''_L'''. Change the name back to '''2d_bc_M01_00''1''_L'''.
:*Delete the pre-filled 'Incremented Layer' entry in the table. We do not wish to modify the version number associated with the 2d_bc file. This current exercise will not change the version number of any of the GIS layer inputs, it is simply establishing a copy of the existing GeoPackage where future edits will be saved to.
:*Select 'Remove Source Layer from Workspace'.
:*Select 'Increment Layer and Preserve Database'.
<li>Click 'OK'.
<li>The GeoPackage database, '''TS01_001.gpkg''' will now be in the '''TUFLOW_SWMM_Module_01\TUFLOW\model\gis''' folder. 
 
{{Video|name=Animation_TS1_Initialization_05c.mp4|width=1235}}
 
</ol>

===Save QGIS Project Workspace===
<ol>
<li>Go to Project > Save As.
<li>Navigate to the '''TUFLOW_SWMM_Module_01''' folder and type '''SWMM_M01''' as the filename with the extension .qgz.
</ol>
 

= GIS Inputs =
==Create SWMM GeoPackage Spatial Database==
Create a new folder in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder called '''swmm'''. This is the location where all SWMM inputs will be saved. 
 
In QGIS, create the SWMM GeoPackage Database:
<ol>
<li>Go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_GeoPackage_Create |GeoPackage - Create]]'. This opens the dialog shown below.
:*To set the ‘CRS for GeoPackage’: Click the drop down menu and select ‘Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S’.
:*To set the ‘Initial SWMM Sections’: Click …, and tick on (if not already ticked):
::*'''Project--Title''', '''Project--Options''', '''Project --Report.'''
::*'''Nodes--Junctions''', '''Nodes--Outfalls.''', '''Nodes--Storage.'''
::*'''Links--Conduits, Links--Streets'''.
:*To define the ‘GPKG filename to create’: Click …, select ‘Save to File’. Navigate to the '''TUFLOW\model\swmm''' folder and save the GeoPackage database as '''sw01_001.gpkg'''.

<li>Click ‘Run’.
<li>Once the tool has finished, click ‘Close’.
<li>In Windows File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''sw01_001.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select 'Add Layers' to open all vectors within '''sw01_001.gpkg'''. By default, all items in the available list should have been selected.
<li>In the QGIS Layers Panel, move '''sw01_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project.
</ol>
 
{{Video|name=Animation_TS1_SWMM_Inputs_01g.mp4|width=1236}}
 
 

== GIS Data Entry ==

A GeoPackage database called '''SWMM_Culverts.gpkg''' is provided in the '''TUFLOW_SWMM_Module_01\Tutorial_Data''' folder. It contains three layers:
:*'''Conduits:''' defines the culvert location, type and geometry.
:*'''Outfalls:''' defines the downstream culvert inverts.
:*'''Storage_nodes:''' defines the upstream culvert inverts.
 
To populate the GeoPackage database created in the previous section:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_01\Tutorial_Data''' folder. Drag and drop the '''SWMM_Culverts.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group'. By default, all items in the GeoPackage database will be selected. Click 'Add Layers'.
<li>In the QGIS Layers Panel, right click on the '''SWMM_Culverts >> Conduits''' layer and select 'Zoom to Layer(s)'.
<li>Use the 'Select Features' tool to highlight all items included in '''Conduits'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
<li>In the QGIS Layers Panel, select (left click) the '''sw01_001.gpkg >> Links--Conduits''' layer.
<li>Make the '''Links--Conduits''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle the editing off to save the edits. 
 
{{Video|name=Animation_TS1_SWMM_Inputs_02f.mp4|width=1236}}
 
<li>Similarly, copy the objects from '''Storage_nodes''' into '''Nodes--Storage'''. Junctions and storage nodes are allowed at the upstream end of culverts. Storage nodes are preferred for culverts receiving 2D flows not through a storm drain inlet.
<li>Also copy the objects from '''Outfalls''' into '''Nodes--Outfalls'''. Outfalls are treated as outlets, and are required at the downstream end of culverts.
<li> Toggle off editing and save the edits.
<li>Remove '''SWMM_Culverts.gpkg'''.
 
{{Video|name=Animation_TS1_SWMM_Inputs_03f.mp4|width=1236}}
 
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.
 
{{Video|name=Animation_TS1_SWMM_Inputs_04f.mp4|width=1236}}
</ol>
 

== GIS Data Updates ==
The provided GIS data requires numerous updates before proceeding to a model simulation. We have intentionally built these updates into this tutorial to demonstrate some of the available TUFLOW SWMM model build processing tools. The following updates are being made to objects and layers within '''sw01_001.gpkg'''.
===Update Conduit Details===
==== Node Details ====
Stage 1 of building the 1D SWMM network involves updating the 'From Node' and 'To Node' attribute information in '''Links--Conduits'''. This information defines the Link/Node connections. 
The information we will be adding to '''Links--Conduits''' is extracted from '''Nodes--Storage''' and '''Nodes--Outfalls''' automatically using the '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool from the Processing Toolbox.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]]. This allows the editing of an existing layer, instead of the creation of a new layer.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]'. This opens the dialog shown below.
:*SWMM Node Layers: Tick on '''sw01_001 >> Nodes--Storage''' and '''sw01_001 >> Nodes--Outfalls'''. Click 'OK'.
<li>Select 'Modify All Features'.
<li>Once the tool has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Links--Conduits''' to verify the data processing has been completed correctly. The 'From Node' and 'To Node' attribute information is now configured correctly. For a broader understanding of the other attributes associated with the '''Links--Conduits''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Conduits TUFLOW 2023-03-AD Release Notes (Table A.19)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)]. 
 
'''Tip 1:''' If you wish to only update a selection of objects, instead of selecting the entire '''Links--Conduits''' dataset, select the target objects first using the 'Select Features' tool. The '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool will provide an option to 'Modify Selected Features', instead of 'Modify All Features.' 
'''Tip 2:''' Unique Node ID's are required for the SWMM network to function error free. If you are following this workflow for a project model build, please ensure the '''Nodes--Storage''' and '''Nodes--Outfalls''' object ID information is unique. If duplicate ID values are assigned to multiple objects, consider using the '[[QGIS_SWMM_Integrity_Make_Object_Names_Unique |Integrity - Make object names unique ]]' TUFLOW SWMM processing tool to ensure all ID values are unique before using '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]'.
 
{{Video|name=Animation_TS1_SWMM_Inputs_05g.mp4|width=1236}}
 

</ol>

====Update Losses====
Stage 2 involves updating the loss attributes in the '''Links--Conduits''' layer. In this example, default loss values are used and will be entered manually. These loss values can be adjusted in your project models to reflect site specific information if desired.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>Right click '''Links--Conduits''' and select 'Open Attribute Table'.
<li>For each conduit, update the following fields:
:*losses_Kentry: 0.5
:*losses_Kexit: 1.0
:*losses_Kavg: 0.0
The video below demonstrates how to do this one entry at a time, or via the bulk attribute update options in QGIS.
<li>Turn off editing to save the edits.
 
{{Video|name=Animation_TS1_SWMM_Inputs_06f.mp4|width=1236}}
</ol>
 

Since all the 1D SWMM inputs in this model are embankment culverts that all use the same loss parameters, it's not necessary to specify different loss attributes. The [[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] will demonstrate an urban pipe network added to the model, with different loss attributes required for the road culverts and underground storm pipe network links. To simplify this step, Module 2 uses the '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' processing tool.
 
 

=== Create 1D/2D Connections===
The following instructions introduce a new tool that automates the creation of 1D/2D connections. Due to the limitations of SWMM boundary conditions, HX lines are required for the upstream end of the culvert (rather than SX), and SX connections are used at the downstream end of the culvert. 
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits'''.
<li>In the Processing Toolbox, go to TUFLOW >> SWMM and select '[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections |BC - Create channel endpoint 1D/2D connections]]'. This opens the dialog shown below. 
'''Note:''' Ensure the 'Edit Features In-Place' tool has been turned off.
:*Input Conduits Layer: '''Links--Conduits'''
:*Create connections at: 'Both ends'.
:*Offset Distance: 2
:*Length of BC lines: 10
:*Tick on 'Set 2D cell elevation to 1D culvert invert at 1D/2D connection cells if needed'.
:*Output Layer:
<ol>
::<li>Click the ... and select 'Save to GeoPackage'.
::<li>Navigate to the '''TUFLOW\model\gis''' folder and select '''TS01_001.gpkg'''. Click Save.
::<li>A dialog will open. In the Layer name field, write '''2d_bc_SWMM_Culvert_Connections_001_L'''.
::<li>Click 'OK'.
</ol>
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>The '''2d_bc_SWMM_Culvert_Connections_001_L''' appears in the QGIS Layers Panel. Select 'Apply TUFLOW Styles to Current Layer'.
 
{{Video|name=Animation_TS1_SWMM_Inputs_07f.mp4|width=1236}}
</ol>
 
'''Note:''' The positions of the HX and SX connections may not be in the optimum location or extent using the generalized automated tool. As such, it is recommended to check the output from this processing step. In this module, the 1D/2D connections associated with '''2d_bc_SWMM_Culvert_Connections_001_L''' are checked in [[TUFLOW SWMM Tutorial M01 Check QGIS|TUFLOW SWMM Tutorial 01 Check Files]].
 
 

===Update Storage Node Details===
The attributes of the storage nodes need to be modified to represent the storage of the connected HX cells since these cells do not represent storage themselves. The area associated with the storage nodes should be similar to the areas of the HX cells. To set the area, we will use a "PYRAMIDAL" shape with the SWMM side slope (run/rise) (Z) set to 0 to represent vertical walls. As the cell size is 5m, and the length of each polyline is 10m, the length (L) will be set to 10m and the width (W) to 5m. These sizes will be modified later when we change the boundary conditions.

<ol>
<li> In the QGIS Layers Panel, select (left click) '''Nodes--Storage''' and toggle on editing.
<li> Right click '''Nodes--Storage''' and select 'Open Attribute Table'.
<li> Set the following attributes:
:* YMax: 50.0 (this is a value greater than the expected water level. It is required to allow water to fill node)
:* TYPE: 'PYRAMIDAL'
:* L: 10
:* W: 5
:* Z: 0.0
<li> Turn off editing to save the edits.

 
{{Video|name=Animation_TS1_SWMM_Inputs_08g.mp4|width=1236}}
 
</ol>

==SWMM Options==
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Project--Options''' and toggle on editing.
<li>Right click '''Project--Options''' and select 'Open Attribute Table'.
<li>Update the following options:
*'''START_DATE''': 2020-01-01 (Date Format: YYYY-MM-DD)
*'''REPORT_STEP''': 00:01:00
<li>Turn off editing to save the edits.
</ol>

{{Video|name=Animation_TS1_SWMM_Inputs_09f.mp4|width=1236}}
 Save the QGIS Project Workspace:

# Go to Project > Save. This will update '''SWMM_M01.qgz''', which was created previously in the folder '''TUFLOW_SWMM_Module_01'''. 

== Export SWMM INP File ==
SWMM is not able to read the '''sw01_001.gpkg''' database directly, therefore, we need to convert the GeoPackage file to a SWMM INP file format.

<ol>
<li>In the QGIS Layers Panel, right click '''Links--Conduits''' (or any of the SWMM layers) and select 'TUFLOW' > 'SWMM - Export inp file'.
<li>This will open the '[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]' processing tool, prepopulated with the filename of the layer's GeoPackage. 
'''Note:''' This tool can also be activated from the Processing Toolbox.
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>This tool will save the SWMM inp file in the same folder location and with the same name as the GeoPackage input file. In this case, it will save '''sw01_001.inp''' to the '''TUFLOW\model\swmm''' folder.
 
{{Video|name=Animation_TS1_SWMM_Inputs_10e.mp4|width=1236}}
</ol> 

= Simulation Control Files =
The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its configuration information refer to [[NotepadPlusPlus_Tips | Notepad++ Tips]]. 

To differentiate the TUFLOW SWMM tutorials from the TUFLOW/ESTRY tutorials, 'TS' is used as the file prefix in this series of tutorials. To avoid the potential risk of overwriting existing control files accidentally, we will start by saving new control files where we will be making subsequent syntax updates during the following steps. 

Set up the simulation control files:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder and open '''M02_5m_001.tcf''' in a Text Editor (Notepad++ is recommended).
<li>Save the file as '''TS01_5m_001.tcf''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder.
<li>Open '''M01_001.tbc''' using the 'Open File' function in Notepad++. Save the file as '''TS01_001.tbc''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder.
<li>Create a new blank text file called '''TS01_001.tscf''' and save it in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder.
 
{{Video|name=Animation_TS1_Sim_Control_00a.mp4|width=1235}}
 

</ol>

=== TUFLOW Control File (TCF) ===
<ol>
<li>Open '''TS01_5m_001.tcf''' in a Text Editor (Notepad++ is recommended) and make the following reference updates: 
<tt>Spatial Database </tt> <tt>== </tt> <tt> ..\model\gis\TS01_001.gpkg </tt> <tt> ! Specify the location of the GeoPackage Spatial Database</tt> 
<tt>BC Control File </tt> <tt>== </tt> <tt>..\model\TS01_001.tbc</tt> <tt> ! Reference the TUFLOW Boundary Conditions Control File</tt>
<li>Add the following line in the '<tt>Model Inputs</tt>' section: 
<tt>SWMM Control File </tt> <tt>== </tt> <tt> ..\model\TS01_001.tscf </tt> <tt> ! Reference the SWMM (1D) Control File</tt>
<li>Add the following line in the '<tt>Output Settings</tt>' section: 
<tt>NetCDF Output Start Date </tt> <tt>== </tt> <tt>2020-01-01 00:00 </tt> <tt>! Sets the output units for the NetCDF time variable</tt>
<li>Save the TCF.
 
{{Video|name=Animation_TS1_Sim_Control_01c.mp4|width=1235}}
 

</ol>

=== TUFLOW Boundary Control File (TBC) ===
<ol>
<li>From '''TS01_001.tcf''', right click '''TS01_001.tbc''' and select 'Open File'. This opens '''TS01_001.tbc''' into a new tab in Notepad ++.
<li>Add the following command line after '<tt>Read GIS SA </tt> <tt>== </tt> <tt>2d_sa_M01_001_R</tt>': 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>2d_bc_SWMM_Culvert_Connections_001_L</tt> <tt> ! Links 1D SWMM culverts to the 2D TUFLOW domain</tt>
<li>Save the TBC.
 
{{Video|name=Animation_TS1_Sim_Control_02c.mp4|width=1235}}
 

</ol>

=== TUFLOW SWMM Control File (TSCF) ===
A new control file, the TUFLOW SWMM Control File (TSCF), is used to control the SWMM input data. All 1D SWMM files and commands are referenced in the TUFLOW SWMM Control File. 
<ol>
<li>From '''TS01_001.tcf''', right click '''TS01_001.tscf''' and select 'Open File'. This opens '''TS01_001.tscf''' into a new tab in Notepad ++.
<li>Add the following command: 
<tt>Read SWMM </tt> <tt>== </tt> <tt>swmm\sw01_001.inp</tt> <tt> ! 1D SWMM culvert input file</tt> 
<li>Save the TSCF.
 
{{Video|name=Animation_TS1_Sim_Control_03c.mp4|width=1235}}
 

</ol>
 

= Running the Simulation =
<ol>
<li>Save a copy of '''_run_M02_HPC.bat''' as '''_run_TS01_HPC.bat''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder.
<li>Update the batch file to reference the '''TS01_5m_001.tcf''' : 
<tt>'''set'''</tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2025.2.1\TUFLOW_iSP_w64.exe"</tt> 
<tt>'''set'''</tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait</tt> <tt> %exe%</tt> <tt> -b</tt> 
<tt>%run% </tt> <tt>TS01_5m_001.tcf </tt>

<li>Save the batch file and double click it in Windows File Explorer to run the simulation.
 
If the model simulation doesn't run:
<ol>
<li> Check in the screen output or the tlf file near the end for "For SWMM Model Errors see:". This indicates that there is something wrong with the SWMM inputs. Reviewing that file will provide feedback on what is wrong.
<li> Review this link for common [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]] advice.
</ol>
 
{{Video|name=Animation_TS1_Run_Sim_01d.mp4|width=1236}}
 

</ol>

= Check Files and Results Output=
Complete the steps outlined in following links to review check files and simulation results from the TUFLOW SWMM model simulation:

[[TUFLOW_SWMM_Tutorial_M01_Check_QGIS | TUFLOW SWMM Tutorial 01 Check Files]] 
[[TUFLOW_SWMM_Tutorial_M01_Results_QGIS | TUFLOW SWMM Tutorial 01 Results]] 

= Conclusion =
*EPA SWMM culverts were added to convey water through the structures under the three roads in the tutorial model.
*Check files were used to review the inclusion of 1D SWMM culverts to a 2D TUFLOW model.
*Results through the 1D culverts were assessed.
*For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com].
 

=Other TUFLOW SWMM Tutorials=
*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]] - How to convert an XPSWMM model to TUFLOW SWMM. 
 

{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Return to TUFLOW SWMM Tutorial Introduction Main Page]]
}}

NotepadPlusPlus Run TUFLOW

2025-09-26T06:56:46Z

Chris Huxley:

To run TUFLOW from Notepad++ we need to create a new Run option.
<ol>
<li>Select the ''Run >>> Run'' menu items.</li>
<li>In the Run dialogue select the three dots (...), navigate to and select the desired executable. If there are spaces in the name this path should be enclosed in quotes.</li>
<li>In the command line after the TUFLOW path enter "space" (without the quotes) and <tt>"$(FULL_CURRENT_PATH)"</tt> (with the quotes). 
The line should be of the form as bellow where the executable path matches the location on your computer: 
: "C:\TUFLOW\Releases\2020-10-AA\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</li>
[[File:Notepad_RunTUFLOW1.png]]
<li>This tells notepad to pass the currently open file to TUFLOW as the input file.
<li>Select Save and give the item a sensible name e.g. TUFLOW 2020-10-AA-iSP.</li>
<li>To run TUFLOW with the currently open TCF file, simply select the item from the Run menu (or set a shortcut if desired).</li>
[[File:Notepad_RunTUFLOW2.png]]
</ol>
 
'''Troubleshooting''' 
If you receive a "ShellExecute ERROR", further configuration is necessary. 
[[File:shell_execute_error.png|400px]] 
<ol>
<li> In Windows Explorer navigate to the folder location where you have saved the TUFLOW executable.
<li> Double left mouse click the TUFLOW executable. When the following protection pop-up appears, select "More info" 
[[File:Windows_Protection.png|400px]] 
<li> Select "Run anyway". This will open a DOS window and run the TUFLOW executable. 
[[File:Windows_Run_Anyway.png|400px]] 
<li> Close the TUFLOW DOS window.
<li> Restart Notepad++. The TUFLOW Run Option should now function correctly.
</ol>
 
'''TIP:''' The shortcuts can be found and edited in the shortcuts.xml file stored on your machine. The easiest way to find this is to search for it, on my computer it is located here:
C:\Users\username\AppData\Roaming\Notepad++\

This file includes all of the commands for the shortcuts in your "Run" menu. In this case the final entry is the TUFLOW entry.
<code>
<UserDefinedCommands>
<Command name="Launch in Firefox" Ctrl="yes" Alt="yes" Shift="yes" Key="88">firefox "$(FULL_CURRENT_PATH)"</Command>
<Command name="Get php help" Ctrl="no" Alt="yes" Shift="no" Key="112">https://www.php.net/%20$(CURRENT_WORD)</Command>
<Command name="Google Search" Ctrl="no" Alt="yes" Shift="no" Key="113">https://www.google.com/search?q=$(CURRENT_WORD)</Command>
<Command name="Wikipedia Search" Ctrl="no" Alt="yes" Shift="no" Key="114">https://en.wikipedia.org/wiki/Special:Search?search=$(CURRENT_WORD)</Command>
<Command name="Open file" Ctrl="no" Alt="yes" Shift="no" Key="116">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD)</Command>
<Command name="Open file (relative)" Ctrl="no" Alt="yes" Shift="no" Key="32">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_DIRECTORY)/$(CURRENT_WORD)</Command>
<Command name="Open in another instance" Ctrl="no" Alt="yes" Shift="no" Key="117">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD) -nosession -multiInst</Command>
<Command name="Open containing folder" Ctrl="no" Alt="no" Shift="no" Key="0">explorer $(CURRENT_DIRECTORY)</Command>
<Command name="Open current dir cmd" Ctrl="no" Alt="no" Shift="no" Key="0">cmd /K cd $(CURRENT_DIRECTORY)</Command>
<Command name="Send via Outlook" Ctrl="yes" Alt="yes" Shift="yes" Key="79">outlook /a "$(FULL_CURRENT_PATH)"</Command>
<Command name="TUFLOW 2011-09-w64-iSP" Ctrl="no" Alt="no" Shift="no" Key="0">"C:\TUFLOW\Releases\2011-09\w64\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</Command>
</UserDefinedCommands>
</code>
{{Tips Navigation
|uplink=[[NotepadPlusPlus_Tips | Back to Notepad ++ tips.]]
}}

NotepadPlusPlus Run TUFLOW

2025-09-26T06:55:24Z

Chris Huxley:

To run TUFLOW from Notepad++ we need to create a new Run option.
<ol>
<li>Select the ''Run >>> Run'' menu items.</li>
<li>In the Run dialogue select the three dots (...), navigate to and select the desired executable. If there are spaces in the name this path should be enclosed in quotes.</li>
<li>In the command line after the TUFLOW path enter "space" (without the quotes) and <tt>"$(FULL_CURRENT_PATH)"</tt> (with the quotes). 
The line should be of the form as bellow where the executable path matches the location on your computer: 
: "C:\TUFLOW\Releases\2020-10-AA\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</li>
[[File:Notepad_RunTUFLOW1.png]]
<li>This tells notepad to pass the currently open file to TUFLOW as the input file.
<li>Select Save and give the item a sensible name e.g. TUFLOW 2020-10-AA-iSP.</li>
<li>To run TUFLOW with the currently open TCF file, simply select the item from the Run menu (or set a shortcut if desired).</li>
[[File:Notepad_RunTUFLOW2.png]]
</ol>
 
'''Troubleshooting''' 
If you receive a "ShellExecute ERROR" further configuration is necessary. 
[[File:shell_execute_error.png|400px]] 
<ol>
<li> In Windows Exporer navigate to the folder location where you have saved the TUFLOW executable.
<li> Double left mouse click the TUFLOW executable. When the following protection pop-up appears, select "More info" 
[[File:Windows_Protection.png|400px]] 
<li> Select "Run anyway". This will open a DOS window and run the TUFLOW executable. 
[[File:Windows_Run_Anyway.png|400px]] 
<li> Close the TUFLOW DOS window.
<li> Restart Notepad++. The TUFLOW Run Option should now function correctly.
</ol>
 
'''TIP:''' The shortcuts can be found and edited in the shortcuts.xml file stored on your machine. The easiest way to find this is to search for it, on my computer it is located here:
C:\Users\username\AppData\Roaming\Notepad++\

This file includes all of the commands for the shortcuts in your "Run" menu. In this case the final entry is the TUFLOW entry.
<code>
<UserDefinedCommands>
<Command name="Launch in Firefox" Ctrl="yes" Alt="yes" Shift="yes" Key="88">firefox "$(FULL_CURRENT_PATH)"</Command>
<Command name="Get php help" Ctrl="no" Alt="yes" Shift="no" Key="112">https://www.php.net/%20$(CURRENT_WORD)</Command>
<Command name="Google Search" Ctrl="no" Alt="yes" Shift="no" Key="113">https://www.google.com/search?q=$(CURRENT_WORD)</Command>
<Command name="Wikipedia Search" Ctrl="no" Alt="yes" Shift="no" Key="114">https://en.wikipedia.org/wiki/Special:Search?search=$(CURRENT_WORD)</Command>
<Command name="Open file" Ctrl="no" Alt="yes" Shift="no" Key="116">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD)</Command>
<Command name="Open file (relative)" Ctrl="no" Alt="yes" Shift="no" Key="32">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_DIRECTORY)/$(CURRENT_WORD)</Command>
<Command name="Open in another instance" Ctrl="no" Alt="yes" Shift="no" Key="117">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD) -nosession -multiInst</Command>
<Command name="Open containing folder" Ctrl="no" Alt="no" Shift="no" Key="0">explorer $(CURRENT_DIRECTORY)</Command>
<Command name="Open current dir cmd" Ctrl="no" Alt="no" Shift="no" Key="0">cmd /K cd $(CURRENT_DIRECTORY)</Command>
<Command name="Send via Outlook" Ctrl="yes" Alt="yes" Shift="yes" Key="79">outlook /a "$(FULL_CURRENT_PATH)"</Command>
<Command name="TUFLOW 2011-09-w64-iSP" Ctrl="no" Alt="no" Shift="no" Key="0">"C:\TUFLOW\Releases\2011-09\w64\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</Command>
</UserDefinedCommands>
</code>
{{Tips Navigation
|uplink=[[NotepadPlusPlus_Tips | Back to Notepad ++ tips.]]
}}

NotepadPlusPlus Run TUFLOW

2025-09-26T06:54:24Z

Chris Huxley:

To run TUFLOW from Notepad++ we need to create a new Run option.
<ol>
<li>Select the ''Run >>> Run'' menu items.</li>
<li>In the Run dialogue select the three dots (...), navigate to and select the desired executable. If there are spaces in the name this path should be enclosed in quotes.</li>
<li>In the command line after the TUFLOW path enter "space" (without the quotes) and <tt>"$(FULL_CURRENT_PATH)"</tt> (with the quotes). 
The line should be of the form as bellow where the executable path matches the location on your computer: 
: "C:\TUFLOW\Releases\2020-10-AA\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</li>
[[File:Notepad_RunTUFLOW1.png]]
<li>This tells notepad to pass the currently open file to TUFLOW as the input file.
<li>Select Save and give the item a sensible name e.g. TUFLOW 2020-10-AA-iSP.</li>
<li>To run TUFLOW with the currently open TCF file, simply select the item from the Run menu (or set a shortcut if desired).</li>
[[File:Notepad_RunTUFLOW2.png]]
</ol>
 
'''Troubleshooting''' 
If you receive a "ShellExecute ERROR" further configuration is necessary. 
[[File:shell_execute_error.png|400px]] 
<ol>
<li> In Windows Exporer navigate to the folder location where you have saved the TUFLOW executable.
<li> Double left mouse click the TUFLOW executable. When the following protection pop-up appears, select "More info" 
[[File:Windows_Protection.png|400px]] 
<li> Select "Run anyway". This will open a DOS window and run the TUFLOW executable. 
[[File:Windows_Run_Anyway.png|400px]] 
<li> Close the TUFLOW DOS window.
<li> Restart Notepad++. The TUFLOW Run Option should now function correctly.
</ol>
 
{{Tips Navigation
|uplink=[[NotepadPlusPlus_Tips | Back to Notepad ++ tips.]]
}} 

 

'''TIP:''' The shortcuts can be found and edited in the shortcuts.xml file stored on your machine. The easiest way to find this is to search for it, on my computer it is located here:
C:\Users\username\AppData\Roaming\Notepad++\

This file includes all of the commands for the shortcuts in your "Run" menu. In this case the final entry is the TUFLOW entry.
<code>
<UserDefinedCommands>
<Command name="Launch in Firefox" Ctrl="yes" Alt="yes" Shift="yes" Key="88">firefox "$(FULL_CURRENT_PATH)"</Command>
<Command name="Get php help" Ctrl="no" Alt="yes" Shift="no" Key="112">https://www.php.net/%20$(CURRENT_WORD)</Command>
<Command name="Google Search" Ctrl="no" Alt="yes" Shift="no" Key="113">https://www.google.com/search?q=$(CURRENT_WORD)</Command>
<Command name="Wikipedia Search" Ctrl="no" Alt="yes" Shift="no" Key="114">https://en.wikipedia.org/wiki/Special:Search?search=$(CURRENT_WORD)</Command>
<Command name="Open file" Ctrl="no" Alt="yes" Shift="no" Key="116">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD)</Command>
<Command name="Open file (relative)" Ctrl="no" Alt="yes" Shift="no" Key="32">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_DIRECTORY)/$(CURRENT_WORD)</Command>
<Command name="Open in another instance" Ctrl="no" Alt="yes" Shift="no" Key="117">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD) -nosession -multiInst</Command>
<Command name="Open containing folder" Ctrl="no" Alt="no" Shift="no" Key="0">explorer $(CURRENT_DIRECTORY)</Command>
<Command name="Open current dir cmd" Ctrl="no" Alt="no" Shift="no" Key="0">cmd /K cd $(CURRENT_DIRECTORY)</Command>
<Command name="Send via Outlook" Ctrl="yes" Alt="yes" Shift="yes" Key="79">outlook /a "$(FULL_CURRENT_PATH)"</Command>
<Command name="TUFLOW 2011-09-w64-iSP" Ctrl="no" Alt="no" Shift="no" Key="0">"C:\TUFLOW\Releases\2011-09\w64\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</Command>
</UserDefinedCommands>
</code>

NotepadPlusPlus Run TUFLOW

2025-09-26T06:54:01Z

Chris Huxley:

To run TUFLOW from Notepad++ we need to create a new Run option.
<ol>
<li>Select the ''Run >>> Run'' menu items.</li>
<li>In the Run dialogue select the three dots (...), navigate to and select the desired executable. If there are spaces in the name this path should be enclosed in quotes.</li>
<li>In the command line after the TUFLOW path enter "space" (without the quotes) and <tt>"$(FULL_CURRENT_PATH)"</tt> (with the quotes). 
The line should be of the form as bellow where the executable path matches the location on your computer: 
: "C:\TUFLOW\Releases\2020-10-AA\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</li>
[[File:Notepad_RunTUFLOW1.png]]
<li>This tells notepad to pass the currently open file to TUFLOW as the input file.
<li>Select Save and give the item a sensible name e.g. TUFLOW 2020-10-AA-iSP.</li>
<li>To run TUFLOW with the currently open TCF file, simply select the item from the Run menu (or set a shortcut if desired).</li>
[[File:Notepad_RunTUFLOW2.png]]
</ol>
 
'''Troubleshooting''' 
If you receive a "ShellExecute ERROR" further configuration is necessary. 
[[File:shell_execute_error.png|400px]] 
<ol>
<li> In Windows Exporer navigate to the folder location where you have saved the TUFLOW executable.
<li> Double left mouse click the TUFLOW executable. When the following protection pop-up appears, select "More info" 
[[File:Windows_Protection.png|400px]] 
<li> Select "Run anyway". This will open a DOS window and run the TUFLOW executable. 
[[File:Windows_Run_Anyway.png|400px]] 
<li> Close the TUFLOW DOS window.
<li> Restart Notepad++. The TUFLOW Run Option should now function correctly.
</ol>

{{Tips Navigation
|uplink=[[NotepadPlusPlus_Tips | Back to Notepad ++ tips.]]
}}

'''TIP:''' The shortcuts can be found and edited in the shortcuts.xml file stored on your machine. The easiest way to find this is to search for it, on my computer it is located here:
C:\Users\username\AppData\Roaming\Notepad++\

This file includes all of the commands for the shortcuts in your "Run" menu. In this case the final entry is the TUFLOW entry.
<code>
<UserDefinedCommands>
<Command name="Launch in Firefox" Ctrl="yes" Alt="yes" Shift="yes" Key="88">firefox "$(FULL_CURRENT_PATH)"</Command>
<Command name="Get php help" Ctrl="no" Alt="yes" Shift="no" Key="112">https://www.php.net/%20$(CURRENT_WORD)</Command>
<Command name="Google Search" Ctrl="no" Alt="yes" Shift="no" Key="113">https://www.google.com/search?q=$(CURRENT_WORD)</Command>
<Command name="Wikipedia Search" Ctrl="no" Alt="yes" Shift="no" Key="114">https://en.wikipedia.org/wiki/Special:Search?search=$(CURRENT_WORD)</Command>
<Command name="Open file" Ctrl="no" Alt="yes" Shift="no" Key="116">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD)</Command>
<Command name="Open file (relative)" Ctrl="no" Alt="yes" Shift="no" Key="32">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_DIRECTORY)/$(CURRENT_WORD)</Command>
<Command name="Open in another instance" Ctrl="no" Alt="yes" Shift="no" Key="117">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD) -nosession -multiInst</Command>
<Command name="Open containing folder" Ctrl="no" Alt="no" Shift="no" Key="0">explorer $(CURRENT_DIRECTORY)</Command>
<Command name="Open current dir cmd" Ctrl="no" Alt="no" Shift="no" Key="0">cmd /K cd $(CURRENT_DIRECTORY)</Command>
<Command name="Send via Outlook" Ctrl="yes" Alt="yes" Shift="yes" Key="79">outlook /a "$(FULL_CURRENT_PATH)"</Command>
<Command name="TUFLOW 2011-09-w64-iSP" Ctrl="no" Alt="no" Shift="no" Key="0">"C:\TUFLOW\Releases\2011-09\w64\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</Command>
</UserDefinedCommands>
</code>

NotepadPlusPlus Run TUFLOW

2025-09-26T06:53:40Z

Chris Huxley:

To run TUFLOW from Notepad++ we need to create a new Run option.
<ol>
<li>Select the ''Run >>> Run'' menu items.</li>
<li>In the Run dialogue select the three dots (...), navigate to and select the desired executable. If there are spaces in the name this path should be enclosed in quotes.</li>
<li>In the command line after the TUFLOW path enter "space" (without the quotes) and <tt>"$(FULL_CURRENT_PATH)"</tt> (with the quotes). 
The line should be of the form as bellow where the executable path matches the location on your computer: 
: "C:\TUFLOW\Releases\2020-10-AA\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</li>
[[File:Notepad_RunTUFLOW1.png]]
<li>This tells notepad to pass the currently open file to TUFLOW as the input file.
<li>Select Save and give the item a sensible name e.g. TUFLOW 2020-10-AA-iSP.</li>
<li>To run TUFLOW with the currently open TCF file, simply select the item from the Run menu (or set a shortcut if desired).</li>
[[File:Notepad_RunTUFLOW2.png]]
</ol>
 
'''Troubleshooting''' 
If you receive a "ShellExecute ERROR" further configuration is necessary. 
[[File:shell_execute_error.png|400px]] 
<ol>
<li> In Windows Exporer navigate to the folder location where you have saved the TUFLOW executable.
<li> Double left mouse click the TUFLOW executable. When the following protection pop-up appears, select "More info"
[[File:Windows_Protection.png|400px]] 
<li> Select "Run anyway". This will open a DOS window and run the TUFLOW executable.
[[File:Windows_Run_Anyway.png|400px]] 
<li> Close the TUFLOW DOS window.
<li> Restart Notepad++. The TUFLOW Run Option should now function correctly.
</ol>

{{Tips Navigation
|uplink=[[NotepadPlusPlus_Tips | Back to Notepad ++ tips.]]
}}

'''TIP:''' The shortcuts can be found and edited in the shortcuts.xml file stored on your machine. The easiest way to find this is to search for it, on my computer it is located here:
C:\Users\username\AppData\Roaming\Notepad++\

This file includes all of the commands for the shortcuts in your "Run" menu. In this case the final entry is the TUFLOW entry.
<code>
<UserDefinedCommands>
<Command name="Launch in Firefox" Ctrl="yes" Alt="yes" Shift="yes" Key="88">firefox "$(FULL_CURRENT_PATH)"</Command>
<Command name="Get php help" Ctrl="no" Alt="yes" Shift="no" Key="112">https://www.php.net/%20$(CURRENT_WORD)</Command>
<Command name="Google Search" Ctrl="no" Alt="yes" Shift="no" Key="113">https://www.google.com/search?q=$(CURRENT_WORD)</Command>
<Command name="Wikipedia Search" Ctrl="no" Alt="yes" Shift="no" Key="114">https://en.wikipedia.org/wiki/Special:Search?search=$(CURRENT_WORD)</Command>
<Command name="Open file" Ctrl="no" Alt="yes" Shift="no" Key="116">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD)</Command>
<Command name="Open file (relative)" Ctrl="no" Alt="yes" Shift="no" Key="32">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_DIRECTORY)/$(CURRENT_WORD)</Command>
<Command name="Open in another instance" Ctrl="no" Alt="yes" Shift="no" Key="117">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD) -nosession -multiInst</Command>
<Command name="Open containing folder" Ctrl="no" Alt="no" Shift="no" Key="0">explorer $(CURRENT_DIRECTORY)</Command>
<Command name="Open current dir cmd" Ctrl="no" Alt="no" Shift="no" Key="0">cmd /K cd $(CURRENT_DIRECTORY)</Command>
<Command name="Send via Outlook" Ctrl="yes" Alt="yes" Shift="yes" Key="79">outlook /a "$(FULL_CURRENT_PATH)"</Command>
<Command name="TUFLOW 2011-09-w64-iSP" Ctrl="no" Alt="no" Shift="no" Key="0">"C:\TUFLOW\Releases\2011-09\w64\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</Command>
</UserDefinedCommands>
</code>

NotepadPlusPlus Run TUFLOW

2025-09-26T06:53:09Z

Chris Huxley:

To run TUFLOW from Notepad++ we need to create a new Run option.
<ol>
<li>Select the ''Run >>> Run'' menu items.</li>
<li>In the Run dialogue select the three dots (...), navigate to and select the desired executable. If there are spaces in the name this path should be enclosed in quotes.</li>
<li>In the command line after the TUFLOW path enter "space" (without the quotes) and <tt>"$(FULL_CURRENT_PATH)"</tt> (with the quotes). 
The line should be of the form as bellow where the executable path matches the location on your computer: 
: "C:\TUFLOW\Releases\2020-10-AA\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</li>
[[File:Notepad_RunTUFLOW1.png]]
<li>This tells notepad to pass the currently open file to TUFLOW as the input file.
<li>Select Save and give the item a sensible name e.g. TUFLOW 2020-10-AA-iSP.</li>
<li>To run TUFLOW with the currently open TCF file, simply select the item from the Run menu (or set a shortcut if desired).</li>
[[File:Notepad_RunTUFLOW2.png]]
</ol>
 
'''Troubleshooting''' 
If you receive a "ShellExecute ERROR" further configuration is necessary. 
[[File:shell_execute_error.png|400px]] 
<ol>
<li> In Windows Exporer navigate to the folder location where you have saved the TUFLOW executable.
<li> Double left mouse click the TUFLOW executable. When the following protection pop-up appears, select "More info"
[[Windows_Protection.png|400px]] 
<li> Select "Run anyway". This will open a DOS window and run the TUFLOW executable.
[[Windows_Run_Anyway.png|400px]] 
<li> Close the TUFLOW DOS window.
<li> Restart Notepad++. The TUFLOW Run Option should now function correctly.
</ol>

{{Tips Navigation
|uplink=[[NotepadPlusPlus_Tips | Back to Notepad ++ tips.]]
}}

'''TIP:''' The shortcuts can be found and edited in the shortcuts.xml file stored on your machine. The easiest way to find this is to search for it, on my computer it is located here:
C:\Users\username\AppData\Roaming\Notepad++\

This file includes all of the commands for the shortcuts in your "Run" menu. In this case the final entry is the TUFLOW entry.
<code>
<UserDefinedCommands>
<Command name="Launch in Firefox" Ctrl="yes" Alt="yes" Shift="yes" Key="88">firefox "$(FULL_CURRENT_PATH)"</Command>
<Command name="Get php help" Ctrl="no" Alt="yes" Shift="no" Key="112">https://www.php.net/%20$(CURRENT_WORD)</Command>
<Command name="Google Search" Ctrl="no" Alt="yes" Shift="no" Key="113">https://www.google.com/search?q=$(CURRENT_WORD)</Command>
<Command name="Wikipedia Search" Ctrl="no" Alt="yes" Shift="no" Key="114">https://en.wikipedia.org/wiki/Special:Search?search=$(CURRENT_WORD)</Command>
<Command name="Open file" Ctrl="no" Alt="yes" Shift="no" Key="116">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD)</Command>
<Command name="Open file (relative)" Ctrl="no" Alt="yes" Shift="no" Key="32">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_DIRECTORY)/$(CURRENT_WORD)</Command>
<Command name="Open in another instance" Ctrl="no" Alt="yes" Shift="no" Key="117">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD) -nosession -multiInst</Command>
<Command name="Open containing folder" Ctrl="no" Alt="no" Shift="no" Key="0">explorer $(CURRENT_DIRECTORY)</Command>
<Command name="Open current dir cmd" Ctrl="no" Alt="no" Shift="no" Key="0">cmd /K cd $(CURRENT_DIRECTORY)</Command>
<Command name="Send via Outlook" Ctrl="yes" Alt="yes" Shift="yes" Key="79">outlook /a "$(FULL_CURRENT_PATH)"</Command>
<Command name="TUFLOW 2011-09-w64-iSP" Ctrl="no" Alt="no" Shift="no" Key="0">"C:\TUFLOW\Releases\2011-09\w64\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</Command>
</UserDefinedCommands>
</code>

NotepadPlusPlus Run TUFLOW

2025-09-26T06:52:52Z

Chris Huxley:

To run TUFLOW from Notepad++ we need to create a new Run option.
<ol>
<li>Select the ''Run >>> Run'' menu items.</li>
<li>In the Run dialogue select the three dots (...), navigate to and select the desired executable. If there are spaces in the name this path should be enclosed in quotes.</li>
<li>In the command line after the TUFLOW path enter "space" (without the quotes) and <tt>"$(FULL_CURRENT_PATH)"</tt> (with the quotes). 
The line should be of the form as bellow where the executable path matches the location on your computer: 
: "C:\TUFLOW\Releases\2020-10-AA\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</li>
[[File:Notepad_RunTUFLOW1.png]]
<li>This tells notepad to pass the currently open file to TUFLOW as the input file.
<li>Select Save and give the item a sensible name e.g. TUFLOW 2020-10-AA-iSP.</li>
<li>To run TUFLOW with the currently open TCF file, simply select the item from the Run menu (or set a shortcut if desired).</li>
[[File:Notepad_RunTUFLOW2.png]]
</ol>
 
'''Troubleshooting'''
If you receive a "ShellExecute ERROR" further configuration is necessary. 
[[File:shell_execute_error.png|400px]] 
<ol>
<li> In Windows Exporer navigate to the folder location where you have saved the TUFLOW executable.
<li> Double left mouse click the TUFLOW executable. When the following protection pop-up appears, select "More info"
[[Windows_Protection.png|400px]] 
<li> Select "Run anyway". This will open a DOS window and run the TUFLOW executable.
[[Windows_Run_Anyway.png|400px]] 
<li> Close the TUFLOW DOS window.
<li> Restart Notepad++. The TUFLOW Run Option should now function correctly.
</ol>

{{Tips Navigation
|uplink=[[NotepadPlusPlus_Tips | Back to Notepad ++ tips.]]
}}

'''TIP:''' The shortcuts can be found and edited in the shortcuts.xml file stored on your machine. The easiest way to find this is to search for it, on my computer it is located here:
C:\Users\username\AppData\Roaming\Notepad++\

This file includes all of the commands for the shortcuts in your "Run" menu. In this case the final entry is the TUFLOW entry.
<code>
<UserDefinedCommands>
<Command name="Launch in Firefox" Ctrl="yes" Alt="yes" Shift="yes" Key="88">firefox "$(FULL_CURRENT_PATH)"</Command>
<Command name="Get php help" Ctrl="no" Alt="yes" Shift="no" Key="112">https://www.php.net/%20$(CURRENT_WORD)</Command>
<Command name="Google Search" Ctrl="no" Alt="yes" Shift="no" Key="113">https://www.google.com/search?q=$(CURRENT_WORD)</Command>
<Command name="Wikipedia Search" Ctrl="no" Alt="yes" Shift="no" Key="114">https://en.wikipedia.org/wiki/Special:Search?search=$(CURRENT_WORD)</Command>
<Command name="Open file" Ctrl="no" Alt="yes" Shift="no" Key="116">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD)</Command>
<Command name="Open file (relative)" Ctrl="no" Alt="yes" Shift="no" Key="32">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_DIRECTORY)/$(CURRENT_WORD)</Command>
<Command name="Open in another instance" Ctrl="no" Alt="yes" Shift="no" Key="117">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD) -nosession -multiInst</Command>
<Command name="Open containing folder" Ctrl="no" Alt="no" Shift="no" Key="0">explorer $(CURRENT_DIRECTORY)</Command>
<Command name="Open current dir cmd" Ctrl="no" Alt="no" Shift="no" Key="0">cmd /K cd $(CURRENT_DIRECTORY)</Command>
<Command name="Send via Outlook" Ctrl="yes" Alt="yes" Shift="yes" Key="79">outlook /a "$(FULL_CURRENT_PATH)"</Command>
<Command name="TUFLOW 2011-09-w64-iSP" Ctrl="no" Alt="no" Shift="no" Key="0">"C:\TUFLOW\Releases\2011-09\w64\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</Command>
</UserDefinedCommands>
</code>

File:Windows Run Anyway.png

2025-09-26T06:51:32Z

Chris Huxley:

File:Windows Protection.png

2025-09-26T06:51:22Z

Chris Huxley:

File:Shell execute error.png

2025-09-26T06:51:14Z

Chris Huxley:

NotepadPlusPlus Run TUFLOW

2025-09-26T06:50:59Z

Chris Huxley:

To run TUFLOW from Notepad++ we need to create a new Run option.
<ol>
<li>Select the ''Run >>> Run'' menu items.</li>
<li>In the Run dialogue select the three dots (...), navigate to and select the desired executable. If there are spaces in the name this path should be enclosed in quotes.</li>
<li>In the command line after the TUFLOW path enter "space" (without the quotes) and <tt>"$(FULL_CURRENT_PATH)"</tt> (with the quotes). 
The line should be of the form as bellow where the executable path matches the location on your computer: 
: "C:\TUFLOW\Releases\2020-10-AA\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</li>
[[File:Notepad_RunTUFLOW1.png]]
<li>This tells notepad to pass the currently open file to TUFLOW as the input file.
<li>Select Save and give the item a sensible name e.g. TUFLOW 2020-10-AA-iSP.</li>
<li>To run TUFLOW with the currently open TCF file, simply select the item from the Run menu (or set a shortcut if desired).</li>
[[File:Notepad_RunTUFLOW2.png]]
</ol>

'''Troubleshooting'''
If you receive a "ShellExecute ERROR" further configuration is necessary. 
[[File:shell_execute_error.png]] 
<ol>
<li> In Windows Exporer navigate to the folder location where you have saved the TUFLOW executable.
<li> Double left mouse click the TUFLOW executable. When the following protection pop-up appears, select "More info"
[[Windows_Protection.png ]]
<li> Select "Run anyway". This will open a DOS window and run the TUFLOW executable.
[[Windows_Run_Anyway.png]]
<li> Close the TUFLOW DOS window.
<li> Restart Notepad++. The TUFLOW Run Option should now function correctly.
</ol>

{{Tips Navigation
|uplink=[[NotepadPlusPlus_Tips | Back to Notepad ++ tips.]]
}}

'''TIP:''' The shortcuts can be found and edited in the shortcuts.xml file stored on your machine. The easiest way to find this is to search for it, on my computer it is located here:
C:\Users\username\AppData\Roaming\Notepad++\

This file includes all of the commands for the shortcuts in your "Run" menu. In this case the final entry is the TUFLOW entry.
<code>
<UserDefinedCommands>
<Command name="Launch in Firefox" Ctrl="yes" Alt="yes" Shift="yes" Key="88">firefox "$(FULL_CURRENT_PATH)"</Command>
<Command name="Get php help" Ctrl="no" Alt="yes" Shift="no" Key="112">https://www.php.net/%20$(CURRENT_WORD)</Command>
<Command name="Google Search" Ctrl="no" Alt="yes" Shift="no" Key="113">https://www.google.com/search?q=$(CURRENT_WORD)</Command>
<Command name="Wikipedia Search" Ctrl="no" Alt="yes" Shift="no" Key="114">https://en.wikipedia.org/wiki/Special:Search?search=$(CURRENT_WORD)</Command>
<Command name="Open file" Ctrl="no" Alt="yes" Shift="no" Key="116">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD)</Command>
<Command name="Open file (relative)" Ctrl="no" Alt="yes" Shift="no" Key="32">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_DIRECTORY)/$(CURRENT_WORD)</Command>
<Command name="Open in another instance" Ctrl="no" Alt="yes" Shift="no" Key="117">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD) -nosession -multiInst</Command>
<Command name="Open containing folder" Ctrl="no" Alt="no" Shift="no" Key="0">explorer $(CURRENT_DIRECTORY)</Command>
<Command name="Open current dir cmd" Ctrl="no" Alt="no" Shift="no" Key="0">cmd /K cd $(CURRENT_DIRECTORY)</Command>
<Command name="Send via Outlook" Ctrl="yes" Alt="yes" Shift="yes" Key="79">outlook /a "$(FULL_CURRENT_PATH)"</Command>
<Command name="TUFLOW 2011-09-w64-iSP" Ctrl="no" Alt="no" Shift="no" Key="0">"C:\TUFLOW\Releases\2011-09\w64\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</Command>
</UserDefinedCommands>
</code>

NotepadPlusPlus Run TUFLOW

2025-09-26T06:50:22Z

Chris Huxley:

To run TUFLOW from Notepad++ we need to create a new Run option.
<ol>
<li>Select the ''Run >>> Run'' menu items.</li>
<li>In the Run dialogue select the three dots (...), navigate to and select the desired executable. If there are spaces in the name this path should be enclosed in quotes.</li>
<li>In the command line after the TUFLOW path enter "space" (without the quotes) and <tt>"$(FULL_CURRENT_PATH)"</tt> (with the quotes). 
The line should be of the form as bellow where the executable path matches the location on your computer: 
: "C:\TUFLOW\Releases\2020-10-AA\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</li>
[[File:Notepad_RunTUFLOW1.png]]
<li>This tells notepad to pass the currently open file to TUFLOW as the input file.
<li>Select Save and give the item a sensible name e.g. TUFLOW 2020-10-AA-iSP.</li>
<li>To run TUFLOW with the currently open TCF file, simply select the item from the Run menu (or set a shortcut if desired).</li>
[[File:Notepad_RunTUFLOW2.png]]
</ol>

'''Troubleshooting'''
If you receive a "ShellExecute ERROR" further configuration is necessary. 
[[File:shell_execute_error.png]] 
<ol>
<li> In Windows Exporer navigate to the folder location where you have saved the TUFLOW executable.
<li> Double left mouse click the TUFLOW executable. When the following protection pop-up appears, select "More info"
[[Windows_Protection.png ]]
<li> Select "Run anyway". This will open a DOS window and run the TUFLOW executable.
[[Windows_Run_Anyway.png]]
<li> Close the TUFLOW DOS window.
<li> Restart Notepad++. The TUFLOW Run Option should now function correctly.
</ol>

[[NotepadPlusPlus_Tips | Back to Notepad ++ tips.]]

'''TIP:''' The shortcuts can be found and edited in the shortcuts.xml file stored on your machine. The easiest way to find this is to search for it, on my computer it is located here:
C:\Users\username\AppData\Roaming\Notepad++\

This file includes all of the commands for the shortcuts in your "Run" menu. In this case the final entry is the TUFLOW entry.
<code>
<UserDefinedCommands>
<Command name="Launch in Firefox" Ctrl="yes" Alt="yes" Shift="yes" Key="88">firefox "$(FULL_CURRENT_PATH)"</Command>
<Command name="Get php help" Ctrl="no" Alt="yes" Shift="no" Key="112">https://www.php.net/%20$(CURRENT_WORD)</Command>
<Command name="Google Search" Ctrl="no" Alt="yes" Shift="no" Key="113">https://www.google.com/search?q=$(CURRENT_WORD)</Command>
<Command name="Wikipedia Search" Ctrl="no" Alt="yes" Shift="no" Key="114">https://en.wikipedia.org/wiki/Special:Search?search=$(CURRENT_WORD)</Command>
<Command name="Open file" Ctrl="no" Alt="yes" Shift="no" Key="116">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD)</Command>
<Command name="Open file (relative)" Ctrl="no" Alt="yes" Shift="no" Key="32">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_DIRECTORY)/$(CURRENT_WORD)</Command>
<Command name="Open in another instance" Ctrl="no" Alt="yes" Shift="no" Key="117">$(NPP_DIRECTORY)\notepad++.exe $(CURRENT_WORD) -nosession -multiInst</Command>
<Command name="Open containing folder" Ctrl="no" Alt="no" Shift="no" Key="0">explorer $(CURRENT_DIRECTORY)</Command>
<Command name="Open current dir cmd" Ctrl="no" Alt="no" Shift="no" Key="0">cmd /K cd $(CURRENT_DIRECTORY)</Command>
<Command name="Send via Outlook" Ctrl="yes" Alt="yes" Shift="yes" Key="79">outlook /a "$(FULL_CURRENT_PATH)"</Command>
<Command name="TUFLOW 2011-09-w64-iSP" Ctrl="no" Alt="no" Shift="no" Key="0">"C:\TUFLOW\Releases\2011-09\w64\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)"</Command>
</UserDefinedCommands>
</code>

Naming Convention

2025-08-05T23:40:44Z

Chris Huxley: /* Control and Input Files – Version Numbering Convention */

__TOC__
 
The establishment of a sound naming convention is fundamental to the easy management of TUFLOW models and their associated files. A certain degree of flexibility regarding naming conventions is usually required due to differences between projects and users. However, early establishment of a system has the following benefits:
* Easier to understand modelling logic;
* Easier to check for errors;
* Traceability;
* Transferable between different users; and
* Ease of handover of the model to the Client or Authorities.
Additionally, a sound naming convention can significantly reduce the time taken to locate files, especially in folders where hundreds of files are present, which may be the case for large modelling projects. Once a naming and numbering convention is adopted, then a [[TUFLOW_Modelling_Log|modelling log]] can more easily be kept. 
 
There is some simple advice on naming conventions in the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. 
Currently, most modelling incorporates use of the TUFLOW scenario and event management feature. This allows for wildcards to be incorporated in the file name. [[TUFLOW Example Models|Example models]] are available which demonstrate Scenario/Event management. A [[ Run_TUFLOW_From_a_Batch-file#Looping_in_a_batch_file|batch file]] can then be set up to run various scenario combinations from the one TUFLOW Control File (TCF). 
 
The below sections provide information on the recommended naming convention for clearly identifying different types of TUFLOW input files. Guidance is also provided on a version numbering convention for control and input files during model development. 
 

=Input File Type – Prefix Naming Conventions=
As the bulk of the data input to TUFLOW is via GIS layers, efficient management of these datasets is essential. Different TUFLOW input files require different GIS attributes. For example, an initial water level input file only requires a single attribute on the GIS file (which is the initial water level), whereas, a 1D channel has a number of attributes (channel type, inverts etc.). Differentiating between these TUFLOW file types is therefore essential. 
 
TUFLOW input files are given different recommended prefixes depending on their purpose. An example of this is demonstrated in the table below. The complete list of recommended prefixes can be found in the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. The TCF command <tt>Write Empty GIS Files</tt> can be used to automate the creation of the template (empty) files, which use these recommended prefixes. These empty files are created with the precise GIS file formats required for each input TUFLOW file. The [[TUFLOW Empty Files]] page provides a reference list of the template (empty) GIS files, the associated TUFLOW command and a basic description of their function. 
 
It is strongly recommended that the prefixes described in the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] be adhered to for all 1D and 2D GIS layers. This greatly enhances the data management efficiency and, importantly, allows for the differentiation of input files, making it easier for another modeller or reviewer to quickly interpret the model. 

{| class="wikitable" width="75%"
! style="background-color:#005581; font-weight:bold; color:white;" width=20%| GIS Data Type
! style="background-color:#005581; font-weight:bold; color:white;" width=20%| Suggested File Prefix
! style="background-color:#005581; font-weight:bold; color:white" width=60%| Description
|-
| style="text-align: left;" | 2D Boundaries and 2D/1D Links
| style="text-align: left;" | 2d_bc_ (2d_hx_) (2d_sx_)
|| Mandatory layer(s) defining the locations of 2D boundaries and 2D/1D dynamic links. For large models it may be wise to separate the boundary conditions from the 1D/2D links, in which case the 2d_bc prefix can be substituted with 2d_hx_ and 2d_sx. Cell code values may also be defined in this layer.
|-
|}
 

TUFLOW control files are structured to allow the majority of commands to be repeated and layered. Input file types of the same prefix may need to be used more than once. Hence, additional information such as a descriptor and a file version number is conventionally included in the input file name. An example of a typical file name for an input file is shown below:

*GeoPackage:
:* Database for the entire model:
:::'''ModelName'''_'''FileVersion'''.gpkg
:::'''M01'''_'''001'''.gpkg
:* Database for GIS layer (multiple geometry types):
:::'''FileTypePrefix'''_'''FileDescriptor'''_'''FileVersion'''.gpkg
:::'''2d_bc'''_'''CreekInflow'''_'''001'''.gpkg 
:* Database for GIS layer (single geometry type):
:::'''FileTypePrefix'''_'''FileDescriptor'''_'''FileVersion'''_'''GeometryType'''.gpkg
:::'''2d_bc'''_'''CreekInflow'''_'''001'''_'''L'''.gpkg 
:* GeoPackage Layer (within a database):
:::'''gpkgDatabaseName'''_'''GeometryType'''
:::2d_bc_CreekInflow_001.gpkg >> '''2d_bc_CreekInflow'''_'''L''' 
 

*Shapefile layer:
:::'''FileTypePrefix'''_'''FileDescriptor'''_'''FileVersion'''_'''GeometryType'''.shp
:::'''2d_bc'''_'''CreekInflow'''_'''001'''_'''L'''.shp 

:Note: Only a single geometry type (points, lines or regions) can be included in a shapefile. Thus, for datasets made up of multiple geometries, for example points and lines, two separate files will be required. Therefore, the suggested file naming convention for shapefiles includes the geometry type (P for points, L for lines or R for regions). 
 

*MIF formatted layer:
:::'''FileTypePrefix'''_'''FileDescriptor'''_'''FileVersion'''.mif
:::'''2d_bc'''_'''CreekInflow'''_'''001'''.mif 
 

Many iterations of the same input file may be created as the model is developed. A suggested approach for the use of version numbering of input and control files is provided below.

=Control and Input Files – Version Numbering Convention=

The version numbering convention described below is presented as guidance only. Users are free to deviate from that suggested, however, establishing a sound naming and numbering convention is highly recommended throughout the model development. This can aid in quality control, allowing modellers to revert back to an earlier version of the model input if required.
 
Version numbering convention of the TCF control file is particularly important as its name determines the prefix assigned for the results and check files. The TCF is used as the basis for version numbering, following the below convention:
*Increment the TCF version number sequentially each time a change is made anywhere in the model;
*If a change is made in a sub-control file such as the TUFLOW Geometry Control File (TGC), Boundary Control File (TBC) or Estry Control File (ECF), then the version number of that sub-control file should be incremented. However, the numbering of these files should be incremented to correspond to the revised TCF version number. Numbering for a given sub-control file is not necessarily sequential;
*Similarly, if a change is made to any input GIS files listed in any of the control files, then the version number of that input file should be incremented, corresponding to the revised TCF version number. Numbering for a given input file is not necessarily sequential.

Generally, changes are made at the lowest level, i.e. the GIS input. That file, and all files in the hierarchy above it, are given a new version number consistent with the next TCF iteration. This provides an indication of at which point in the model development a GIS layer was introduced.

Each time a new element/s is introduced, the version number of the TCF is incremented. The above convention is demonstrated in the table below, showing file version numbering of input layers corresponding with the overarching control files. Each update is highlighted '''bold'''. The table below shows:
*When a new GIS layer is introduced or amendment made, a new TCF is created with the version number iterated up. The GIS layer is assigned the same version number as the TCF;
*The numbering of input layers doesn’t have to be sequential, as per the development Z shape and the 1d_nwk layers;
*Modifications can be made in a number of the sub-control files for a given TCF increment, as per Model_005.tcf.

{| class="wikitable" width="100%"
! style="background-color:#005581; font-weight:bold; color:white;" width=8%| TCF
! style="background-color:#005581; font-weight:bold; color:white;" width=8%| TGC
! style="background-color:#005581; font-weight:bold; color:white" width=15%| TGC Input Layers
! style="background-color:#005581; font-weight:bold; color:white;" width=8%| TBC
! style="background-color:#005581; font-weight:bold; color:white" width=12%| TBC Input Layers
! style="background-color:#005581; font-weight:bold; color:white;" width=8%| ECF
! style="background-color:#005581; font-weight:bold; color:white" width=8%| ECF Input Layers
! style="background-color:#005581; font-weight:bold; color:white;" | Model Amendments
|-
| style="text-align: center;" | MODEL_001.tcf
| style="text-align: center;" | MODEL_001.tgc
|| gis\2d_loc_EG00_001_L.shp gis\2d_code_001_R.shp grid\DEM_2mLidar_01.tif
| style="text-align: center;" | MODEL_001.tbc
|| gis\2d_bc_EG00_001_L.shp
| style="text-align: center;" |
||
|| Construct 2D only model with base topography. 
|-
| style="text-align: center;" | '''MODEL_002.tcf'''
| style="text-align: center;" | '''MODEL_002.tgc'''
|| gis\2d_loc_EG00_001_L.shp gis\2d_code_001_R.shp grid\DEM_2mLidar_001.tif '''gis\2d_zsh_Development_002_R.shp'''
| style="text-align: center;" | MODEL_001.tbc
|| gis\2d_bc_EG00_001_L.shp
| style="text-align: center;" |
||
|| Add topographic amendments for development. 
|-
| style="text-align: center;" | '''MODEL_003.tcf'''
| style="text-align: center;" | MODEL_002.tgc
|| gis\2d_loc_EG00_001_L.shp gis\2d_code_001_R.shp grid\DEM_2mLidar_001.tif gis\2d_zsh_Development_002_R.shp
| style="text-align: center;" | MODEL_001.tbc
|| gis\2d_bc_EG00_001_L.shp
| style="text-align: center;" | '''MODEL_003.ecf'''
|| '''1d_nwk_Pipes_003.shp'''
|| Add 1D elements.
|-
| style="text-align: center;" | '''MODEL_004.tcf '''
| style="text-align: center;" | MODEL_002.tgc
|| gis\2d_loc_EG00_001_L.shp gis\2d_code_001_R.shp grid\DEM_2mLidar_001.tif gis\2d_zsh_Development_002_R.shp
| style="text-align: center;" | '''MODEL_004.tbc'''
|| gis\2d_bc_EG00_001_L.shp '''gis\2d_rf_004_R.shp'''
| style="text-align: center;" | MODEL_003.ecf
|| 1d_nwk_003.shp
|| Add 2D rainfall polygon boundary condition. 
|-
| style="text-align: center;" | '''MODEL_005.tcf'''
| style="text-align: center;" | '''MODEL_005.tgc'''
|| gis\2d_loc_EG00_001_L.shp gis\2d_code_001_R.shp grid\DEM_2mLidar_001.tif '''gis\2d_zsh_Development_005_R.shp'''
| style="text-align: center;" | MODEL_004.tbc
|| gis\2d_bc_EG00_001_L.shp gis\2d_rf_004_R.shp
| style="text-align: center;" | '''MODEL_005.ecf'''
|| '''1d_nwk_Pipes_005.shp'''
|| Make modifications to the original development + update the 1D elements. 
|-
|}

 
{{Tips Navigation
|uplink=[[TUFLOW_Modelling_Guidance | Back to TUFLOW Modelling Guidance]]
}}

ArcTUFLOW Toolbox and Toolbar

2025-07-16T01:17:56Z

Chris Huxley: /* Introduction */

=Introduction=
A TUFLOW toolbox is available for ArcMap 10.1 and newer (if you are using ArcGIS Pro, please refer to [[ArcGIS_TUFLOW_Toolbar | ArcGIS Pro TUFLOWToolbar]]). This toolbox helps with streamlining the process of creating and editing a TUFLOW model in ArcMap. A Toolbar has also been developed to accompany the toolbox to further increase efficiency and workflow. The toolbar shortcuts the opening of the toolbox utilities to a single click on an easily accessible toolbar.

These utilities can be downloaded from the TUFLOW website:
* [https://www.tuflow.com/downloads/#utilities Download Link]

The download contains both the .esriaddin and the ArcTUFLOW Toolbox. The .esriaddin is a stand alone toolbar add-in to ArcMap and (as suggested) is a stand alone item that does not need to be kept with the other contents of the download. The .tbx is the ArcTUFLOW Toolbox and should be kept with the other folders contained in the download.

=Installation=
For instructions on how to install ArcTUFLOW Toolbox and Toolbar into ArcMap please see the following link:
* [[TUFLOW_ArcGIS_Toolbox_and_Toolbar_Installation | How to install ArcTUFLOW Toolbox and Toolbar]] 

=The Utilities: What are they and How to use them=

The ArcTUFLOW Tools are intended to help the user with model initiation, setup and development, running, and checking and viewing results:

[[File: ArcTUFLOW_Toolbox_Toolbar_comb.PNG]] 

{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;" width=2% | Model Stage
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Utilities
|-
|Start Model Build || 1. [[ArcTUFLOW_Configure_TUFLOW | Configure TUFLOW (Required Initialization Step)]]
2. [[#Create_TUFLOW_Folders | Create TUFLOW Folders]] 
|-
|Model Build and Development || 3. [[#Import_Empty_(template)_TUFLOW_Files| Import Empty (template) TUFLOW Files]] 
4. [[#Insert_TUFLOW_Attributes | Insert TUFLOW Attributes]] 
5. [[#Increment_Layer | Increment Layer]] 
6. [[#Style_All_TUFLOW_Layers | Style All TUFLOW Layers]] - Toolbar only 
7. [[#Style_Selected_TUFLOW_Layers | Style Selected TUFLOW Layers]] - Toolbar only 
8. [[#Create_Breakline | Create Breakline]] 
9. [[#Change_Attribute_Data_Type | Change Attribute Data Type]] 
10. [[#Correct_Pipe_Direction | Correct Pipe Direction]] 
|-
|Running TUFLOW || 11. [[#Run_TUFLOW_Simulation | Run TUFLOW Simulation]] 
|-
|Loading and Viewing Results || 12. [[#Load_Simulation_Input_Files | Load Simulation Input Files]] 
13. [[#Label_Selected_Layer | Label Selected Layer]] - Toolbar only 
14. [[#TUPLOT | TUPLOT]] - Toolbar only
|-
|Miscellaneous || 15. [[#About | About]]
|} 

==Configure TUFLOW==

The first item, “Configure TUFLOW”, creates a configuration file that will pre-populate items in other ArcTUFLOW tools based on the map document. The steps for running the configuration tool are outlined below:
* Open or save a map document before running.
* Select a TUFLOW folder for your model. This can be either the folder that contains the entire TUFLOW model folder structure or the folder that contains the TUFLOW subdirectories. For example, it can be either "D:\projects\Example\TUFLOW" or “D:\projects\Example\”. All of the following tools will use this location.
* Enter the file path to the TUFLOW executable
* Select the projection for the TUFLOW model 
[[File:ArcTUFLOW_ConfigureTUFLOW.PNG]]

==Create TUFLOW Folders==
The tool "Create TUFLOW Folders" will create the standard TUFLOW folder structure and generate empty TUFLOW template files.

This tool is best used if [[ArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] has been run prior.

[[File: ArcTUFLOW_CreateTUFLOWFolders.PNG]]

==Import Empty (template) TUFLOW Files==

"Import Empty Template Files" can be used to import new shp files for editing. This tool will automatically delete the dummy "null" entry which otherwise requires manual deletion if an empty file loaded from the catalog.
*Select the object type (point, line or region)
*Select the desired template file
*Specify the run ID for the file. This will be added to the file name as a suffix.
 
The ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to [[ArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] for more instructions. 
[[File:ArcGIS_Utility_007.jpg|400px]]

==Insert TUFLOW Attributes==

"Insert TUFLOW Attributes" will insert a TUFLOW attribute template in front of an existing GIS layer. This is useful when transferring data from a database (e.g. council stormwater network) to TUFLOW format.

The steps are:
* Select the input file (the file to have TUFLOW attribues inserted into)
* Select the TUFLOW file format
* Specify a run ID for the file. This will be added to the name as a suffix

This tool is best used if [[ArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] has been run prior.

[[File: ArcTUFLOW_InsertTUFLOWattributes.PNG]]

==Increment Layer==

The tool "Increment Layer" will increment up one or more TUFLOW layers to a new revision number and replace he existing layer in ArcMAP with the same style. Currently the limitation of the tool requires revision numbers to be 3 digits longs e.g. 001.

The steps are:
* Select desired TUFLOW layer to be incremented (these can be dragged and dropped from the TOC into the tool window)
* Specify the new revision number
* Choose to supersede the old layers (these will be placed in a 'SS' folder in the same directory as the model layer)
* Choose to append revision number if none already exists

[[File: ArcTUFLOW_IncrementLayer.PNG]]

==Style All TUFLOW Layers==

This button will apply TUFLOW stylings onto all TUFLOW related layers in the TOC.

==Style Selected TUFLOW Layers==

This button will apply TUFLOW stylings to the selected layer in the TOC.

==Create Breakline==

The "Create Breakline" tool will create a 2d_zsh breakline from a user input polyline and DEM. The user has a number of options, such as:
* Vertice placement along line - the user can specify additional intervals at which to extract elevations, or use only the line vertices
* Elevation extraction - extract straight from DEM, or use a statistical approach by looking at surrounding elevation values

The steps are:
* Specify the input polyline from which a breakline will be created from
* Select if the user only wants to extract points at a specified chainage (ignore line vertices) - otherwise points will be extracted at defined chainage and vertices
* Specify an interval at which to insert additional elevation extraction points along line - leave blank to output at line vertices only
* Specify the underlying DEM to use to for elevation extraction
* Specify a search radius for considering neighbouring elevation values if using a statistical approach to elevation extraction - leave blank to extract elevation from immediate cell
* Specify a statistical operation (must be coupled with a search radius). Options include:
** 'MAXIMUM'
** 'MINIMUM'
** 'MEAN'

[[File: ArcTUFLOW_CreateBreakline.PNG]]

==Change Attribute Data Type==

This tool allows you to modify a shapefile attribute (field) type whist keeping the attribute order intact. An example of its use is the modification of the pBlockage attribute in a 1d_nwk layer from 'double' to 'text' for the new Australian Rainfall and Runoff blockage scenarios. Please note that at present the script only allows for the change of attributes to type text.

<li>Firstly select the 'Change Attribute Type Script' from the ArcTUFLOW toolbox. 
[[File:Arc_Change_att_tool.JPG|300px]]
 
 
<li>Populate the tool dialogue and run. You can find help information on the various inputs on the tool info panel. 
[[File:Arc_Change_att_tool_iface.JPG|600px]] 
 

==Correct Pipe Direction==

The "Correct Pipe Direction" tool will reverse the direction of all lines within a layer based on the upstream and downstream invert levels. Based on the invert levels, the tool will reverse any line that has an adverse gradient, with the assumption that the line has been digitised in the wrong direction. It will also switch the upstream and downstream invert attributes to correct them after reversing the line direction.

The steps are:
* Select an input pipe layer
* Select the fields which represent the upstream and downstream invert levels

[[File: ArcTUFLOW_CorrectPipeDir.PNG]]

==Run TUFLOW Simulation==

* Enter the simulation tcf reference
* Define the path to the TUFLOW executable
 
The ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to [[ArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] for more instructions. 
[[File:ArcGIS_Utility_008.jpg|400px]]

==Load Simulation Input Files==

This tool loads all input shp files from a model simulation into a common ArcGIS Map window. 
The user has the option of which files to import from the simulation.

[[File: ArcTUFLOW ImportSimFiles.PNG]]
 
 
The shp files will be loaded using a predefined symbology for common TUFLOW input file types. This is determined based on the prefix of the file name. For example, the symbology for 2d_code and 2d_zsh files are shown below. 
[[File:arcTUFLOW_Load_Simulation_File_Symbology.JPG|200px]]
 
This tool is courtesy of Wood Rodgers, Inc. (www.woodrodgers.com)

==Label Selected Layer==

This tool will auto label the selected layer in the TOC. If the selected layer is a TUFLOW layer (e.g. 1d_nwk) the tool will automatically apply an expression, displaying useful information about the layer. It can also be used on non-TUFLOW layers, however will only label the first attribute. The user also has the option of changing the label colour from the adjacent drop down box (default is black if no colour is selected).

This tool is useful for reviewing models as well as building.

==TUPLOT==

TUPLOT is a 1D and 2D time series results viewer. A full description on how to use it is below:
* [[TUPLOT_External | How to use TUPLOT]]

==About==
Displays version of ArcTUFLOW.

 
{{Tips Navigation
|uplink=[[ArcGis_Tips | Back to ArcGIS]]}}

ArcTUFLOW Toolbox and Toolbar

2025-07-16T01:17:46Z

Chris Huxley:

=Introduction=
A TUFLOW toolbox is available for ArcMap 10.1 and newer (If you are using ArcGIS Pro, please refer to [[ArcGIS_TUFLOW_Toolbar | ArcGIS Pro TUFLOWToolbar]]). This toolbox helps with streamlining the process of creating and editing a TUFLOW model in ArcMap. A Toolbar has also been developed to accompany the toolbox to further increase efficiency and workflow. The toolbar shortcuts the opening of the toolbox utilities to a single click on an easily accessible toolbar.

These utilities can be downloaded from the TUFLOW website:
* [https://www.tuflow.com/downloads/#utilities Download Link]

The download contains both the .esriaddin and the ArcTUFLOW Toolbox. The .esriaddin is a stand alone toolbar add-in to ArcMap and (as suggested) is a stand alone item that does not need to be kept with the other contents of the download. The .tbx is the ArcTUFLOW Toolbox and should be kept with the other folders contained in the download.

=Installation=
For instructions on how to install ArcTUFLOW Toolbox and Toolbar into ArcMap please see the following link:
* [[TUFLOW_ArcGIS_Toolbox_and_Toolbar_Installation | How to install ArcTUFLOW Toolbox and Toolbar]] 

=The Utilities: What are they and How to use them=

The ArcTUFLOW Tools are intended to help the user with model initiation, setup and development, running, and checking and viewing results:

[[File: ArcTUFLOW_Toolbox_Toolbar_comb.PNG]] 

{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;" width=2% | Model Stage
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Utilities
|-
|Start Model Build || 1. [[ArcTUFLOW_Configure_TUFLOW | Configure TUFLOW (Required Initialization Step)]]
2. [[#Create_TUFLOW_Folders | Create TUFLOW Folders]] 
|-
|Model Build and Development || 3. [[#Import_Empty_(template)_TUFLOW_Files| Import Empty (template) TUFLOW Files]] 
4. [[#Insert_TUFLOW_Attributes | Insert TUFLOW Attributes]] 
5. [[#Increment_Layer | Increment Layer]] 
6. [[#Style_All_TUFLOW_Layers | Style All TUFLOW Layers]] - Toolbar only 
7. [[#Style_Selected_TUFLOW_Layers | Style Selected TUFLOW Layers]] - Toolbar only 
8. [[#Create_Breakline | Create Breakline]] 
9. [[#Change_Attribute_Data_Type | Change Attribute Data Type]] 
10. [[#Correct_Pipe_Direction | Correct Pipe Direction]] 
|-
|Running TUFLOW || 11. [[#Run_TUFLOW_Simulation | Run TUFLOW Simulation]] 
|-
|Loading and Viewing Results || 12. [[#Load_Simulation_Input_Files | Load Simulation Input Files]] 
13. [[#Label_Selected_Layer | Label Selected Layer]] - Toolbar only 
14. [[#TUPLOT | TUPLOT]] - Toolbar only
|-
|Miscellaneous || 15. [[#About | About]]
|} 

==Configure TUFLOW==

The first item, “Configure TUFLOW”, creates a configuration file that will pre-populate items in other ArcTUFLOW tools based on the map document. The steps for running the configuration tool are outlined below:
* Open or save a map document before running.
* Select a TUFLOW folder for your model. This can be either the folder that contains the entire TUFLOW model folder structure or the folder that contains the TUFLOW subdirectories. For example, it can be either "D:\projects\Example\TUFLOW" or “D:\projects\Example\”. All of the following tools will use this location.
* Enter the file path to the TUFLOW executable
* Select the projection for the TUFLOW model 
[[File:ArcTUFLOW_ConfigureTUFLOW.PNG]]

==Create TUFLOW Folders==
The tool "Create TUFLOW Folders" will create the standard TUFLOW folder structure and generate empty TUFLOW template files.

This tool is best used if [[ArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] has been run prior.

[[File: ArcTUFLOW_CreateTUFLOWFolders.PNG]]

==Import Empty (template) TUFLOW Files==

"Import Empty Template Files" can be used to import new shp files for editing. This tool will automatically delete the dummy "null" entry which otherwise requires manual deletion if an empty file loaded from the catalog.
*Select the object type (point, line or region)
*Select the desired template file
*Specify the run ID for the file. This will be added to the file name as a suffix.
 
The ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to [[ArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] for more instructions. 
[[File:ArcGIS_Utility_007.jpg|400px]]

==Insert TUFLOW Attributes==

"Insert TUFLOW Attributes" will insert a TUFLOW attribute template in front of an existing GIS layer. This is useful when transferring data from a database (e.g. council stormwater network) to TUFLOW format.

The steps are:
* Select the input file (the file to have TUFLOW attribues inserted into)
* Select the TUFLOW file format
* Specify a run ID for the file. This will be added to the name as a suffix

This tool is best used if [[ArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] has been run prior.

[[File: ArcTUFLOW_InsertTUFLOWattributes.PNG]]

==Increment Layer==

The tool "Increment Layer" will increment up one or more TUFLOW layers to a new revision number and replace he existing layer in ArcMAP with the same style. Currently the limitation of the tool requires revision numbers to be 3 digits longs e.g. 001.

The steps are:
* Select desired TUFLOW layer to be incremented (these can be dragged and dropped from the TOC into the tool window)
* Specify the new revision number
* Choose to supersede the old layers (these will be placed in a 'SS' folder in the same directory as the model layer)
* Choose to append revision number if none already exists

[[File: ArcTUFLOW_IncrementLayer.PNG]]

==Style All TUFLOW Layers==

This button will apply TUFLOW stylings onto all TUFLOW related layers in the TOC.

==Style Selected TUFLOW Layers==

This button will apply TUFLOW stylings to the selected layer in the TOC.

==Create Breakline==

The "Create Breakline" tool will create a 2d_zsh breakline from a user input polyline and DEM. The user has a number of options, such as:
* Vertice placement along line - the user can specify additional intervals at which to extract elevations, or use only the line vertices
* Elevation extraction - extract straight from DEM, or use a statistical approach by looking at surrounding elevation values

The steps are:
* Specify the input polyline from which a breakline will be created from
* Select if the user only wants to extract points at a specified chainage (ignore line vertices) - otherwise points will be extracted at defined chainage and vertices
* Specify an interval at which to insert additional elevation extraction points along line - leave blank to output at line vertices only
* Specify the underlying DEM to use to for elevation extraction
* Specify a search radius for considering neighbouring elevation values if using a statistical approach to elevation extraction - leave blank to extract elevation from immediate cell
* Specify a statistical operation (must be coupled with a search radius). Options include:
** 'MAXIMUM'
** 'MINIMUM'
** 'MEAN'

[[File: ArcTUFLOW_CreateBreakline.PNG]]

==Change Attribute Data Type==

This tool allows you to modify a shapefile attribute (field) type whist keeping the attribute order intact. An example of its use is the modification of the pBlockage attribute in a 1d_nwk layer from 'double' to 'text' for the new Australian Rainfall and Runoff blockage scenarios. Please note that at present the script only allows for the change of attributes to type text.

<li>Firstly select the 'Change Attribute Type Script' from the ArcTUFLOW toolbox. 
[[File:Arc_Change_att_tool.JPG|300px]]
 
 
<li>Populate the tool dialogue and run. You can find help information on the various inputs on the tool info panel. 
[[File:Arc_Change_att_tool_iface.JPG|600px]] 
 

==Correct Pipe Direction==

The "Correct Pipe Direction" tool will reverse the direction of all lines within a layer based on the upstream and downstream invert levels. Based on the invert levels, the tool will reverse any line that has an adverse gradient, with the assumption that the line has been digitised in the wrong direction. It will also switch the upstream and downstream invert attributes to correct them after reversing the line direction.

The steps are:
* Select an input pipe layer
* Select the fields which represent the upstream and downstream invert levels

[[File: ArcTUFLOW_CorrectPipeDir.PNG]]

==Run TUFLOW Simulation==

* Enter the simulation tcf reference
* Define the path to the TUFLOW executable
 
The ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to [[ArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] for more instructions. 
[[File:ArcGIS_Utility_008.jpg|400px]]

==Load Simulation Input Files==

This tool loads all input shp files from a model simulation into a common ArcGIS Map window. 
The user has the option of which files to import from the simulation.

[[File: ArcTUFLOW ImportSimFiles.PNG]]
 
 
The shp files will be loaded using a predefined symbology for common TUFLOW input file types. This is determined based on the prefix of the file name. For example, the symbology for 2d_code and 2d_zsh files are shown below. 
[[File:arcTUFLOW_Load_Simulation_File_Symbology.JPG|200px]]
 
This tool is courtesy of Wood Rodgers, Inc. (www.woodrodgers.com)

==Label Selected Layer==

This tool will auto label the selected layer in the TOC. If the selected layer is a TUFLOW layer (e.g. 1d_nwk) the tool will automatically apply an expression, displaying useful information about the layer. It can also be used on non-TUFLOW layers, however will only label the first attribute. The user also has the option of changing the label colour from the adjacent drop down box (default is black if no colour is selected).

This tool is useful for reviewing models as well as building.

==TUPLOT==

TUPLOT is a 1D and 2D time series results viewer. A full description on how to use it is below:
* [[TUPLOT_External | How to use TUPLOT]]

==About==
Displays version of ArcTUFLOW.

 
{{Tips Navigation
|uplink=[[ArcGis_Tips | Back to ArcGIS]]}}

MiTools Tips

2025-07-16T01:08:50Z

Chris Huxley: /* Description */

= Description =
MapInfo and TUFLOW Productivity Utilities (miTools) is a MapInfo add-on that is available for download from the [https://www.tuflow.com/downloads/#gis_tools TUFLOW website]. MiTools have been developed specifically to improve the efficiency of setting up and reviewing TUFLOW models, as well as improving the day to day ease of using MapInfo Professional (MI Pro). The suite of utilities enables ‘automation’ of many of the common repetitive tasks, saving valuable time and therefore money. The utilities also allow the efficient creation and visualisation of key TUFLOW model inputs/outputs within the MapInfo environment. Other tools provide data checking and quality assurance functionality, thus helping to minimise modeling errors.

[[File: miTools_001.JPG]]
[[File: miTools_000.JPG|350px]] 

== General MapInfo Capabilities ==
* Efficiently manipulate MapInfo’s Layer Control without having to scroll through countless layers. Based on selected object(s), switch the layer on, make it editable, make it non-selectable, close it or open the table in a browser window. Filter the Layer Control to remove unused layers and/or close unused tables and/or delete selected objects without having to make then layer editable.
* Batch import MID/MIF files and automatically add them to Layer Control
* Import a MID/MIF file and automatically add it to the Layer Control as the top-layer and set it to editable. If it is a TUFLOW layer, apply the user defined default object styles
* Batch export MID/MIF files, as well as prompt for packing, saving edits, etc.

== Other Capabilities ==
* A cross-section editor to view and edit CSV format cross-sections. The utility includes a data management tool that tracks changes to the cross-section properties, as well saving backup files following each subsequent change.
* A range of Flood Modeller-TUFLOW related utilities (especially for UK customers) including a utility to extract cross-sections from an Flood Modeller DAT format file into individual ESTRY format CSV files and a utility to name Flood Modeller 1d_nwk channels the same as the upstream node ID.

== TUFLOW Capabilities ==
* MapInfo interfaces for common TUFLOW utilities TUFLOW_to_GIS and ASC_to_ASC.
* MapInfo interface to run TUFLOW, create and run TUFLOW batch files, and to test and package models.
* Automatically apply predefined MapInfo object styles to TUFLOW layers.
* Enhanced single and batch MIF import and export utilities.
* Automatically create and trim TUFLOW Water Level Lines(WLL), as well as cross-section (XS) lines.
* Extract multiple TUFLOW CSV format cross-sections from a Vertical Mapper DEM, and automatically assign roughness’s from a materials or Manning’s table.
* CSV Cross-section editor with inbuilt version and edit tracking.
* Automatically draw, attribute and snap TUFLOW CN Lines.
* Batch split a polyline, such as a river centreline, using a table of cross-sections. The utility is extremely useful for quickly setting up 1d networks where existing cross-section and river centreline/long-section data are available.
* Graph the TUFLOW MID/MIF time-series (TS) results data for selected TS objects within MapInfo. Summarise the maximum and minimum of the saved TS values for the active TS Graph window. Filter the graphs - i.e. to display only a sub-set of all the TS objects selected, such as the flows (Q) only.
* Plot TUFLOW CSV format cross-sections within MapInfo. Include TUFLOW water level results if required.
* Create long-section plots within MapInfo. Plot pipe obvert levels, minimum cover levels and highlight pits where the outlet level is higher than the lowest inlet(s), i.e. an error in the data.
* Region/polygon editing tools to speed up snapping, trimming and splitting region objects while also ensuring the resulting objects are truly snapped together.
* ‘Increment’ the selected TUFLOW layer: The utility assists to ensure TUFLOW MI layers are correctly renamed and setup for editing in an efficient manner.
* Label selected TUFLOW layer with associated elevation or invert data, to user specified formats with the click of a single button. The user can customise the number ofdecimal places displayed, the label styles (colour, options, size, font), as well as the visibility options for the labels (eg the zoom display range).
* Filter TUFLOW layers: a utility to assist in dealing with large and complicated TUFLOW models. The utility will turn on or a specific layer types, as well as DEMs and images. The utility also has an option to group and sort TUFLOW layers in the current map window, based on the file type order specified in a customisable .ini file.
* Quickly turn on the borders of thematically mapped grid cells.

{{Tips Navigation
|uplink=[[MapInfo_Tips | Back to MapInfo Tips]]}}

Run TUFLOW From PowerShell

2025-07-15T02:04:09Z

Chris Huxley: /* Using PowerShell */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path, use single quotations around the entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run_TUFLOW_simulations.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_Edited.mp4|width=850}} 

A Windows batch file can also be used to execute a PowerShell script, avoiding the need to work in the PowerShell command line.
* Create a text file with a *.bat file extension, saved in your TUFLOW\runs folder (alongside your TCF)
* Add the following syntax to the batch file (if your ps1 file uses a different name, specify it instead of run_TUFLOW_simulations.ps1):
<pre>
@powershell -File .\run_TUFLOW_simulations.ps1
</pre>
* Double left mouse click the batch file from Window Explorer to execute the batch file that calls the PowerShell script

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppress the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 5m -s2 D01 model_~s1~_~s2~_001.tcf
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, where TUFLOW runs a simulation for all combinations of scenarios and events.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the simulation TLF or _ TUFLOW Simulations.log) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

Run TUFLOW From PowerShell

2025-07-15T02:03:51Z

Chris Huxley: /* Using PowerShell */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path, use single quotations around the entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run_TUFLOW_simulations.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_Edited.mp4|width=850}} 

A Windows batch file can also be used to execute a PowerShell script, avoiding the need to work in the PowerShell command line.
* Create a text file with a *.bat file extension, saved in your TUFLOW\runs folder (alongside your TCF)
* Add the following syntax to the batch file (if your ps1 file uses a different name, specify it instead of run_TUFLOW_simulations.ps1):
<pre>
@powershell -File .\run_TUFLOW_simulations.ps1
</pre>
* Double left mouse click the batch file from Window Explorer to execute the batch file that calls the PowerShell script

 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppress the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 5m -s2 D01 model_~s1~_~s2~_001.tcf
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, where TUFLOW runs a simulation for all combinations of scenarios and events.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the simulation TLF or _ TUFLOW Simulations.log) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

Run TUFLOW From PowerShell

2025-07-15T02:03:00Z

Chris Huxley: /* Using PowerShell */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path, use single quotations around the entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run_TUFLOW_simulations.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_Edited.mp4|width=850}} 

A Windows batch file can also be used to execute a PowerShell script, avoiding the need to work in the PowerShell command line.
* Create a text file with a *.bat file extension, saved in your TUFLOW\runs folder (alongside your TCF)
* Add the following syntax to the batch file:
<pre>
@powershell -File .\run_TUFLOW_simulations.ps1
</pre>
* Double left mouse click the batch file from Window Explorer to execute the batch file that calls the PowerShell script

 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppress the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 5m -s2 D01 model_~s1~_~s2~_001.tcf
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, where TUFLOW runs a simulation for all combinations of scenarios and events.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the simulation TLF or _ TUFLOW Simulations.log) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

Run TUFLOW From PowerShell

2025-07-15T02:02:38Z

Chris Huxley: /* Using PowerShell */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path, use single quotations around the entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run_TUFLOW_simulations.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_Edited.mp4|width=850}} 

A Windows batch file can also be used to execute a PowerShell script, avoiding the need to work in the PowerShell command line.
* Create a text file with a *.bat file extension, saved in your TUFLOW/runs folder (alongside your TCF)
* Add the following syntax to the batch file:
<pre>
@powershell -File .\run_TUFLOW_simulations.ps1
</pre>
* Double left mouse click the batch file from Window Explorer to execute the batch file that calls the PowerShell script

 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppress the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 5m -s2 D01 model_~s1~_~s2~_001.tcf
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, where TUFLOW runs a simulation for all combinations of scenarios and events.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the simulation TLF or _ TUFLOW Simulations.log) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

Run TUFLOW From PowerShell

2025-07-15T01:59:22Z

Chris Huxley: /* Using PowerShell */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path, use single quotations around the entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run_TUFLOW_simulations.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_Edited.mp4|width=850}} 

A Windows batch file can also be used to execute a PowerShell script, avoiding the need to work in the PowerShell command line.
* Create a text file with a *.bat file extension
* Add the following syntax to the batch file: "@powershell -File .\run_TUFLOW_simulations.ps1"
* Double left mouse click the batch file from Window Explorer to execute the batch file that calls the PowerShell script

 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppress the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 5m -s2 D01 model_~s1~_~s2~_001.tcf
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, where TUFLOW runs a simulation for all combinations of scenarios and events.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the simulation TLF or _ TUFLOW Simulations.log) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

Run TUFLOW From PowerShell

2025-06-30T02:56:28Z

Chris Huxley: /* Using PowerShell */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path, use single quotations around the entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run_TUFLOW_simulations.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_Edited.mp4|width=850}} 
 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppresses the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -x -s1 5m -s2 D01 model_~s1~_~s2~_001.tcf
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, so that TUFLOW runs a simulation for all combinations of scenario and event.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the simulation TLF or _ TUFLOW Simulations.log) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

Run TUFLOW From PowerShell

2025-06-29T23:39:55Z

Chris Huxley: /* Email Notifications */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path, use single quotations around the entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_Edited.mp4|width=850}} 
 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppresses the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -x -s1 5m -s2 D01 model_~s1~_~s2~_001.tcf
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, so that TUFLOW runs a simulation for all combinations of scenario and event.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the simulation TLF or _ TUFLOW Simulations.log) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

Run TUFLOW From PowerShell

2025-06-29T23:38:28Z

Chris Huxley: /* Using PowerShell */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path, use single quotations around the entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_Edited.mp4|width=850}} 
 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppresses the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -x -s1 5m -s2 D01 model_~s1~_~s2~_001.tcf
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, so that TUFLOW runs a simulation for all combinations of scenario and event.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the TLF) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

Run TUFLOW From PowerShell

2025-06-29T23:38:13Z

Chris Huxley: /* Using PowerShell */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path, use single quotations around entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_Edited.mp4|width=850}} 
 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppresses the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -x -s1 5m -s2 D01 model_~s1~_~s2~_001.tcf
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, so that TUFLOW runs a simulation for all combinations of scenario and event.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the TLF) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

Run TUFLOW From PowerShell

2025-06-27T01:53:11Z

Chris Huxley: /* Adding Switches */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path use single quotations around entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_002.mp4|width=1350}} 
 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppresses the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -x -s1 5m -s2 D01 model_~s1~_~s2~_001.tcf
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, so that TUFLOW runs a simulation for all combinations of scenario and event.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the TLF) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

Run TUFLOW From PowerShell

2025-06-27T01:46:30Z

Chris Huxley: /* Adding Switches */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path use single quotations around entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_002.mp4|width=1350}} 
 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppresses the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -x -s1 5m -s2 D01 'model_~s1~_~s2~_001.tcf'
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, so that TUFLOW runs a simulation for all combinations of scenario and event.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the TLF) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

Run TUFLOW From PowerShell

2025-06-27T01:44:50Z

Chris Huxley: /* Looping */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path use single quotations around entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_002.mp4|width=1350}} 
 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppresses the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -t model_001.tcf
</pre>

When specifying a tcf file that includes scenarios and/or events within the filename use single quotations around the tcf file reference (' ').
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -x -s1 5m -s2 D01 'model_~s1~_~s2~_001.tcf'
</pre>

This example demonstrates how to package a copy of a project milestone model (including all possible scenario and event inputs) for archiving:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -pmAll -xf0 -s1 5m -s2 D01 -e1 Q100 -e2 2hr 'model_~s1~_~s2~_~e1~_~e2~_001.tcf'
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, so that TUFLOW runs a simulation for all combinations of scenario and event.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the TLF) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>