Tuflow - User contributions [en]

TUFLOW on Linux

2026-05-05T00:09:18Z

ElizaCollison: /* How to use */

= Introduction =
Since the 2026.0.0 release, TUFLOW Classic/HPC is available for Linux, just like TUFLOW FV has been since its inception. Although the application functions the same on either Microsoft Windows or Linux, there are some caveats to consider especially when working across both platforms within a single project.

= How to install =
TUFLOW for Linux is available in two types of packages, <code>.deb</code> for Debian family distributions (like Debian, Ubuntu, Mint, etc.) and <code>.rpm</code> for RHEL family distributions (Red Hat, CentOS, Rocky, etc.).

To install TUFLOW for Linux, download the appropriate package for the Linux distribution from the [https://www.tuflow.com/downloads/ TUFLOW Downloads page] and install the package using the appropriate package manager for the distribution. For example, on Ubuntu, the following command can be used in the terminal (making sure to use the correct path to the downloaded <code>.deb</code> file):

: <code>sudo apt install ./tuflow_2026.0.0~beta.1-1_amd64.deb</code>

It is recommended that admins use <code>dnf</code> or <code>apt</code> respectively, to ensure that dependencies are automatically downloaded and installed as needed.

= How to use =
After installation, TUFLOW will be available from the command line as <code>tuflow_2026.0-isp</code> for single precision and <code>tuflow_2026.0-idp</code> for double precision. Users may define an alias like <code>alias tuflow='tuflow_2026.0'</code> or use the specific versioned command directly in their scripts. Command-line options are passed just as in Windows.

However, because Linux often runs without a graphical environment, TUFLOW on Linux runs as if the <code>-nmb</code> option was provided.

= Use across both Microsoft Windows and Linux =
Some of the quirky differences between Windows and Linux will affect users that want to use TUFLOW across both systems.

By no means a complete overview, but these are some aspects to consider:
<ol>
*'''Slashes and backslashes''' Windows uses backslashes in file and directory paths like <code>D:\Project\results\</code>. Linux uses forward slashes instead like <code>~/Project/results</code> and will often interpret characters following backslashes as special characters. TUFLOW will usually deal with either format on either system in configuration files, but when writing scripts or commands (in powershell, terminal, etc) users should remain aware. Also, logs and outputs referring to files will use the format appropriate to the system it is running on.
*'''Drive letters''' Drive letters like <code>D:</code> are specific to Windows. Configuration files that need to be usable across both systems should avoid their use and instead use relative paths like <code>../Model/Materials_001.csv</code> or absolute paths that assume the file is on the current drive like <code>/Project/model/Materials_001.csv</code>.
*'''Character case in names''' Windows is case-insensitive, which means that files called <code>Hello.TXT</code> and <code>hello.txt</code> are considered to have the same name, and cannot exist in the same location. Linux is case-sensitive and considers uppercase characters and lowercase characters to be different, and so those two files can exist side by side. This is very relevant if TUFLOW users use one spelling in one place, and the other in another - whereas Windows might interpret both references to point to the same file, on Linux they would result in two separate files. Similarly, if a file's name is spelled with different case from its actual name, a Windows application would find it, and a Linux application might not. (see below)
*'''Encoding and special characters''' On older versions of Windows in English-speaking countries, text files (including TUFLOW configuration files) would use the 1252-Windows encoding. In modern versions of Windows, UTF-8 with BOM is the standard. On Linux UTF-8 without BOM is the standard. TUFLOW accepts any of these encodings and will typically write files in UTF-8 without BOM. On Windows, line endings in such text files are encoded as two characters, a carriage return and a line feed (CR/LF), while Linux uses only a single LF. TUFLOW accepts both forms and writes what is appropriate to the system it is running on.
</ol>

To ensure maximum compatibility of models across systems, TUFLOW will do its best to match names in the model files in the same way between Windows and Linux. 

As a general principle, TUFLOW will default to trying to run a model with as little change as possible required across both platforms, writing results in a form that is appropriate to the platform it runs on. 

= Common Questions Answered (FAQ)=
== Why use TUFLOW on Linux at all? ==
TUFLOW on Linux is not just for users that use Linux as their primary work environment, although those certainly exist. Other reasons to consider are:
<ol>
*'''Performance''' Servers or workstations that are dedicated for the running of models can be configured to run TUFLOW and the necessary supporting software (e.g. CodeMeter, NVIDIA GPU drivers, etc.) and very little else, using Linux. There may also be small performance differences in general between an executable built and optimised for Windows or Linux.
*'''Infrastructure cost''' Especially relevant when running virtual machines dedicated to running TUFLOW, or many of those in the cloud, most distributions of Linux do not require a licence whereas Windows does. This can substantially reduce the cost of infrastructure.
*'''HPC tooling''' Automation of running TUFLOW models across many computers or in the cloud can be greatly simplified with tooling designed for that purpose. Many such tools are available "off the shelf", but mostly on Linux (e.g. SLURM, PBS/Torque, etc.). Similarly, containerisation (e.g. Docker, Podman, LXC) typically requires running on Linux as well.
: ''Note:'' HPC tooling refers to job scheduling and automation software for managing large numbers of model runs. Containerisation packages applications and their dependencies into portable and reproducible runtime environments.
</ol>

== Must TUFLOW users on Linux use the command line interface? ==
Linux offers a variety of desktop environments and TUFLOW can be used from those just like users would using Microsoft Windows. However, in either case TUFLOW itself is always running as a so-called console application and that makes it uniquely suited to running in lightweight non-graphical environments as well.

Like Windows, Linux offers a variety of scripting options that can help minimise the direct use of the command line by users, if that is desirable. Bash shell scripts are as easy to write and run as batch files are on Windows. Running Python or even PowerShell on Linux is easy to set up as well.

However, given the nature of the application and Linux as an operating system, TUFLOW users on Linux would do well to try and understand some of the basics of using TUFLOW from the command line and the TUFLOW Support team can assist with that.

TUFLOW Message 0648

2026-05-04T05:32:40Z

ElizaCollison: Created page with "{{TUFLOW_Message |tuflow_message=ERROR 0648 - Unable to open HEC-DSS File. |alt_msg=NA |type=ERROR |message_desc=Unable to open HEC-DSS File. |suggestions=Please contact [mailto:support@tuflow.com support@tuflow.com]. |uplink=0xxx Messages }}"

{{TUFLOW_Message
|tuflow_message=ERROR 0648 - Unable to open HEC-DSS File.
|alt_msg=NA 

|type=[[ERROR]]
|message_desc=Unable to open HEC-DSS File.
|suggestions=Please contact [mailto:support@tuflow.com support@tuflow.com].

|uplink=[[0xxx_TUFLOW_Messages|0xxx Messages]]
}}

0xxx TUFLOW Messages

2026-05-04T05:30:25Z

ElizaCollison:

The 0xxx error messages refer to errors that occur neither in the 1D or the 2D. Links to detailed message descriptions are listed in the table below. Grey messages do not yet have a message assigned, and red numbers have been allocated to new messages.

See also:
* [[1xxx TUFLOW Messages]]
* [[2xxx TUFLOW Messages]]
* [[3xxx TUFLOW Messages]]
* [[4xxx TUFLOW Messages]]
* [[5xxx TUFLOW Messages]]
* [[6xxx TUFLOW Messages]]

{| Border ="1" cellpadding="8" style="text-align:center"
|0000 || [[TUFLOW Message 0001|0001 ]] || [[TUFLOW Message 0002|0002 ]] || [[TUFLOW Message 0003|0003 ]] || [[TUFLOW Message 0004|0004 ]] || [[TUFLOW Message 0005|0005 ]] || [[TUFLOW Message 0006|0006 ]] || [[TUFLOW Message 0007|0007 ]] || [[TUFLOW Message 0008|0008 ]] || [[TUFLOW Message 0009|0009 ]] || 0010 || [[TUFLOW Message 0011|0011 ]] || [[TUFLOW Message 0012|0012 ]] || [[TUFLOW Message 0013|0013 ]] || 0014 || [[TUFLOW Message 0015|0015 ]] || 0016 || 0017 || 0018 || 0019
|-
|[[TUFLOW Message 0020|0020 ]] || [[TUFLOW Message 0021|0021 ]] || [[TUFLOW Message 0022|0022 ]] || [[TUFLOW Message 0023|0023 ]] || [[TUFLOW Message 0024|0024 ]] || [[TUFLOW Message 0025|0025 ]] || [[TUFLOW Message 0026|0026 ]] || [[TUFLOW Message 0027|0027 ]] || [[TUFLOW Message 0028|0028 ]] || [[TUFLOW Message 0029|0029 ]] || [[TUFLOW Message 0030|0030 ]] || [[TUFLOW Message 0031|0031 ]] || [[TUFLOW Message 0032|0032 ]] || [[TUFLOW Message 0033|0033 ]] || [[TUFLOW Message 0034|0034 ]] || [[TUFLOW Message 0035|0035 ]] || [[TUFLOW Message 0036|0036 ]] || [[TUFLOW Message 0037|0037 ]] || [[TUFLOW Message 0038|0038 ]] || 0039
|-
|[[TUFLOW Message 0040|0040 ]] || [[TUFLOW Message 0041|0041 ]] || [[TUFLOW Message 0042|0042 ]] || [[TUFLOW Message 0043|0043 ]] || 0044 || [[TUFLOW Message 0045|0045 ]] || [[TUFLOW Message 0046|0046 ]] || [[TUFLOW Message 0047|0047 ]] || [[TUFLOW Message 0048|0048]] || 0049 || 0050 || [[TUFLOW Message 0051|0051 ]] || [[TUFLOW Message 0052|0052 ]] || [[TUFLOW Message 0053|0053 ]] || 0054 || 0055 || 0056 || 0057 || 0058 || 0059
|-
|[[TUFLOW Message 0060|0060 ]] || 0061 || 0062 || 0063 || 0064 || 0065 || 0066 || 0067 || 0068 || 0069 || 0070 || 0071 || 0072 || 0073 || 0074 || 0075 || 0076 || 0077 || 0078 || 0079
|-
|[[TUFLOW Message 0100|0100 ]] || [[TUFLOW Message 0101|0101 ]] || [[TUFLOW Message 0102|0102 ]] || [[TUFLOW Message 0103|0103 ]] || [[TUFLOW Message 0104|0104 ]] || [[TUFLOW Message 0105|0105 ]] || [[TUFLOW Message 0106|0106 ]] || [[TUFLOW Message 0107|0107 ]] || [[TUFLOW Message 0108|0108 ]] || [[TUFLOW Message 0109|0109 ]] || [[TUFLOW Message 0110|0110 ]] || [[TUFLOW Message 0111|0111 ]] || [[TUFLOW Message 0112|0112 ]] || 0113 || 0114 || [[TUFLOW Message 0115|0115 ]] || [[TUFLOW Message 0116|0116 ]] || [[TUFLOW Message 0117|0117 ]] || [[TUFLOW Message 0118|0118 ]] || 0119
|-
|[[TUFLOW Message 0120|0120 ]] || [[TUFLOW Message 0121|0121 ]] || [[TUFLOW Message 0122|0122 ]] || [[TUFLOW Message 0123|0123 ]] || 0124 || 0125 || 0126 || 0127 || 0128 || 0129 || [[TUFLOW Message 0130|0130 ]] || [[TUFLOW Message 0131|0131 ]] || 0132 || 0133 || 0134 || 0135 || 0136 || 0137 || 0138 || 0139
|-
|0140 || [[TUFLOW Message 0141|0141 ]] || [[TUFLOW Message 0142|0142 ]] || 0143 || [[TUFLOW Message 0144|0144 ]] || 0145 || 0146 || 0147 || 0148 || 0149 || 0150 || 0151 || 0152 || 0153 || 0154 || 0155 || 0156 || 0157 || 0158 || 0159
|-
|[[TUFLOW Message 0160|0160 ]] || 0161 || 0162 || [[TUFLOW Message 0163|0163 ]] || 0164 || 0165 || 0166 || 0167 || 0168 || 0169 || 0170 || 0171 || 0172 || 0173 || 0174 || [[TUFLOW Message 0175|0175 ]] || 0176 || 0177 || 0178 || 0179
|-
|-
|0180 || 0181 || 0182 || 0183 || [[TUFLOW Message 0184|0184 ]] || 0185 || 0186 || 0187 || 0188 || 0189 || 0190 || 0191 || 0192 || 0193 || 0194 || 0195 || 0176 || 0197 || 0198 || 0199
|-
|0200 || [[TUFLOW Message 0201|0201 ]] || [[TUFLOW Message 0202|0202 ]] || [[TUFLOW Message 0203|0203 ]] || 0204 || 0205 || 0206 || 0207 || 0208 || 0209 || 0210 || 0211 || 0212 || 0213 || 0214 || 0215 || 0216 || 0217 || 0218 || 0219
|-
|0240 || 0241 || [[TUFLOW Message 0242|0242 ]] || 0243 || [[TUFLOW Message 0244|0244 ]] || 0245 || 0246 || [[TUFLOW Message 0247|0247 ]] || [[TUFLOW Message 0248|0248 ]] || [[TUFLOW Message 0249|0249 ]] || [[TUFLOW Message 0250|0250 ]] || [[TUFLOW Message 0251|0251 ]] || [[TUFLOW Message 0252|0252 ]] || [[TUFLOW Message 0253|0253 ]] || [[TUFLOW Message 0254|0254 ]] || [[TUFLOW Message 0255|0255 ]] || 0256 || 0257 || 0258 || 0259
|-
|[[TUFLOW Message 0300|0300 ]] || [[TUFLOW Message 0301|0301 ]] || [[TUFLOW Message 0302|0302 ]] || [[TUFLOW Message 0303|0303 ]] || [[TUFLOW Message 0304|0304 ]] || [[TUFLOW Message 0305|0305 ]] || [[TUFLOW Message 0306|0306 ]] || [[TUFLOW Message 0307|0307 ]] || [[TUFLOW Message 0308|0308 ]] || [[TUFLOW Message 0309|0309 ]] || [[TUFLOW Message 0310|0310 ]] || [[TUFLOW Message 0311|0311 ]] || [[TUFLOW Message 0312|0312 ]] || [[TUFLOW Message 0313|0313 ]] || [[TUFLOW Message 0314|0314 ]] || [[TUFLOW Message 0315|0315 ]] || [[TUFLOW Message 0316|0316 ]] || [[TUFLOW Message 0317|0317 ]] || [[TUFLOW Message 0318|0318 ]] || [[TUFLOW Message 0319|0319 ]]
|-
|[[TUFLOW Message 0320|0320 ]] || [[TUFLOW Message 0321|0321 ]] || [[TUFLOW Message 0322|0322 ]] || [[TUFLOW Message 0323|0323 ]] || 0324 || 0325 || 0326 || 0327 || 0328 || 0329 || 0330 || 0331 || 0332 || 0333 || 0334 || 0335 || 0336 || 0337 || 0338 || 0339
|-
|0340 || 0341 || 0342 || 0343 || 0344 || 0345 || 0346 || 0347 || 0348 || 0349 || [[TUFLOW Message 0350|0350 ]] || 0351 || 0352 || 0353 || 0354 || 0355 || 0356 || 0357 || 0358 || 0359
|-
|0400 || [[TUFLOW Message 0401|0401 ]] || [[TUFLOW Message 0402|0402 ]] || [[TUFLOW Message 0403|0403 ]] || [[TUFLOW Message 0404|0404 ]] || [[TUFLOW Message 0405|0405 ]] || [[TUFLOW Message 0406|0406 ]] || [[TUFLOW Message 0407|0407 ]] || [[TUFLOW Message 0408|0408 ]] || 0409 || 0410 || [[TUFLOW Message 0411|0411 ]] || [[TUFLOW Message 0412|0412 ]] || [[TUFLOW Message 0413|0413 ]] || 0414 || 0415 || 0416 || [[TUFLOW Message 0417|0417 ]] || 0418 || [[TUFLOW Message 0419|0419 ]]
|-
|[[TUFLOW Message 0420|0420 ]] || [[TUFLOW Message 0421|0421 ]] || [[TUFLOW Message 0422|0422 ]] || [[TUFLOW Message 0423|0423 ]] || [[TUFLOW Message 0424|0424 ]] || [[TUFLOW Message 0425|0425 ]] || [[TUFLOW Message 0426|0426 ]] || [[TUFLOW Message 0427|0427 ]] || [[TUFLOW Message 0428|0428 ]] || [[TUFLOW Message 0429|0429 ]] || [[TUFLOW Message 0430|0430 ]] || 0431 || 0432 || 0433 || 0434 || 0435 || 0436 || [[TUFLOW Message 0437|0437 ]] || 0438 || [[TUFLOW Message 0439|0439 ]]
|-
|[[TUFLOW Message 0500|0500 ]] || [[TUFLOW Message 0501|0501 ]] || [[TUFLOW Message 0502|0502 ]] || [[TUFLOW Message 0503|0503 ]] || 0504 || [[TUFLOW Message 0505|0505 ]] || 0506 || 0507 || 0508 || 0509 || 0510 || 0511 || 0512 || 0513 || 0514 || 0515 || 0516 || 0517 || 0518 || 0519
|-
|[[TUFLOW Message 0600|0600 ]] || [[TUFLOW Message 0601|0601 ]] || 0602 || 0603 || 0604 || 0605 || 0606 || 0607 || 0608 || 0609 || 0610 || 0611 || 0612 || 0613 || 0614 || 0615 || 0616 || 0617 || 0618 || 0619
|-
|[[TUFLOW Message 0620|0620 ]] || [[TUFLOW Message 0621|0621 ]] || [[TUFLOW Message 0622|0622 ]] || [[TUFLOW Message 0623|0623 ]] || [[TUFLOW Message 0624|0624 ]] || [[TUFLOW Message 0625|0625 ]] || [[TUFLOW Message 0626|0626 ]] || [[TUFLOW Message 0627|0627 ]] || [[TUFLOW Message 0628|0628 ]] || [[TUFLOW Message 0629|0629 ]] || [[TUFLOW Message 0630|0630 ]] || [[TUFLOW Message 0631|0631 ]] || [[TUFLOW Message 0632|0632 ]] || [[TUFLOW Message 0633|0633 ]] || [[TUFLOW Message 0634|0634 ]] || [[TUFLOW Message 0635|0635 ]] || [[TUFLOW Message 0636|0636 ]] || [[TUFLOW Message 0637|0637 ]] || [[TUFLOW Message 0638|0638 ]] || [[TUFLOW Message 0639|0639 ]]
|-
|[[TUFLOW Message 0640|0640 ]] || [[TUFLOW Message 0641|0641 ]] || [[TUFLOW Message 0642|0642 ]] || [[TUFLOW Message 0643|0643 ]] || [[TUFLOW Message 0644|0644 ]] || [[TUFLOW Message 0645|0645 ]] || [[TUFLOW Message 0646|0646 ]] || [[TUFLOW Message 0647|0647 ]] || [[TUFLOW Message 0648|0648 ]] || [[TUFLOW Message 0649|0649 ]] || [[TUFLOW Message 0650|0650 ]] || [[TUFLOW Message 0651|0651 ]] || 0652 || 0653 || 0654 || 0655 || [[TUFLOW_Message_0656|0656]] || [[TUFLOW_Message_0657|0657]] || 0658 || [[TUFLOW Message 0659|0659 ]]
|-
|0700 || 0701 || 0702 || 0703 || [[TUFLOW Message 0704|0704 ]] || [[TUFLOW Message 0705|0705 ]] || 0706 || [[TUFLOW Message 0707|0707 ]] || 0708 || 0709 || [[TUFLOW Message 0710|0710 ]] || [[TUFLOW Message 0711|0711 ]] || [[TUFLOW Message 0712|0712 ]] || [[TUFLOW Message 0713|0713 ]] || 0714 || 0715 || 0716 || 0717 || 0718 || 0719
|-
|0800 || [[TUFLOW Message 0801|0801 ]] || [[TUFLOW Message 0802|0802 ]] || 0803 || 0804 || 0805 || 0806 || 0807 || 0808 || 0809 || 0810 || 0811 || 0812 || 0813 || 0814 || 0815 || 0816 || 0817 || 0818 || 0819
|-
|[[TUFLOW Message 0900|0900 ]] || [[TUFLOW Message 0901|0901 ]] || [[TUFLOW Message 0902|0902 ]] || [[TUFLOW Message 0903|0903 ]] || [[TUFLOW Message 0904|0904 ]] || [[TUFLOW Message 0905|0905 ]] || [[TUFLOW Message 0906|0906 ]] || 0907 || 0908 || [[TUFLOW Message 0909|0909 ]] || [[TUFLOW Message 0910|0910 ]] || [[TUFLOW Message 0911|0911 ]] || [[TUFLOW Message 0912|0912 ]] || [[TUFLOW Message 0913|0913 ]] || [[TUFLOW Message 0914|0914 ]] || [[TUFLOW Message 0915|0915 ]] || [[TUFLOW Message 0916|0916 ]] || [[TUFLOW Message 0917|0917 ]] || 0918 || [[TUFLOW Message 0919|0919 ]]
|-
|[[TUFLOW Message 0920|0920 ]] || [[TUFLOW Message 0921|0921 ]] || [[TUFLOW Message 0922|0922 ]] || [[TUFLOW Message 0923|0923 ]] || 0924 || 0925 || 0926 || 0927 || 0928 || 0929 || 0930 || [[TUFLOW Message 0931|0931 ]] || [[TUFLOW Message 0932|0932 ]] || [[TUFLOW Message 0933|0933 ]] || 0934 || [[TUFLOW Message 0935|0935 ]] || 0936 || 0937 || [[TUFLOW Message 0938|0938 ]] || [[TUFLOW Message 0939|0939 ]]
|-
|0940 || [[TUFLOW Message 0941|0941 ]] || [[TUFLOW Message 0942|0942 ]] || 0943 || 0944 || 0945 || 0946 || 0947 || 0948 || 0949 || 0950 || 0951 || 0952 || 0953 || 0954 || 0955 || 0956 || 0957 || 0958 || 0959
|-
|}
 
{{Tips Navigation
|uplink=[[ Main_Page | Back to Main Page]]
}}

TUFLOW on Linux

2026-05-04T02:42:41Z

ElizaCollison: /* How to use */

= Introduction =
Since the 2026.0.0 release, TUFLOW Classic/HPC is available for Linux, just like TUFLOW FV has been since its inception. Although the application functions the same on either Microsoft Windows or Linux, there are some caveats to consider especially when working across both platforms within a single project.

= How to install =
TUFLOW for Linux is available in two types of packages, <code>.deb</code> for Debian family distributions (like Debian, Ubuntu, Mint, etc.) and <code>.rpm</code> for RHEL family distributions (Red Hat, CentOS, Rocky, etc.).

To install TUFLOW for Linux, download the appropriate package for the Linux distribution from the [https://www.tuflow.com/downloads/ TUFLOW Downloads page] and install the package using the appropriate package manager for the distribution. For example, on Ubuntu, the following command can be used in the terminal (making sure to use the correct path to the downloaded <code>.deb</code> file):

: <code>sudo apt install ./tuflow_2026.0.0~beta.1-1_amd64.deb</code>

It is recommended that admins use <code>dnf</code> or <code>apt</code> respectively, to ensure that dependencies are automatically downloaded and installed as needed.

= How to use =
After installation, TUFLOW will be available from the command line as <code>tuflow_2026.0-isp</code>. Users may define an alias like <code>alias tuflow='tuflow_2026.0'</code> or use the specific versioned command directly in their scripts. Command-line options are passed just as in Windows.

However, because Linux often runs without a graphical environment, TUFLOW on Linux runs as if the <code>-nmb</code> option was provided.

= Use across both Microsoft Windows and Linux =
Some of the quirky differences between Windows and Linux will affect users that want to use TUFLOW across both systems.

By no means a complete overview, but these are some aspects to consider:
<ol>
*'''Slashes and backslashes''' Windows uses backslashes in file and directory paths like <code>D:\Project\results\</code>. Linux uses forward slashes instead like <code>~/Project/results</code> and will often interpret characters following backslashes as special characters. TUFLOW will usually deal with either format on either system in configuration files, but when writing scripts or commands (in powershell, terminal, etc) users should remain aware. Also, logs and outputs referring to files will use the format appropriate to the system it is running on.
*'''Drive letters''' Drive letters like <code>D:</code> are specific to Windows. Configuration files that need to be usable across both systems should avoid their use and instead use relative paths like <code>../Model/Materials_001.csv</code> or absolute paths that assume the file is on the current drive like <code>/Project/model/Materials_001.csv</code>.
*'''Character case in names''' Windows is case-insensitive, which means that files called <code>Hello.TXT</code> and <code>hello.txt</code> are considered to have the same name, and cannot exist in the same location. Linux is case-sensitive and considers uppercase characters and lowercase characters to be different, and so those two files can exist side by side. This is very relevant if TUFLOW users use one spelling in one place, and the other in another - whereas Windows might interpret both references to point to the same file, on Linux they would result in two separate files. Similarly, if a file's name is spelled with different case from its actual name, a Windows application would find it, and a Linux application might not. (see below)
*'''Encoding and special characters''' On older versions of Windows in English-speaking countries, text files (including TUFLOW configuration files) would use the 1252-Windows encoding. In modern versions of Windows, UTF-8 with BOM is the standard. On Linux UTF-8 without BOM is the standard. TUFLOW accepts any of these encodings and will typically write files in UTF-8 without BOM. On Windows, line endings in such text files are encoded as two characters, a carriage return and a line feed (CR/LF), while Linux uses only a single LF. TUFLOW accepts both forms and writes what is appropriate to the system it is running on.
</ol>

To ensure maximum compatibility of models across systems, TUFLOW will do its best to match names in the model files in the same way between Windows and Linux. 

As a general principle, TUFLOW will default to trying to run a model with as little change as possible required across both platforms, writing results in a form that is appropriate to the platform it runs on. 

= Common Questions Answered (FAQ)=
== Why use TUFLOW on Linux at all? ==
TUFLOW on Linux is not just for users that use Linux as their primary work environment, although those certainly exist. Other reasons to consider are:
<ol>
*'''Performance''' Servers or workstations that are dedicated for the running of models can be configured to run TUFLOW and the necessary supporting software (e.g. CodeMeter, NVIDIA GPU drivers, etc.) and very little else, using Linux. There may also be small performance differences in general between an executable built and optimised for Windows or Linux.
*'''Infrastructure cost''' Especially relevant when running virtual machines dedicated to running TUFLOW, or many of those in the cloud, most distributions of Linux do not require a licence whereas Windows does. This can substantially reduce the cost of infrastructure.
*'''HPC tooling''' Automation of running TUFLOW models across many computers or in the cloud can be greatly simplified with tooling designed for that purpose. Many such tools are available "off the shelf", but mostly on Linux (e.g. SLURM, PBS/Torque, etc.). Similarly, containerisation (e.g. Docker, Podman, LXC) typically requires running on Linux as well.
: ''Note:'' HPC tooling refers to job scheduling and automation software for managing large numbers of model runs. Containerisation packages applications and their dependencies into portable and reproducible runtime environments.
</ol>

== Must TUFLOW users on Linux use the command line interface? ==
Linux offers a variety of desktop environments and TUFLOW can be used from those just like users would using Microsoft Windows. However, in either case TUFLOW itself is always running as a so-called console application and that makes it uniquely suited to running in lightweight non-graphical environments as well.

Like Windows, Linux offers a variety of scripting options that can help minimise the direct use of the command line by users, if that is desirable. Bash shell scripts are as easy to write and run as batch files are on Windows. Running Python or even PowerShell on Linux is easy to set up as well.

However, given the nature of the application and Linux as an operating system, TUFLOW users on Linux would do well to try and understand some of the basics of using TUFLOW from the command line and the TUFLOW Support team can assist with that.

ASC to ASC

2025-04-17T03:18:27Z

ElizaCollison: /* No Data Values */

=Introduction=
asc_to_asc.exe is a utility that can be used to perform a range of operations on gridded files. The input grids can be either ESRI ASCII grid (.asc) or binary float grids (.flt), both of which can be input and output from TUFLOW. 
This utility is useful for comparing and processing TUFLOW outputs from different .2dm meshes, which can't be compared with the [[RES_to_RES| res_to_res.exe]]. 
For some options (such as processing maximums or differences) the input (.asc or .flt) files must be of the same row/column dimensions. 
The inputs can be a combination of .asc and .flt grids and the -asc or -flt options can be used to set the output type. 
For a complete list to the operations available, please see the table of contents above.

=2023-03-AA (and later)=
This release incorporates new GIS/GRID formats included in the 2023-03-AA TUFLOW release. Some slight changes to the command line interface have been made to accomodate the new formats therefore please be aware that some of behaviour in 2023 release contradicts documentation presented elsewhere on this page (these are explicitly listed in [[#Changes_to_Old_Switches | Changes to Old Switches]] below). Where contradiction occurs, the behaviour listed here is the latest information and supersedes the behaviour listed elsewhere. 

The '''ASC_to_ASC-2023-03-AA''' release incorporates several new GIS formats - '''GeoTIFF''', '''GPKG''', '''NetCDF''' (note: NetCDF was previously supported but now has better integration with all operations). The commands are largely unchanged and now support input and output to a range of new formats.

The 2023-03-AA release also supports GPKG vector inputs e.g. for the <tt>"-brkline"</tt> operation. 
The 2023-09-AA release supports Cloud Optimised GeoTIFFs (COG) and overviews (pyramids) for GPKG rasters.

===New Switches===
The following switches are now supported: 
{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Switch
! style="background-color:#005581; font-weight:bold; color:white;" width=80% | Description
|-
|"-tif"||Output to GeoTIFF format
|-
|"-cog"||Output to Cloud Optimised GeoTIFF format (available since 2023-09-AA)
|-
|"-gpkg"||Output to GeoPackage format
|-
|"-nc"||Output to NetCDF format. Note: the old -nc command has been deprecated in the 2023-03-AA release. For backward compatibility the following command can be used instead <tt>"-conv -nc"</tt>
|-
|"-co"||Creation option switch. See [[#Creation_Options | Creation Options]] section below.
|}

===Changes to Old Switches===
* -nc - The <tt>"-nc"</tt> switch previously converted the input file to a NetCDF raster. The -nc switch now specifies that the output format should be NetCDF (for all operations). Use the following command to get the previous behaviour <tt>"-conv -nc"</tt>.
* -conv - The <tt>"-conv"</tt> switch now requires an output format to be specified (e.g. to convert from FLT to ASC use <tt>-conv -asc</tt>). Previously it would convert only between ASC and FLT and the output format was determined by the input format.

Another change in behaviour in the 2023 release is that the output format can also be specified by adding a supported extension when using the <tt>"-out [output_name.ext]"</tt> switch.

===GPKG and NetCDF===
GeoPackage and NetCDF are database formats and are able to contain multiple layers in a single file. When passing in an input or output reference to a GeoPackage or NetCDF file the layer name is assumed to be the same as the database name unless otherwise specified. To give the layer a different name than the database, use the following syntax <tt>"database.ext >> layer"</tt>: 
<pre>asc_to_asc.exe -dif "database.gpkg >> raster1" "database.gpkg >> raster2"</pre>
''Note:''
* ''quotes will always be required when using this syntax''
* ''wildcard expansion (i.e. * or ?) is not supported yet when using this syntax''
More notes on behaviour:
* GPKG output paths can be either a new or existing database i.e. the utility supports writing new layers into an existing database. NetCDF outputs do not support this yet and will overwrite any existing NetCDF file
* Typically outputs to the GPKG or NetCDF format will be grouped together into a single output file

===Creation Options===
The 2023 release supports GDAL style creation options. Creation options can be passed in using the <tt>"-co"</tt> flag then the name of the creation option and the value: 
<pre>-co COMPRESS=DEFLATE</pre>
Multiple creation options can be used (each will require its own -co flag). 
 
The creation options have adopted the same naming as GDAL (more information on the options can be found at [https://gdal.org https://gdal.org]) however not all options in GDAL are supported in the ASC_to_ASC.exe utility. The following creation options are supported in the ASC_to_ASC 2023-Beta: 
====GeoTIFF====
* COMPRESS=NONE/DEFLATE/LZW - output compression. Default - DEFLATE
* ZLEVEL=[0-9] - Compression level. Zero is no compression, 9 is hightest compression. Only supported for DEFLATE compression method. Default - 9
* PREDICTOR=1/2 - Compression predictor. Supported options are none [1] and horizontal differencing [2]. Default - 2.
* NUM_THREADS=[N]/ALL_CPUS - Number of threads to use when processing GeoTIFFs. Default - ALL_CPUS
* BIGTIFF=YES/NO/IF_NEEDED - Controls whether the ouput file uses the BigTIFF format or classic TIFF. Default - IF_NEEDED.
* TILED=YES/NO - Controls whether the output GeoTIFF should use tiles or strips. Default - NO.
* OVERVIEWS=YES/NO - Controls whether overviews (also known as pyramids) should be created. The ASC_to_ASC tool only supports internal overviews and therefore this option is only supported for tiled GeoTIFFs. Default - NO.

====Cloud Optimised GeoTIFF (COG)====
Same options as GeoTIFF however will automatically use 'TILED=YES' and 'OVERVIEWS=YES' creation options.

====GeoPackage====
* COMPRESS=NONE/LZW - output compression. Default - LZW
* PREDICTOR=1/2 - Compression predictor. Supported options are none [1] and horizontal differencing [2]. Default - 2.
* OVERVIEWS=YES/NO - Controls whether overviews (also known as pyramids) should be created. Default - NO.

====NetCDF====
* COMPRESS=NONE/DEFLATE- output compression. Default - DEFLATE
* ZLEVEL=[0-9] - Compression level. Zero is no compression, 9 is hightest compression. Only supported for DEFLATE compression method. Default - 9

====ASC====
* DECIMAL_PRECISION=N - The number of decimal places in the output. This option is analogous to the <tt>"-decimal[N]"</tt> switch. Default - 3

===Examples===
*Runs a difference operation on GeoTIFF outputs. 
:<tt>asc_to_asc.exe -diff proposed.tif existing.tif</tt>
* Runs a difference operation on GPKG outputs. The layer name needed is assumed to be the same as the database name. 
:<tt>asc_to_asc.exe -diff proposed.gpkg existing.gpkg</tt>
* Runs a difference operation on GeoPackage outputs where the layer name is different than the database name. 
:<tt>asc_to_asc.exe -diff "proposed_grid_results.gpkg >> proposed_max_h" "existing_grid_results.gpkg >> existing_max_h"</tt>
* Converts an ASC grid to a GeoTIFF with an LZW compression and horizontal predictor. 
:<tt>asc_to_asc.exe -conv -tif DEM_M01.asc -co COMPRESS=LZW -co PREDICTOR=2</tt>
* Runs a maximum operation on all FLT grids in a given location and outputs to a GeoPackage raster. 
:<tt>asc_to_asc.exe -max -out "output_grids.gpkg >> maximum_h" *.flt</tt>
* Converts GeoTIFF to a Cloud Optimised GeoTIFF. Requires <tt>-out</tt> flag since the extension for COG is also '.tif' and therefore the default output file would be the same as the input file. 
:<tt>asc_to_asc.exe -conv -cog DEM_M01.tif -out DEM_M01_COG.tif</tt>

=Operations=
==Convert==
'''"-conv"''' 
Converts between .flt and .asc format. For this operation the output file type is based on the input, for an input .asc file the output will be in .flt format. 
Examples: 
*Converts all .flt grids to .asc format. 
:<tt>asc_to_asc.exe -conv *.flt</tt>
*Converts the file "DEM_M01.asc" for .flt format. 
:<tt>asc_to_asc.exe -conv DEM_M01.asc</tt>

===No Data Values===

"-ndv <val>" 
An additional option to set the "no data value" is also possible when running the conversion function: <tt>-ndv <val></tt>. Note, this option will identify NaN values ("not a number") in the input grid, and treat them as no data values during the conversion (regardless of whether they are explicitly labelled as "no data values" in the grid header). This is useful if the user wants to remove all NaN values from the grid. Note, from the 2025.1 release and onwards, NaN's values in grid inputs are always treated as “no data values” and therefore grids can be read into TUFLOW directly without undertaking the below process.

*Converts asc to tif and sets the "no data value" to -999
:<tt>asc_to_asc.exe -conv -tif -ndv -999 DEM_M01.asc</tt>
*Removes all NaN values in a tif and replace them with -999
:<tt>asc_to_asc.exe -conv -tif -ndv -999 <input.tif> -out <output.tif></tt><nowiki>**</nowiki> 
<nowiki>**</nowiki> Note, in the above example it is important to specify an output name with <tt>-out</tt> when converting to the same format (e.g. tif to tif) as otherwise the output will overwrite the input. 

==Maximum==
'''"-max"''' 
Determines the maximum value in all the input .asc files. Two output grids are created: 
*A numerical grid containing the maximum value. 
*A classified grid with the name _src.asc which contains the source grid for the maximum value. 
Examples: 
*Creates a new grid containing the maximum of the 3 input water level grids. 
:<tt>asc_to_asc.exe -max Q100_30min_h.asc Q100_45min_h.asc Q100_60min_h.asc</tt> 
*As per item 2 above, but specifies the output name "Q100_Max_Levels.asc". 
:<tt>asc_to_asc.exe -out Q100_Max_Levels.asc -max Q100_30min_h.asc Q100_45min_h.asc Q100_60min_h.asc</tt> 
*Wildcard character "*" is supported in filenames. 
:<tt>asc_to_asc.exe -out Q100_Max_Levels.asc -max Q100_*min_h.asc</tt>

==Difference==
'''"-dif"''' 
Takes the difference between the first two .asc files, the second grid is subtracted from the first. If an optional third .asc file is specified, this is used as the output file, otherwise, asc_to_asc creates its own output filename using the names of the two input .asc files. The output is the first .asc file minus the second .asc file.
Two .asc grids are output:
*The first is the difference values between the two .asc files. A difference value only occurs at grid cells that have a value in both grids. If the cell has a null value (ie. the TUFLOW output was dry at that location) in either or both .asc grids, a null value is output.
*A second grid with a “_wd” suffix is output to indicate which .asc grid cells were once wet and are now dry (value -99) or once dry and are now wet (value +99 with first .asc to be the developed case and second .asc to be the existing case). Importing this grid into Vertical Mapper creates a .grc (grid classification) grid that has two categories: “Was Wet Now Dry” and “Was Dry Now Wet”. This grid is particularly useful for displaying areas that were previously inundated or previously flood-free. 
Example:
*Creates new grids comparing the differences in flood levels and extents for: "difference.asc" = "after_h.asc" - "before_h.asc" 
:<tt>asc_to_asc.exe -out difference.asc -dif after_h.asc before_h.asc</tt>

Secondary options (only one can be used):
*"-nowetdry" does not carry out a wet/dry test. If both cells are active a difference is calculated.
*"-change" calculates change even if one cell is null (wet / dry areas). Assumes a "dry" cell has a value of zero. Can be used to calculate depth change.

==Cutoff Depth==
'''"-cd<cutoff value>"''' 
Outputs a new file only where the value is greater than the cutoff value. 
*If only one grid is specified this grid is processed. 
*If two grids are specified, the first value is used for setting the cutoff depth and the values from the second grid are processed. 
*If three grids are specified, the third grid is used for setting the filename for the output grid. This is ignored if the "-out" option is used. 
Examples:
*Creates a new depth grid only where the depth is greater than 0.1m. 
:<tt>asc_to_asc.exe -cd0.1 depth.asc</tt>
*Creates a new level grid only where the depth is greater than 0.1m. 
:<tt>asc_to_asc.exe -cd0.1 depth.asc levels.asc</tt>
*As per the example above, but sets the output name as "filtered_levels.asc". 
:<tt>asc_to_asc.exe -cd0.1 -out filtered_levels.asc depths.asc levels.asc</tt>

==Resize==
'''"-resize<factor>"''' 
Resize the grid based on the factor above. The factor must be an integer (greater than 1). The output grid has the same origin (lower left) coordinates as the input grid. The new cell size is the factor times the old cell size. For example if a -resize5 is used on a 2m resolution grid the output grid will be 10m. For processing the grid three options are available:
===Average (default)===
This is the defualt processing method, which can also be specified with the '''-rm_avg''' (resize method - average) input flag. When processing for each tile in the new grid, the average of all non-null values in the input grid is taken. For example with a resize factor of 5, the 25 values in the input grid are averaged. 
Example:
*Creates a new 10m DEM (DEM_10m.asc) based on the the 2m DEM using an averaging approach. 
:<tt>asc_to_asc.exe -resize5 -out DEM_10m.asc DEM_2m.asc</tt>

===Minimum===
Alternative processing method for resize, specified with the '''-rm_min''' (resize method - minimum) flag. At each output grid the values is the minimum of the values in the input grid. 
Example:
*Creates a new 10m DEM (DEM_10m_min.asc) based on the the 2m DEM using an minimum approach. 
:<tt>asc_to_asc.exe -resize5 -rm_min -out DEM_10m_min.asc DEM_2m.asc</tt>

===Maximum===
Alternative processing method for resize, specified with the '''-rm_max''' (resize method - maximum) flag. At each output grid the values is the maximum of the values in the input grid. 
Example:
*Creates a new 10m DEM (DEM_10m_max.asc) based on the the 2m DEM using an maximum approach. 
:<tt>asc_to_asc.exe -resize5 -rm_max -out DEM_10m_max.asc DEM_2m.asc</tt>

==Transform==
Transforms the values using a simple y = mx + c approach the multiplier (m) is specified with flag '''-trans_m<value>'''. The add value (c)'''-trans_c<value>'''. Only one values is required to be specified. 
Examples:
*Multiplies all values by 0.3048. 
:<tt>asc_to_asc.exe -trans_m0.3048 DEM.asc</tt>
*Multiplies all values by 0.3048 and then adds 10.0. 
:<tt>asc_to_asc.exe -trans_m0.3048 -trans_c10 DEM.asc</tt>

==Decimal==
Converts .flt to .asc format with specified number of decimal spaces. ASC format created directly from TUFLOW comes only with three decimal spaces, FLT format has more decimal spaces. 
Example:
*Converts all .flt grids to .asc format with 5 decimal spaces. 
:<tt>asc_to_asc.exe -conv -decimal5 *.flt</tt>

==Classify==
Classifies the grid based on the input classifications. The output file is a classified .asc grid. The classification .csv file should have two columns cutoff value and name (in that order). The first line in .csv treated as a header line and ignored. Any values over the greatest cutoff with be outputted to class "above". 
{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Cutoff Value
! style="background-color:#005581; font-weight:bold; color:white;" width=50% | Name
|-
|0.5|| Less than 0.5
|-
|1.0|| 0.5 to 1.0
|-
|2.0|| 1.0 to 2.0
|}

Examples:
*Outputs a classified grid, based on the cut off values and names in the "classifications.csv". 
:<tt>asc_to_asc.exe -classify classifications.csv results_VMax.asc</tt>
*If using vertical mapper the -grc option can be used to create the .asc file in classified grid format, in this format rather than storing a numerical value when interrogating an area a label is returned. This format is not recognised by ArcMap or QGIS. If using the grc option it is also possible to specify the desired RGB (red, green, blue) values for the output grid in the .csv file used for the classification. The RGB values should be specified in the 3-5th columns of the .csv file. 
:<tt>asc_to_asc.exe -RGB -grc -classify depth_classify.csv results_dMax.asc</tt> 

:{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;" width=20% | Cutoff Value
! style="background-color:#005581; font-weight:bold; color:white;" width=20% | Name
! style="background-color:#005581; font-weight:bold; color:white;" width=20% | R
! style="background-color:#005581; font-weight:bold; color:white;" width=20% | G
! style="background-color:#005581; font-weight:bold; color:white;" width=20% | B
|-
|0.5|| Less than 0.5 || 0 || 0 || 192
|-
|1.0|| 0.5 to 1.0 || 0 || 0 || 128
|-
|2.0|| 1.0 to 2.0 || 0 || 0 || 64
|}

In the image below two grids are shown in MapInfo / Vertical Mapper, one is classified without the -grc option and a class number is returned for the grid. The second grid has been created with the -grc option shown, when querying this the label is returned instead. 
 
[[File:TUFLOW Utilities GRC01.jpeg|600px]] 
 

==Extract Breaklines from DEM==
'''"-brkline <gis file in 2d_zsh format>"''' 
This feature was added to the 2013-06-AA version of the utility. 
Extracts elevations from a DEM for breaklines in the 2d_zsh format. This GIS input should have four attributes, z, dz, width and shape_options, as described in the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. For the utility the '''dz''', '''shape_width''' and the '''shape_options''' are used. Valid shape_options are "Max" and "Min" or blank (average used). The utility will extract an elevation at each vertex along the line. 
Depending on the line width and DEM cell size, the following methods are used: 
* If the width is set to 0, the closest DEM value to the vertex is used. If a "shape_option" is specified this is ignored.
* If the width is greater than 0, but less than 1.5 times the DEM cell size, the four DEM values surrounding the vertex are used. If max or min is specified in the "shape_option" the max or min of the four values is used. If max or min option is not specified (attribute is blank), the average of the four values is used.
* If the width is greater than 1.5 times the DEM cell size, at each vertex a buffer region (search radius) is created and all non null DEM values within the buffer object are processed. The diameter of the buffer region is equal to the width specified. If max or min option is not specified, the average of the values within the region is used. These buffer regions are outputted as a separate file, if '''"-check"''' switch is specified in the batch command. 
If a '''dz''' value is specified this can be used to control the spacing of vertices along the line. If a '''dz''' value of 100 is specified the maximum spacing along the line is 100 (metres or feet), if the existing vertices along the line are greater than 100 (m or ft) apart additional vertices are inserted. The method for inserting additional vertices creates equally spaced vertices. For example, if two vertices along a line are spaced 250m apart and a dz attribute of 100m is specified three line segments of 83.3m will be created as opposed to two segments of 100m and one segment of 50m. 
'''NOTE:''' For the output GIS file, the '''dz''' attribute is set to 0.0 regardless of the value set in the input field. 
Example:
*<tt>asc_to_asc.exe -brkline 2d_zsh_breaklines_L.shp DEM.asc</tt>

==Fuzzy Map==
'''"-fuzzy <input grids>"''' 
This feature was added to the 2014-03-AB version of the utility. 
A fuzzy map can be used when comparing a large number of simulations. 
For each input grid (or scenario) the grid is classed as either 1 if the results grid is wet or 0 if dry. The total score for each grid cell is is calculated and then divided by the total number of input grids. A value of 1 indicates that the cell was wet in each simulation a value of 0 is dry in all simulations. Grids with a value of 0.5 are most sensitive. 
This can be useful for quantifying the sensitivity of the model to parameters. 
Example:
*Create a fuzzy map from all maximum depth grids in the directory. 
:<tt>asc_to_asc.exe -fuzzy *_d_Max.flt</tt>

==Histogram==
'''"-histogram bins.csv <input grid>"''' 
This feature was added to the 2014-03-AB version of the utility. 
Calculates the number of cells and percentage of cells that fall in each range. Requires and input .csv file containing the bin values. 
Examples:
*An example inputs bin file is: 
:{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Bin
! style="background-color:#005581; font-weight:bold; color:white;" width=50% | Label
|-
|0.25|| Less than 0.25
|-
|0.5|| 0.25 to 0.50
|-
|1.0|| 0.5 to 1.0
|-
|2.0|| 1.0 to 2.0
|-
|3.0|| 2.0 to 3.0
|-
|5.0|| 3.0 to 5.0
|}

*An example output looks like the below:
:{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Bin
! style="background-color:#005581; font-weight:bold; color:white;" width=25% | Label
! style="background-color:#005581; font-weight:bold; color:white;" width=25% | Count
! style="background-color:#005581; font-weight:bold; color:white;" width=25% | Percentage
|-
|0.25|| Less than 0.25 || 986,434 || 58.61
|-
|0.5|| 0.25 to 0.50 || 334,422 || 19.87
|-
|1.0|| 0.5 to 1.0 || 216,449 || 12.86
|-
|2.0|| 1.0 to 2.0 || 118,452 || 7.04
|-
|3.0|| 2.0 to 3.0 || 10,206 || 0.61
|-
|5.0|| 3.0 to 5.0 || 15,998 || 0.95
|-
|Above 5.0|| Above 5.0 || 973 || 0.06
|}
*Example usage:
:<tt>asc_to_asc_w64.exe –histogram histogram_bins.csv results_d_Max.asc</tt>

==Extract 1D Model Inputs==
'''"-egc control_file.egc"''' 
This allows 1D Network (1d_nwk) and/or 1D Cross-Sections to be extracted from a series of grids. 
A simple input file similar to the TUFLOW geometry control file is input into the utility. This is nominally given the extension .egc (Estry Geometry Control). 
 
Two input GIS layers can be used, these are the branch lines (channels) and cut lines (cross sections). The branch line is split into the 1d_nwk layer, a new 1D channel is created for each section. The GIS attributes of these are defined in the sections below.
===Branch Lines===
The branch lines are split into channels using the cross-section cut lines detailed below. A number of channel characteristics can be set for branch lines. The required attribute names and data types for branch line are as follows:
{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Attribute (type)
! style="background-color:#005581; font-weight:bold; color:white;" width=80% | Description
|-
|Name (character 10)|| Sets the branch name, unique chainage identifier is added to all output channels.
|-
|n_or_nF (float)|| Sets the output "n_or_nF" attribute for all output channels in the 1d_nwk layer.
|-
|UCS (float)|| Sets the "UCS" attribute for all output channels in the 1d_nwk layer.
|-
|FLC (float)|| Sets the "FLC" attribute for all output channels in the 1d_nwk layer. If a value of greater than 0 is specified the FLC is split between channels within the branch. For example if 0.5 is specified and the branch is split into 10 channels, each channel will have an output "Form_Loss" of 0.05.
|-
|ChanType (character 4)|| Sets the "Type" attribute for all output channels in the 1d_nwk layer. If left blank a default channel type of "S" is applied.
|}

===Cut Lines===
For each line in the cut line layer a cross-section will be extracted and output into .csv file format ready for use in TUFLOW. A number of cross section characteristics can be set for each cut line. The required attributes for the cross-section cut line are:
{| align="center" class="wikitable"
! style="background-color:#005581; font-weight:bold; color:white;"| Attribute (type)
! style="background-color:#005581; font-weight:bold; color:white;" width=80% | Description
|-
|Source (character 50)|| Optional output cross-section file name. If left blank the name and chainage of the branch the cross-section intersects is used.
|-
|Distance (float)|| Optional distance along the line for sampling from grids. If not specified the value specified in the .egc file is used.
|-
|Split (character 1)|| "T" (True) or "F" (False) for splitting the branch, set to false and the branch will not be split (used for centre sections)
|-
|Extract_XS (character 1)|| "T" (True) or "F" (False) for cross-section extraction. If set to "F" no cross-section is extracted for the cut line.
|-
|Extract_Method (character 50)|| Specify the method for extract the elevations from the grid (does not apply to Material grids). Options are: 
* Min
* Max
* Average (default)
|-
|Buffer_Method (character 50)|| Optional method for extracting the elevations from the grid (does not apply to Material grids) values from grid. Options are: 
* Point {default} - Value at the cross-section point is used.
* Buffer - circular buffer region around each cross-section point is created and elevation is extracted from this, using Min, Max or Average as described above.
* Perpendicular - A line perpendicular to section direction is used and elevation is extracted from this, using Min, Max or Average as described above. This can be useful if the section follows a hydraulic control (such as embankment) to ensure that the high / or low point is extracted.
|-
|Buffer_Distance (float)|| Sets the distance for when using the "Buffer" or "Perpendicular" methods above.
|}

===EGC commands===
The .egc file is read in a similar manner to the .tgc (TUFLOW geometry control) file. This file is read in a sequential order and for repeated commands the final one prevails. 
A full list of the availble .egc commands is detailed in the table below.
{| align="center" class="wikitable"
! style="background-color:#005581; font-weight:bold; color:white;"| Attribute (type)
! style="background-color:#005581; font-weight:bold; color:white;" width=70% | Description
|-
|Read GIS Branch == <1d_br GIS file>|| Reads the branch lines, these are described above.
|-
|Read GIS XS == <1d_cut GIS file>|| Reads the cross-section cut lines, these are described above.
|-
|Read GIS FLC == <GIS file>|| Optional GIS layer of polygons that can be used to specify form loss coefficients to the 1d_nwk layer. A single GIS (float) attribute is required. A FLC value of greater than 0 will be split between all 1d_nwk channels within the region. A FLC value of less than 0, will apply the absolute value to all channels within the polygon. For example if an FLC value of -0.1 is specified, all channels that fall within the polygon will have a form_loss attribute of 0.1. If a channel falls within multiple polygons, the form loss values will be added.
Reads the polygons off losses from GIS layer. cross-section cut lines, these are described above.
|-
|Set XS dx == <distance>|| Sets the default distance across section to extract elevations and materials data. This can be specified on the cut lines as detailed above.
|-
|Set XS Z == <elevation>|| Sets the elevation for all points in all cross-sections.
|-
|Set XS Mat == <Material ID>|| Sets the material ID for all points in all cross-sections.
|-
|Read Grid Z == <grid layer of elevations>|| Read elevations from DEM and assign this to all cross-section extraction points that fall within active DEM pixels.
|-
|Read Grid Mat == <grid layer of Material IDs>|| Read material IDs from raster grid and assign this to all cross-section extraction points that fall within active DEM pixels. This should be an integer grid.
|-
| Write XS == ON or '''OFF'''|| Turns on or off the writing of the 1d_xs layer. The default is off.
|-
| Write NWK == ON or '''OFF'''|| Turns on or off the writing of the 1d_nwk layer. The default is off.
|-
|Output XS == <output gis layer> || Sets the output GIS layer for the 1D cross-sections.
|-
|Output NWK == <output gis layer> || Sets the output GIS layer for the 1D channel cross-sections.
|-
|Output NWK == <output gis layer> || Sets the output GIS layer for the 1D channel cross-sections.
|-
|FLC per Unit Length == <form loss per unit length> || The form loss per unit length is written to the "exit_loss" attribute of all 1d_nwk channels.
|}
Example usage:
*<tt>asc_to_asc.exe -egc MR_1d_001.egc</tt>

An example .egc file is: 
<pre>
Read GIS Branch == 1d_br_MR_001.MIF
Read GIS XS == 1d_cut_MR_001.MIF
Output Nwk == 1d_nwk_MR_001.MIF
Output XS == 1d_xs_MR_001.MIF
Write NWK == ON !Write 1d_nwk layer
Write XS == ON !Write 1d_xs layer

Set XS dx == 5 !set default spacing, can be specified on xs or cut line

Set XS Mat == 1 !default Material ID of 1
Read Grid Mat == grid\grid_5m_2d_mat_MR_001.flt

Set XS Z == 99
Read Grid Z == grid\dem_5m_regional.flt
Read Grid Z == grid\dem_1m_bathymetry.flt
Read Grid Z == grid\dem_1m_survey.flt
</pre>

==Extract 1D Nodal Area Tables from Grid==
'''"-na <gis_region_file> <input grid>"''' 
Can be used to extract nodal-area (elevation-area) tables from a DEM, and output these in a .csv file format suitable for input into the 1D domain of a TUFLOW model. 
The input GIS region file should have the same attributes as the 1d_tab file format produced by TUFLOW. The first attribute ("Source" ) should contain a valid .csv file name. 
The out nodal area table extends from the minimum to the maximum elevation in the DEM. A user defined minimum value can be specified using the "Skew" attribute of the GIS region. 
Example usage:
*<tt>asc_to_asc.exe -na 1d_na_storage_R.shp DEM_1m.flt</tt>

==Calibration Points==
'''"-cp <cp_file>"''' 
For appending the value from a .asc or .flt file to a .mif or .shp file. The cp_file contains points representing locations where results are extracted from TUFLOW. The file format includes two attributes. The first attribute is a numeric field containing the recorded value. The second field is a char(100) text field containing the cp name. 
'''"-config <config_file>"''' (optional) 
Points to a csv file containing accuracy thresholds and style control options, e.g. symbol, colour and size. 
'''"-cpsd<sd>"''' (optional) 
The search radius for finding calibration points in meters. 
'''"-cpmm<mm>"''' (optional) 
The second search radius used to search for maximum and minimum values in meters. 
Example usage:
*<tt>asc_to_asc.exe -cp Flood_Marks.MIF -config diff_config.csv -cpsd100 -cpmm50 results_h_Max.asc</tt> 

==Statistics==
<big>'''"-stat<type>"'''</big>
As of the 2017-10-AA build, the ASC_to_ASC.exe utility allows the user to perform a number of statistical analyses on a group of input grids (*.flt or *.asc format). This is particularly useful when extracting information from assessments that produce multiple result files for a single event, for example, processing grids from an ensemble assessment with numerous temporal pattern arrangements.

The available options are:
* Median
* Mean
* Frac
* Min
* Max
* All
* Rank<integer id>

The below gives a description on each option as well as an example. It is also useful to consider using wildcards in the batch file to supplement typing out each input grid file individually. Several of the examples below utilise this ability to demonstrate how it can be done. 

==="-statMedian"===
The -statMedian flag outputs the median value at each grid cell from all the input grids. All the input grids are considered, regardless of if the grid cell is dry in some of the input grids (dry areas are still ranked as low e.g. Rank1, Rank2 and so on).

If the number of input grids is an even number, the median value is taken from the grid that is ranked ''n / 2 + 1'' (where n is the number of input grids). For example if the number of input grids is 10, at each grid cell the values are ranked lowest to highest (from 1 to 10). The result is taken from the 6th ranked grid. The median command outputs two grids:
* A value grid: the resulting median value
* An SRC grid: a grid listing which source input grid the median result value came from (a corresponding .csv file is also written as a legend) 
Example usage:
*<tt>asc_to_asc.exe -statMedian Q100_30min_TP1_h.asc Q100_30min_TP2_h.asc Q100_30min_TP3_h.asc Q100_30min_TP4_h.asc Q100_30min_TP5_h.asc</tt> 

[[File: asc_to_asc_statsMedian_eg.PNG|1000px|]] 
 
Note, the median value for that cell was dry (a 'NULL') value, then the output would be dry. For example, 7 out of the 10 inputs are dry at a particular location. Once they are ordered them (with NULL showing at the lowest), then the median value for this cell is 'NULL' (dry) and the source would be 8, as shown below. Therefore, at this location you would see a dry cell in the median output, and '8' in the source grid output.
 
[[File:A2A median.png|400px]] 
 

==="-statMean"===
The -statMean flag outputs the mean value at each grid cell. Unlike the median, the mean is only calculated at grid cells that are wet (that show flooding) in all input grids. Please note that the source grid is the next grid above the mean value. The mean command outputs two grids:
* A value grid: the resulting value
* An SRC grid: a grid listing which source input grid the result value came from or was the next above (a corresponding .csv file is also written as a legend) 
Example usage:
*<tt>asc_to_asc.exe -statMean Q100_30min_*_h.asc</tt> 

==="-statFrac"===
The -statFrac flag outputs a value at each grid cell that represents the fraction of the events that the grid cell is wet in. For example, if the number of input grids is 10, and a value of 0.2 is returned, this means this grid cell experienced flooding in 2 out of the 10 events. A value of 1.0 means that the grid cell was wet in all events.

The utility outputs one grid:
* A Frac grid: the resulting Fraction value 
Example usage:
*<tt>asc_to_asc.exe -statFrac Q100_30min_*_h.asc</tt> 

==="-statMin"===
The -statMin flag outputs the minimum value at each grid cell from all the input grids.

The utility outputs two grids:
* A value grid: the resulting value
* An SRC grid: a grid listing which source input grid the minimum result value came from (a corresponding .csv file is also written as a legend) 
Example usage:
*<tt>asc_to_asc.exe -statMin Q100_30min_*_h.asc</tt> 

==="-statMax"===
The -statMax flag outputs the maximum value at each grid cell from all the input grids. This flag is analogous with the [[#Maximum|-Max]] operation flag.

The utility outputs two grids:
* A value grid: the resulting value
* An SRC grid: a grid listing which source input grid the maximum result value came from (a corresponding .csv file is also written as a legend) 
Example usage:
*<tt>asc_to_asc.exe -statMax Q100_30min_*_h.asc</tt> 

==="-statAll"===
The -statAll flag undertakes and creates results for all the statistic operations mentioned above.

The utility outputs 9 grids:
* A median, mean, max, min and frac grid (as detailed above)
* An SRC grid: for the median, mean, min and max calculations (calculation of source grids as detailed above)
* A .csv file that contains the legend for all SRC grids 
Example usage:
*<tt>asc_to_asc.exe -statAll Q100_30min_*_h.asc</tt> 

==="-statRank<integer id>"===
The -statRank<integer> flag outputs the ''n<integer>'' ranked value at each grid cell from all the input grids. All the input grids are considered, regardless of if the grid cell is dry in some of the input grids (dry areas are still ranked as low e.g. Rank1, Rank2 and so on). For example, if the number of input grids is 10, at each grid cell the values are ranked lowest to highest (from 1 to 10). -statRank8 will output results taken from the 8th ranked grid. In this example, -statRank1 is equivalent to ''Min'', -statRank10 is equivalent to ''Max'', and -statRank6 is equivalent to ''Median''. The Rank flag allows additional functionality that lets users extract results in between those that are pre-programmed.

The utility outputs two grids:
* A value grid: the resulting value
* An SRC grid: a grid listing which source input grid the ranked result value came from (a corresponding .csv file is also written as a legend) 
Example usage:
*<tt>asc_to_asc.exe -statRank5 Q100_30min_*_h.asc</tt> 

==Flood Extent==
Returns a simple grid with value of 1 where the input grid has an active, non-zero value. 
Example usage:
*<tt>asc_to_asc.exe -fe results_dMax.asc</tt> 

==Remap==
Remap a water level grid to a higher resolution DEM. 
'''"-wl <wl_file>"''' 
Sets the coarser resolution water level grid to remap from. 
'''"-dem <dem_file>"''' 
Sets the finer resolution DEM. 
The default interpolation method is TIN. But "-idw_npt<number of points>" flag can be used to change the interpolation method to IDW and set the number of points used for IDW interpolation (default is 12). 
Examples:
*The utility can also remap additional map output grids (e.g. velocity, hazard and others) to the resolution of the DEM file, e.g. 
:<tt>asc_to_asc.exe -remap -wl lowres_h.asc -dem DEM_highres.asc</tt>
*The utility can also apply a buffer distance or add freeboard. For example, the below applies a buffer distance of 20m, and adds a freeboard of 0.2m to the original water level grid. 
:<tt>asc_to_asc.exe -remap -wl lowres_h.asc -dem DEM_highres.asc lowres_v.asc lowres_hazard.asc</tt>
:<tt>asc_to_asc.exe -remap -fb0.2 -bd20 -wl lowres_h.asc -dem DEM_highres.asc</tt>

Note that, for any output types other than depth, this utility does NOT interpolate the result from the coarser grid to the finer grid, but only extends/reduces the output extent to the dry/wet extent. More discussions on this function is documented here [[TUFLOW_Remapping | TUFLOW Remapping Tool]]. 

=Other Options (switches)=
A list of the general switches is provided in the table below, these are available for all operations listed above: 
{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Switch
! style="background-color:#005581; font-weight:bold; color:white;" width=80% | Description
|-
|"-b"|| Run the utility in batch mode, this suppresses the prompt to press enter at the end of processing. Used in .bat files where two or more files are to be processed. The -b flag should be placed after the asc_to_asc.exe call, before the function command. For example: <tt>asc_to_asc.exe -b -brkline 2d_zsh_breaklines_L.shp DEM.asc</tt> 
|-
|"-out <output grid name>"||Specify the output filename for the new grid. '''Note:''' a space is required between the -out and the filename.
|-
|"-flt"||Set the output grid format to binary float (.flt).
|-
|"-asc"||Set the output grid format to ESRI ascii format (.asc).
|-
|"-grc"||For use with the "-classify" option and .asc format output. This creates a classified grid (uses name rather than number). This is only valid if using Vertical Mapper, neither QGIS or ArcMap will recognise this format. This can also be used with the -RGB option to specify the output colouring of your grid.
|-
|"-check"||This creates check files for the data processing if applicable.
|-
|"-src"||For use with -min,-max or various stat options to supress the source grid output. Will only output the minimum, maximum, mean, median, frac grid. The src_legend.csv is also supressed.
|}
 

{{Tips Navigation
|uplink=[[TUFLOW_Utilities | Back to TUFLOW Utilities]]
}}

ASC to ASC

2025-04-17T03:17:42Z

ElizaCollison: /* No Data Values */

=Introduction=
asc_to_asc.exe is a utility that can be used to perform a range of operations on gridded files. The input grids can be either ESRI ASCII grid (.asc) or binary float grids (.flt), both of which can be input and output from TUFLOW. 
This utility is useful for comparing and processing TUFLOW outputs from different .2dm meshes, which can't be compared with the [[RES_to_RES| res_to_res.exe]]. 
For some options (such as processing maximums or differences) the input (.asc or .flt) files must be of the same row/column dimensions. 
The inputs can be a combination of .asc and .flt grids and the -asc or -flt options can be used to set the output type. 
For a complete list to the operations available, please see the table of contents above.

=2023-03-AA (and later)=
This release incorporates new GIS/GRID formats included in the 2023-03-AA TUFLOW release. Some slight changes to the command line interface have been made to accomodate the new formats therefore please be aware that some of behaviour in 2023 release contradicts documentation presented elsewhere on this page (these are explicitly listed in [[#Changes_to_Old_Switches | Changes to Old Switches]] below). Where contradiction occurs, the behaviour listed here is the latest information and supersedes the behaviour listed elsewhere. 

The '''ASC_to_ASC-2023-03-AA''' release incorporates several new GIS formats - '''GeoTIFF''', '''GPKG''', '''NetCDF''' (note: NetCDF was previously supported but now has better integration with all operations). The commands are largely unchanged and now support input and output to a range of new formats.

The 2023-03-AA release also supports GPKG vector inputs e.g. for the <tt>"-brkline"</tt> operation. 
The 2023-09-AA release supports Cloud Optimised GeoTIFFs (COG) and overviews (pyramids) for GPKG rasters.

===New Switches===
The following switches are now supported: 
{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Switch
! style="background-color:#005581; font-weight:bold; color:white;" width=80% | Description
|-
|"-tif"||Output to GeoTIFF format
|-
|"-cog"||Output to Cloud Optimised GeoTIFF format (available since 2023-09-AA)
|-
|"-gpkg"||Output to GeoPackage format
|-
|"-nc"||Output to NetCDF format. Note: the old -nc command has been deprecated in the 2023-03-AA release. For backward compatibility the following command can be used instead <tt>"-conv -nc"</tt>
|-
|"-co"||Creation option switch. See [[#Creation_Options | Creation Options]] section below.
|}

===Changes to Old Switches===
* -nc - The <tt>"-nc"</tt> switch previously converted the input file to a NetCDF raster. The -nc switch now specifies that the output format should be NetCDF (for all operations). Use the following command to get the previous behaviour <tt>"-conv -nc"</tt>.
* -conv - The <tt>"-conv"</tt> switch now requires an output format to be specified (e.g. to convert from FLT to ASC use <tt>-conv -asc</tt>). Previously it would convert only between ASC and FLT and the output format was determined by the input format.

Another change in behaviour in the 2023 release is that the output format can also be specified by adding a supported extension when using the <tt>"-out [output_name.ext]"</tt> switch.

===GPKG and NetCDF===
GeoPackage and NetCDF are database formats and are able to contain multiple layers in a single file. When passing in an input or output reference to a GeoPackage or NetCDF file the layer name is assumed to be the same as the database name unless otherwise specified. To give the layer a different name than the database, use the following syntax <tt>"database.ext >> layer"</tt>: 
<pre>asc_to_asc.exe -dif "database.gpkg >> raster1" "database.gpkg >> raster2"</pre>
''Note:''
* ''quotes will always be required when using this syntax''
* ''wildcard expansion (i.e. * or ?) is not supported yet when using this syntax''
More notes on behaviour:
* GPKG output paths can be either a new or existing database i.e. the utility supports writing new layers into an existing database. NetCDF outputs do not support this yet and will overwrite any existing NetCDF file
* Typically outputs to the GPKG or NetCDF format will be grouped together into a single output file

===Creation Options===
The 2023 release supports GDAL style creation options. Creation options can be passed in using the <tt>"-co"</tt> flag then the name of the creation option and the value: 
<pre>-co COMPRESS=DEFLATE</pre>
Multiple creation options can be used (each will require its own -co flag). 
 
The creation options have adopted the same naming as GDAL (more information on the options can be found at [https://gdal.org https://gdal.org]) however not all options in GDAL are supported in the ASC_to_ASC.exe utility. The following creation options are supported in the ASC_to_ASC 2023-Beta: 
====GeoTIFF====
* COMPRESS=NONE/DEFLATE/LZW - output compression. Default - DEFLATE
* ZLEVEL=[0-9] - Compression level. Zero is no compression, 9 is hightest compression. Only supported for DEFLATE compression method. Default - 9
* PREDICTOR=1/2 - Compression predictor. Supported options are none [1] and horizontal differencing [2]. Default - 2.
* NUM_THREADS=[N]/ALL_CPUS - Number of threads to use when processing GeoTIFFs. Default - ALL_CPUS
* BIGTIFF=YES/NO/IF_NEEDED - Controls whether the ouput file uses the BigTIFF format or classic TIFF. Default - IF_NEEDED.
* TILED=YES/NO - Controls whether the output GeoTIFF should use tiles or strips. Default - NO.
* OVERVIEWS=YES/NO - Controls whether overviews (also known as pyramids) should be created. The ASC_to_ASC tool only supports internal overviews and therefore this option is only supported for tiled GeoTIFFs. Default - NO.

====Cloud Optimised GeoTIFF (COG)====
Same options as GeoTIFF however will automatically use 'TILED=YES' and 'OVERVIEWS=YES' creation options.

====GeoPackage====
* COMPRESS=NONE/LZW - output compression. Default - LZW
* PREDICTOR=1/2 - Compression predictor. Supported options are none [1] and horizontal differencing [2]. Default - 2.
* OVERVIEWS=YES/NO - Controls whether overviews (also known as pyramids) should be created. Default - NO.

====NetCDF====
* COMPRESS=NONE/DEFLATE- output compression. Default - DEFLATE
* ZLEVEL=[0-9] - Compression level. Zero is no compression, 9 is hightest compression. Only supported for DEFLATE compression method. Default - 9

====ASC====
* DECIMAL_PRECISION=N - The number of decimal places in the output. This option is analogous to the <tt>"-decimal[N]"</tt> switch. Default - 3

===Examples===
*Runs a difference operation on GeoTIFF outputs. 
:<tt>asc_to_asc.exe -diff proposed.tif existing.tif</tt>
* Runs a difference operation on GPKG outputs. The layer name needed is assumed to be the same as the database name. 
:<tt>asc_to_asc.exe -diff proposed.gpkg existing.gpkg</tt>
* Runs a difference operation on GeoPackage outputs where the layer name is different than the database name. 
:<tt>asc_to_asc.exe -diff "proposed_grid_results.gpkg >> proposed_max_h" "existing_grid_results.gpkg >> existing_max_h"</tt>
* Converts an ASC grid to a GeoTIFF with an LZW compression and horizontal predictor. 
:<tt>asc_to_asc.exe -conv -tif DEM_M01.asc -co COMPRESS=LZW -co PREDICTOR=2</tt>
* Runs a maximum operation on all FLT grids in a given location and outputs to a GeoPackage raster. 
:<tt>asc_to_asc.exe -max -out "output_grids.gpkg >> maximum_h" *.flt</tt>
* Converts GeoTIFF to a Cloud Optimised GeoTIFF. Requires <tt>-out</tt> flag since the extension for COG is also '.tif' and therefore the default output file would be the same as the input file. 
:<tt>asc_to_asc.exe -conv -cog DEM_M01.tif -out DEM_M01_COG.tif</tt>

=Operations=
==Convert==
'''"-conv"''' 
Converts between .flt and .asc format. For this operation the output file type is based on the input, for an input .asc file the output will be in .flt format. 
Examples: 
*Converts all .flt grids to .asc format. 
:<tt>asc_to_asc.exe -conv *.flt</tt>
*Converts the file "DEM_M01.asc" for .flt format. 
:<tt>asc_to_asc.exe -conv DEM_M01.asc</tt>

===No Data Values===

"-ndv <val>" 
An additional option to set the "no data value" is also possible when running the conversion function: <tt>-ndv <val></tt>. Note, this option will identify NaN values ("not a number") in the input grid, and treat them as no data values during the conversion (regardless of whether they are explicitly labelled as "no data values" in the grid header). This is useful if the user wants to remove all NaN values from the grid.

*Converts asc to tif and sets the "no data value" to -999
:<tt>asc_to_asc.exe -conv -tif -ndv -999 DEM_M01.asc</tt>
*Removes all NaN values in a tif and replace them with -999
:<tt>asc_to_asc.exe -conv -tif -ndv -999 <input.tif> -out <output.tif></tt><nowiki>**</nowiki> 
<nowiki>**</nowiki> Note, in the above example it is important to specify an output name with <tt>-out</tt> when converting to the same format (e.g. tif to tif) as otherwise the output will overwrite the input. 
<nowiki>**</nowiki> Note, from the 2025.1 release and onwards, NaN's values in grid inputs are always treated as “no data values” and therefore grids can be read into TUFLOW directly without undertaking the above process.

==Maximum==
'''"-max"''' 
Determines the maximum value in all the input .asc files. Two output grids are created: 
*A numerical grid containing the maximum value. 
*A classified grid with the name _src.asc which contains the source grid for the maximum value. 
Examples: 
*Creates a new grid containing the maximum of the 3 input water level grids. 
:<tt>asc_to_asc.exe -max Q100_30min_h.asc Q100_45min_h.asc Q100_60min_h.asc</tt> 
*As per item 2 above, but specifies the output name "Q100_Max_Levels.asc". 
:<tt>asc_to_asc.exe -out Q100_Max_Levels.asc -max Q100_30min_h.asc Q100_45min_h.asc Q100_60min_h.asc</tt> 
*Wildcard character "*" is supported in filenames. 
:<tt>asc_to_asc.exe -out Q100_Max_Levels.asc -max Q100_*min_h.asc</tt>

==Difference==
'''"-dif"''' 
Takes the difference between the first two .asc files, the second grid is subtracted from the first. If an optional third .asc file is specified, this is used as the output file, otherwise, asc_to_asc creates its own output filename using the names of the two input .asc files. The output is the first .asc file minus the second .asc file.
Two .asc grids are output:
*The first is the difference values between the two .asc files. A difference value only occurs at grid cells that have a value in both grids. If the cell has a null value (ie. the TUFLOW output was dry at that location) in either or both .asc grids, a null value is output.
*A second grid with a “_wd” suffix is output to indicate which .asc grid cells were once wet and are now dry (value -99) or once dry and are now wet (value +99 with first .asc to be the developed case and second .asc to be the existing case). Importing this grid into Vertical Mapper creates a .grc (grid classification) grid that has two categories: “Was Wet Now Dry” and “Was Dry Now Wet”. This grid is particularly useful for displaying areas that were previously inundated or previously flood-free. 
Example:
*Creates new grids comparing the differences in flood levels and extents for: "difference.asc" = "after_h.asc" - "before_h.asc" 
:<tt>asc_to_asc.exe -out difference.asc -dif after_h.asc before_h.asc</tt>

Secondary options (only one can be used):
*"-nowetdry" does not carry out a wet/dry test. If both cells are active a difference is calculated.
*"-change" calculates change even if one cell is null (wet / dry areas). Assumes a "dry" cell has a value of zero. Can be used to calculate depth change.

==Cutoff Depth==
'''"-cd<cutoff value>"''' 
Outputs a new file only where the value is greater than the cutoff value. 
*If only one grid is specified this grid is processed. 
*If two grids are specified, the first value is used for setting the cutoff depth and the values from the second grid are processed. 
*If three grids are specified, the third grid is used for setting the filename for the output grid. This is ignored if the "-out" option is used. 
Examples:
*Creates a new depth grid only where the depth is greater than 0.1m. 
:<tt>asc_to_asc.exe -cd0.1 depth.asc</tt>
*Creates a new level grid only where the depth is greater than 0.1m. 
:<tt>asc_to_asc.exe -cd0.1 depth.asc levels.asc</tt>
*As per the example above, but sets the output name as "filtered_levels.asc". 
:<tt>asc_to_asc.exe -cd0.1 -out filtered_levels.asc depths.asc levels.asc</tt>

==Resize==
'''"-resize<factor>"''' 
Resize the grid based on the factor above. The factor must be an integer (greater than 1). The output grid has the same origin (lower left) coordinates as the input grid. The new cell size is the factor times the old cell size. For example if a -resize5 is used on a 2m resolution grid the output grid will be 10m. For processing the grid three options are available:
===Average (default)===
This is the defualt processing method, which can also be specified with the '''-rm_avg''' (resize method - average) input flag. When processing for each tile in the new grid, the average of all non-null values in the input grid is taken. For example with a resize factor of 5, the 25 values in the input grid are averaged. 
Example:
*Creates a new 10m DEM (DEM_10m.asc) based on the the 2m DEM using an averaging approach. 
:<tt>asc_to_asc.exe -resize5 -out DEM_10m.asc DEM_2m.asc</tt>

===Minimum===
Alternative processing method for resize, specified with the '''-rm_min''' (resize method - minimum) flag. At each output grid the values is the minimum of the values in the input grid. 
Example:
*Creates a new 10m DEM (DEM_10m_min.asc) based on the the 2m DEM using an minimum approach. 
:<tt>asc_to_asc.exe -resize5 -rm_min -out DEM_10m_min.asc DEM_2m.asc</tt>

===Maximum===
Alternative processing method for resize, specified with the '''-rm_max''' (resize method - maximum) flag. At each output grid the values is the maximum of the values in the input grid. 
Example:
*Creates a new 10m DEM (DEM_10m_max.asc) based on the the 2m DEM using an maximum approach. 
:<tt>asc_to_asc.exe -resize5 -rm_max -out DEM_10m_max.asc DEM_2m.asc</tt>

==Transform==
Transforms the values using a simple y = mx + c approach the multiplier (m) is specified with flag '''-trans_m<value>'''. The add value (c)'''-trans_c<value>'''. Only one values is required to be specified. 
Examples:
*Multiplies all values by 0.3048. 
:<tt>asc_to_asc.exe -trans_m0.3048 DEM.asc</tt>
*Multiplies all values by 0.3048 and then adds 10.0. 
:<tt>asc_to_asc.exe -trans_m0.3048 -trans_c10 DEM.asc</tt>

==Decimal==
Converts .flt to .asc format with specified number of decimal spaces. ASC format created directly from TUFLOW comes only with three decimal spaces, FLT format has more decimal spaces. 
Example:
*Converts all .flt grids to .asc format with 5 decimal spaces. 
:<tt>asc_to_asc.exe -conv -decimal5 *.flt</tt>

==Classify==
Classifies the grid based on the input classifications. The output file is a classified .asc grid. The classification .csv file should have two columns cutoff value and name (in that order). The first line in .csv treated as a header line and ignored. Any values over the greatest cutoff with be outputted to class "above". 
{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Cutoff Value
! style="background-color:#005581; font-weight:bold; color:white;" width=50% | Name
|-
|0.5|| Less than 0.5
|-
|1.0|| 0.5 to 1.0
|-
|2.0|| 1.0 to 2.0
|}

Examples:
*Outputs a classified grid, based on the cut off values and names in the "classifications.csv". 
:<tt>asc_to_asc.exe -classify classifications.csv results_VMax.asc</tt>
*If using vertical mapper the -grc option can be used to create the .asc file in classified grid format, in this format rather than storing a numerical value when interrogating an area a label is returned. This format is not recognised by ArcMap or QGIS. If using the grc option it is also possible to specify the desired RGB (red, green, blue) values for the output grid in the .csv file used for the classification. The RGB values should be specified in the 3-5th columns of the .csv file. 
:<tt>asc_to_asc.exe -RGB -grc -classify depth_classify.csv results_dMax.asc</tt> 

:{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;" width=20% | Cutoff Value
! style="background-color:#005581; font-weight:bold; color:white;" width=20% | Name
! style="background-color:#005581; font-weight:bold; color:white;" width=20% | R
! style="background-color:#005581; font-weight:bold; color:white;" width=20% | G
! style="background-color:#005581; font-weight:bold; color:white;" width=20% | B
|-
|0.5|| Less than 0.5 || 0 || 0 || 192
|-
|1.0|| 0.5 to 1.0 || 0 || 0 || 128
|-
|2.0|| 1.0 to 2.0 || 0 || 0 || 64
|}

In the image below two grids are shown in MapInfo / Vertical Mapper, one is classified without the -grc option and a class number is returned for the grid. The second grid has been created with the -grc option shown, when querying this the label is returned instead. 
 
[[File:TUFLOW Utilities GRC01.jpeg|600px]] 
 

==Extract Breaklines from DEM==
'''"-brkline <gis file in 2d_zsh format>"''' 
This feature was added to the 2013-06-AA version of the utility. 
Extracts elevations from a DEM for breaklines in the 2d_zsh format. This GIS input should have four attributes, z, dz, width and shape_options, as described in the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. For the utility the '''dz''', '''shape_width''' and the '''shape_options''' are used. Valid shape_options are "Max" and "Min" or blank (average used). The utility will extract an elevation at each vertex along the line. 
Depending on the line width and DEM cell size, the following methods are used: 
* If the width is set to 0, the closest DEM value to the vertex is used. If a "shape_option" is specified this is ignored.
* If the width is greater than 0, but less than 1.5 times the DEM cell size, the four DEM values surrounding the vertex are used. If max or min is specified in the "shape_option" the max or min of the four values is used. If max or min option is not specified (attribute is blank), the average of the four values is used.
* If the width is greater than 1.5 times the DEM cell size, at each vertex a buffer region (search radius) is created and all non null DEM values within the buffer object are processed. The diameter of the buffer region is equal to the width specified. If max or min option is not specified, the average of the values within the region is used. These buffer regions are outputted as a separate file, if '''"-check"''' switch is specified in the batch command. 
If a '''dz''' value is specified this can be used to control the spacing of vertices along the line. If a '''dz''' value of 100 is specified the maximum spacing along the line is 100 (metres or feet), if the existing vertices along the line are greater than 100 (m or ft) apart additional vertices are inserted. The method for inserting additional vertices creates equally spaced vertices. For example, if two vertices along a line are spaced 250m apart and a dz attribute of 100m is specified three line segments of 83.3m will be created as opposed to two segments of 100m and one segment of 50m. 
'''NOTE:''' For the output GIS file, the '''dz''' attribute is set to 0.0 regardless of the value set in the input field. 
Example:
*<tt>asc_to_asc.exe -brkline 2d_zsh_breaklines_L.shp DEM.asc</tt>

==Fuzzy Map==
'''"-fuzzy <input grids>"''' 
This feature was added to the 2014-03-AB version of the utility. 
A fuzzy map can be used when comparing a large number of simulations. 
For each input grid (or scenario) the grid is classed as either 1 if the results grid is wet or 0 if dry. The total score for each grid cell is is calculated and then divided by the total number of input grids. A value of 1 indicates that the cell was wet in each simulation a value of 0 is dry in all simulations. Grids with a value of 0.5 are most sensitive. 
This can be useful for quantifying the sensitivity of the model to parameters. 
Example:
*Create a fuzzy map from all maximum depth grids in the directory. 
:<tt>asc_to_asc.exe -fuzzy *_d_Max.flt</tt>

==Histogram==
'''"-histogram bins.csv <input grid>"''' 
This feature was added to the 2014-03-AB version of the utility. 
Calculates the number of cells and percentage of cells that fall in each range. Requires and input .csv file containing the bin values. 
Examples:
*An example inputs bin file is: 
:{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Bin
! style="background-color:#005581; font-weight:bold; color:white;" width=50% | Label
|-
|0.25|| Less than 0.25
|-
|0.5|| 0.25 to 0.50
|-
|1.0|| 0.5 to 1.0
|-
|2.0|| 1.0 to 2.0
|-
|3.0|| 2.0 to 3.0
|-
|5.0|| 3.0 to 5.0
|}

*An example output looks like the below:
:{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Bin
! style="background-color:#005581; font-weight:bold; color:white;" width=25% | Label
! style="background-color:#005581; font-weight:bold; color:white;" width=25% | Count
! style="background-color:#005581; font-weight:bold; color:white;" width=25% | Percentage
|-
|0.25|| Less than 0.25 || 986,434 || 58.61
|-
|0.5|| 0.25 to 0.50 || 334,422 || 19.87
|-
|1.0|| 0.5 to 1.0 || 216,449 || 12.86
|-
|2.0|| 1.0 to 2.0 || 118,452 || 7.04
|-
|3.0|| 2.0 to 3.0 || 10,206 || 0.61
|-
|5.0|| 3.0 to 5.0 || 15,998 || 0.95
|-
|Above 5.0|| Above 5.0 || 973 || 0.06
|}
*Example usage:
:<tt>asc_to_asc_w64.exe –histogram histogram_bins.csv results_d_Max.asc</tt>

==Extract 1D Model Inputs==
'''"-egc control_file.egc"''' 
This allows 1D Network (1d_nwk) and/or 1D Cross-Sections to be extracted from a series of grids. 
A simple input file similar to the TUFLOW geometry control file is input into the utility. This is nominally given the extension .egc (Estry Geometry Control). 
 
Two input GIS layers can be used, these are the branch lines (channels) and cut lines (cross sections). The branch line is split into the 1d_nwk layer, a new 1D channel is created for each section. The GIS attributes of these are defined in the sections below.
===Branch Lines===
The branch lines are split into channels using the cross-section cut lines detailed below. A number of channel characteristics can be set for branch lines. The required attribute names and data types for branch line are as follows:
{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Attribute (type)
! style="background-color:#005581; font-weight:bold; color:white;" width=80% | Description
|-
|Name (character 10)|| Sets the branch name, unique chainage identifier is added to all output channels.
|-
|n_or_nF (float)|| Sets the output "n_or_nF" attribute for all output channels in the 1d_nwk layer.
|-
|UCS (float)|| Sets the "UCS" attribute for all output channels in the 1d_nwk layer.
|-
|FLC (float)|| Sets the "FLC" attribute for all output channels in the 1d_nwk layer. If a value of greater than 0 is specified the FLC is split between channels within the branch. For example if 0.5 is specified and the branch is split into 10 channels, each channel will have an output "Form_Loss" of 0.05.
|-
|ChanType (character 4)|| Sets the "Type" attribute for all output channels in the 1d_nwk layer. If left blank a default channel type of "S" is applied.
|}

===Cut Lines===
For each line in the cut line layer a cross-section will be extracted and output into .csv file format ready for use in TUFLOW. A number of cross section characteristics can be set for each cut line. The required attributes for the cross-section cut line are:
{| align="center" class="wikitable"
! style="background-color:#005581; font-weight:bold; color:white;"| Attribute (type)
! style="background-color:#005581; font-weight:bold; color:white;" width=80% | Description
|-
|Source (character 50)|| Optional output cross-section file name. If left blank the name and chainage of the branch the cross-section intersects is used.
|-
|Distance (float)|| Optional distance along the line for sampling from grids. If not specified the value specified in the .egc file is used.
|-
|Split (character 1)|| "T" (True) or "F" (False) for splitting the branch, set to false and the branch will not be split (used for centre sections)
|-
|Extract_XS (character 1)|| "T" (True) or "F" (False) for cross-section extraction. If set to "F" no cross-section is extracted for the cut line.
|-
|Extract_Method (character 50)|| Specify the method for extract the elevations from the grid (does not apply to Material grids). Options are: 
* Min
* Max
* Average (default)
|-
|Buffer_Method (character 50)|| Optional method for extracting the elevations from the grid (does not apply to Material grids) values from grid. Options are: 
* Point {default} - Value at the cross-section point is used.
* Buffer - circular buffer region around each cross-section point is created and elevation is extracted from this, using Min, Max or Average as described above.
* Perpendicular - A line perpendicular to section direction is used and elevation is extracted from this, using Min, Max or Average as described above. This can be useful if the section follows a hydraulic control (such as embankment) to ensure that the high / or low point is extracted.
|-
|Buffer_Distance (float)|| Sets the distance for when using the "Buffer" or "Perpendicular" methods above.
|}

===EGC commands===
The .egc file is read in a similar manner to the .tgc (TUFLOW geometry control) file. This file is read in a sequential order and for repeated commands the final one prevails. 
A full list of the availble .egc commands is detailed in the table below.
{| align="center" class="wikitable"
! style="background-color:#005581; font-weight:bold; color:white;"| Attribute (type)
! style="background-color:#005581; font-weight:bold; color:white;" width=70% | Description
|-
|Read GIS Branch == <1d_br GIS file>|| Reads the branch lines, these are described above.
|-
|Read GIS XS == <1d_cut GIS file>|| Reads the cross-section cut lines, these are described above.
|-
|Read GIS FLC == <GIS file>|| Optional GIS layer of polygons that can be used to specify form loss coefficients to the 1d_nwk layer. A single GIS (float) attribute is required. A FLC value of greater than 0 will be split between all 1d_nwk channels within the region. A FLC value of less than 0, will apply the absolute value to all channels within the polygon. For example if an FLC value of -0.1 is specified, all channels that fall within the polygon will have a form_loss attribute of 0.1. If a channel falls within multiple polygons, the form loss values will be added.
Reads the polygons off losses from GIS layer. cross-section cut lines, these are described above.
|-
|Set XS dx == <distance>|| Sets the default distance across section to extract elevations and materials data. This can be specified on the cut lines as detailed above.
|-
|Set XS Z == <elevation>|| Sets the elevation for all points in all cross-sections.
|-
|Set XS Mat == <Material ID>|| Sets the material ID for all points in all cross-sections.
|-
|Read Grid Z == <grid layer of elevations>|| Read elevations from DEM and assign this to all cross-section extraction points that fall within active DEM pixels.
|-
|Read Grid Mat == <grid layer of Material IDs>|| Read material IDs from raster grid and assign this to all cross-section extraction points that fall within active DEM pixels. This should be an integer grid.
|-
| Write XS == ON or '''OFF'''|| Turns on or off the writing of the 1d_xs layer. The default is off.
|-
| Write NWK == ON or '''OFF'''|| Turns on or off the writing of the 1d_nwk layer. The default is off.
|-
|Output XS == <output gis layer> || Sets the output GIS layer for the 1D cross-sections.
|-
|Output NWK == <output gis layer> || Sets the output GIS layer for the 1D channel cross-sections.
|-
|Output NWK == <output gis layer> || Sets the output GIS layer for the 1D channel cross-sections.
|-
|FLC per Unit Length == <form loss per unit length> || The form loss per unit length is written to the "exit_loss" attribute of all 1d_nwk channels.
|}
Example usage:
*<tt>asc_to_asc.exe -egc MR_1d_001.egc</tt>

An example .egc file is: 
<pre>
Read GIS Branch == 1d_br_MR_001.MIF
Read GIS XS == 1d_cut_MR_001.MIF
Output Nwk == 1d_nwk_MR_001.MIF
Output XS == 1d_xs_MR_001.MIF
Write NWK == ON !Write 1d_nwk layer
Write XS == ON !Write 1d_xs layer

Set XS dx == 5 !set default spacing, can be specified on xs or cut line

Set XS Mat == 1 !default Material ID of 1
Read Grid Mat == grid\grid_5m_2d_mat_MR_001.flt

Set XS Z == 99
Read Grid Z == grid\dem_5m_regional.flt
Read Grid Z == grid\dem_1m_bathymetry.flt
Read Grid Z == grid\dem_1m_survey.flt
</pre>

==Extract 1D Nodal Area Tables from Grid==
'''"-na <gis_region_file> <input grid>"''' 
Can be used to extract nodal-area (elevation-area) tables from a DEM, and output these in a .csv file format suitable for input into the 1D domain of a TUFLOW model. 
The input GIS region file should have the same attributes as the 1d_tab file format produced by TUFLOW. The first attribute ("Source" ) should contain a valid .csv file name. 
The out nodal area table extends from the minimum to the maximum elevation in the DEM. A user defined minimum value can be specified using the "Skew" attribute of the GIS region. 
Example usage:
*<tt>asc_to_asc.exe -na 1d_na_storage_R.shp DEM_1m.flt</tt>

==Calibration Points==
'''"-cp <cp_file>"''' 
For appending the value from a .asc or .flt file to a .mif or .shp file. The cp_file contains points representing locations where results are extracted from TUFLOW. The file format includes two attributes. The first attribute is a numeric field containing the recorded value. The second field is a char(100) text field containing the cp name. 
'''"-config <config_file>"''' (optional) 
Points to a csv file containing accuracy thresholds and style control options, e.g. symbol, colour and size. 
'''"-cpsd<sd>"''' (optional) 
The search radius for finding calibration points in meters. 
'''"-cpmm<mm>"''' (optional) 
The second search radius used to search for maximum and minimum values in meters. 
Example usage:
*<tt>asc_to_asc.exe -cp Flood_Marks.MIF -config diff_config.csv -cpsd100 -cpmm50 results_h_Max.asc</tt> 

==Statistics==
<big>'''"-stat<type>"'''</big>
As of the 2017-10-AA build, the ASC_to_ASC.exe utility allows the user to perform a number of statistical analyses on a group of input grids (*.flt or *.asc format). This is particularly useful when extracting information from assessments that produce multiple result files for a single event, for example, processing grids from an ensemble assessment with numerous temporal pattern arrangements.

The available options are:
* Median
* Mean
* Frac
* Min
* Max
* All
* Rank<integer id>

The below gives a description on each option as well as an example. It is also useful to consider using wildcards in the batch file to supplement typing out each input grid file individually. Several of the examples below utilise this ability to demonstrate how it can be done. 

==="-statMedian"===
The -statMedian flag outputs the median value at each grid cell from all the input grids. All the input grids are considered, regardless of if the grid cell is dry in some of the input grids (dry areas are still ranked as low e.g. Rank1, Rank2 and so on).

If the number of input grids is an even number, the median value is taken from the grid that is ranked ''n / 2 + 1'' (where n is the number of input grids). For example if the number of input grids is 10, at each grid cell the values are ranked lowest to highest (from 1 to 10). The result is taken from the 6th ranked grid. The median command outputs two grids:
* A value grid: the resulting median value
* An SRC grid: a grid listing which source input grid the median result value came from (a corresponding .csv file is also written as a legend) 
Example usage:
*<tt>asc_to_asc.exe -statMedian Q100_30min_TP1_h.asc Q100_30min_TP2_h.asc Q100_30min_TP3_h.asc Q100_30min_TP4_h.asc Q100_30min_TP5_h.asc</tt> 

[[File: asc_to_asc_statsMedian_eg.PNG|1000px|]] 
 
Note, the median value for that cell was dry (a 'NULL') value, then the output would be dry. For example, 7 out of the 10 inputs are dry at a particular location. Once they are ordered them (with NULL showing at the lowest), then the median value for this cell is 'NULL' (dry) and the source would be 8, as shown below. Therefore, at this location you would see a dry cell in the median output, and '8' in the source grid output.
 
[[File:A2A median.png|400px]] 
 

==="-statMean"===
The -statMean flag outputs the mean value at each grid cell. Unlike the median, the mean is only calculated at grid cells that are wet (that show flooding) in all input grids. Please note that the source grid is the next grid above the mean value. The mean command outputs two grids:
* A value grid: the resulting value
* An SRC grid: a grid listing which source input grid the result value came from or was the next above (a corresponding .csv file is also written as a legend) 
Example usage:
*<tt>asc_to_asc.exe -statMean Q100_30min_*_h.asc</tt> 

==="-statFrac"===
The -statFrac flag outputs a value at each grid cell that represents the fraction of the events that the grid cell is wet in. For example, if the number of input grids is 10, and a value of 0.2 is returned, this means this grid cell experienced flooding in 2 out of the 10 events. A value of 1.0 means that the grid cell was wet in all events.

The utility outputs one grid:
* A Frac grid: the resulting Fraction value 
Example usage:
*<tt>asc_to_asc.exe -statFrac Q100_30min_*_h.asc</tt> 

==="-statMin"===
The -statMin flag outputs the minimum value at each grid cell from all the input grids.

The utility outputs two grids:
* A value grid: the resulting value
* An SRC grid: a grid listing which source input grid the minimum result value came from (a corresponding .csv file is also written as a legend) 
Example usage:
*<tt>asc_to_asc.exe -statMin Q100_30min_*_h.asc</tt> 

==="-statMax"===
The -statMax flag outputs the maximum value at each grid cell from all the input grids. This flag is analogous with the [[#Maximum|-Max]] operation flag.

The utility outputs two grids:
* A value grid: the resulting value
* An SRC grid: a grid listing which source input grid the maximum result value came from (a corresponding .csv file is also written as a legend) 
Example usage:
*<tt>asc_to_asc.exe -statMax Q100_30min_*_h.asc</tt> 

==="-statAll"===
The -statAll flag undertakes and creates results for all the statistic operations mentioned above.

The utility outputs 9 grids:
* A median, mean, max, min and frac grid (as detailed above)
* An SRC grid: for the median, mean, min and max calculations (calculation of source grids as detailed above)
* A .csv file that contains the legend for all SRC grids 
Example usage:
*<tt>asc_to_asc.exe -statAll Q100_30min_*_h.asc</tt> 

==="-statRank<integer id>"===
The -statRank<integer> flag outputs the ''n<integer>'' ranked value at each grid cell from all the input grids. All the input grids are considered, regardless of if the grid cell is dry in some of the input grids (dry areas are still ranked as low e.g. Rank1, Rank2 and so on). For example, if the number of input grids is 10, at each grid cell the values are ranked lowest to highest (from 1 to 10). -statRank8 will output results taken from the 8th ranked grid. In this example, -statRank1 is equivalent to ''Min'', -statRank10 is equivalent to ''Max'', and -statRank6 is equivalent to ''Median''. The Rank flag allows additional functionality that lets users extract results in between those that are pre-programmed.

The utility outputs two grids:
* A value grid: the resulting value
* An SRC grid: a grid listing which source input grid the ranked result value came from (a corresponding .csv file is also written as a legend) 
Example usage:
*<tt>asc_to_asc.exe -statRank5 Q100_30min_*_h.asc</tt> 

==Flood Extent==
Returns a simple grid with value of 1 where the input grid has an active, non-zero value. 
Example usage:
*<tt>asc_to_asc.exe -fe results_dMax.asc</tt> 

==Remap==
Remap a water level grid to a higher resolution DEM. 
'''"-wl <wl_file>"''' 
Sets the coarser resolution water level grid to remap from. 
'''"-dem <dem_file>"''' 
Sets the finer resolution DEM. 
The default interpolation method is TIN. But "-idw_npt<number of points>" flag can be used to change the interpolation method to IDW and set the number of points used for IDW interpolation (default is 12). 
Examples:
*The utility can also remap additional map output grids (e.g. velocity, hazard and others) to the resolution of the DEM file, e.g. 
:<tt>asc_to_asc.exe -remap -wl lowres_h.asc -dem DEM_highres.asc</tt>
*The utility can also apply a buffer distance or add freeboard. For example, the below applies a buffer distance of 20m, and adds a freeboard of 0.2m to the original water level grid. 
:<tt>asc_to_asc.exe -remap -wl lowres_h.asc -dem DEM_highres.asc lowres_v.asc lowres_hazard.asc</tt>
:<tt>asc_to_asc.exe -remap -fb0.2 -bd20 -wl lowres_h.asc -dem DEM_highres.asc</tt>

Note that, for any output types other than depth, this utility does NOT interpolate the result from the coarser grid to the finer grid, but only extends/reduces the output extent to the dry/wet extent. More discussions on this function is documented here [[TUFLOW_Remapping | TUFLOW Remapping Tool]]. 

=Other Options (switches)=
A list of the general switches is provided in the table below, these are available for all operations listed above: 
{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Switch
! style="background-color:#005581; font-weight:bold; color:white;" width=80% | Description
|-
|"-b"|| Run the utility in batch mode, this suppresses the prompt to press enter at the end of processing. Used in .bat files where two or more files are to be processed. The -b flag should be placed after the asc_to_asc.exe call, before the function command. For example: <tt>asc_to_asc.exe -b -brkline 2d_zsh_breaklines_L.shp DEM.asc</tt> 
|-
|"-out <output grid name>"||Specify the output filename for the new grid. '''Note:''' a space is required between the -out and the filename.
|-
|"-flt"||Set the output grid format to binary float (.flt).
|-
|"-asc"||Set the output grid format to ESRI ascii format (.asc).
|-
|"-grc"||For use with the "-classify" option and .asc format output. This creates a classified grid (uses name rather than number). This is only valid if using Vertical Mapper, neither QGIS or ArcMap will recognise this format. This can also be used with the -RGB option to specify the output colouring of your grid.
|-
|"-check"||This creates check files for the data processing if applicable.
|-
|"-src"||For use with -min,-max or various stat options to supress the source grid output. Will only output the minimum, maximum, mean, median, frac grid. The src_legend.csv is also supressed.
|}
 

{{Tips Navigation
|uplink=[[TUFLOW_Utilities | Back to TUFLOW Utilities]]
}}

TUFLOW Message 2936

2025-04-17T02:45:00Z

ElizaCollison:

{{TUFLOW_Message
|tuflow_message= 2936 - Horizontal advection of soil water is not activated. GT boundary will be ignored.
|alt_msg=NA 
|type=[[WARNING]]
|message_desc= A GT boundary has been used without activating the horizontal advection component of groundwater flow (which is a requirement for GT boundaries). The GT boundary will be ignored.
|suggestions= Check whether the horizontal advection functionality was meant to be activated, or don't use a GT boundary.

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
}}

TUFLOW Message 2936

2025-04-17T02:34:04Z

ElizaCollison: Created page with "{{TUFLOW_Message |tuflow_message=WARNING 2936 - . |alt_msg=NA |type=WARNING |message_desc= A GT boundary has been used without activating the horizontal advection com..."

{{TUFLOW_Message
|tuflow_message=WARNING 2936 - .
|alt_msg=NA 
|type=[[WARNING]]
|message_desc= A GT boundary has been used without activating the horizontal advection component of groundwater flow (which is a requirement for GT boundaries). The GT boundary will be ignored.
|suggestions= Check whether the horizontal advection functionality was meant to be activated, or don't use a GT boundary.

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
}}

2xxx TUFLOW Messages

2025-04-17T02:30:09Z

ElizaCollison:

The 2xxx TUFLOW messages refer to issues that occur neither in the 2D model. Click on number to follow link to TUFLOW message description, grey numbers are reserved and do not yet have messages assigned, and red numbers have been allocated to new messages.

See also:
* [[0xxx TUFLOW Messages]]
* [[1xxx TUFLOW Messages]]
* [[3xxx TUFLOW Messages]]
* [[4xxx TUFLOW Messages]]
* [[5xxx TUFLOW Messages]]
* [[6xxx TUFLOW Messages]]

{| Border ="1" cellpadding="8" style="text-align:center"
|2000 || [[TUFLOW Message 2001|2001 ]] || [[TUFLOW Message 2002|2002 ]] || [[TUFLOW Message 2003|2003 ]] || [[TUFLOW Message 2004|2004 ]] || [[TUFLOW Message 2005|2005 ]] || [[TUFLOW Message 2006|2006 ]] || [[TUFLOW Message 2007|2007 ]] || [[TUFLOW Message 2008|2008 ]] || [[TUFLOW Message 2009|2009 ]] || [[TUFLOW Message 2010|2010 ]] || [[TUFLOW Message 2011|2011 ]] || [[TUFLOW Message 2012|2012 ]] || [[TUFLOW Message 2013|2013 ]] || [[TUFLOW Message 2014|2014 ]] || [[TUFLOW Message 2015|2015 ]] || [[TUFLOW Message 2016|2016 ]] || [[TUFLOW Message 2017|2017 ]] || [[TUFLOW Message 2018|2018 ]] || [[TUFLOW Message 2019|2019 ]]
|-
|[[TUFLOW Message 2020|2020 ]] || [[TUFLOW Message 2021|2021 ]] || [[TUFLOW Message 2022|2022 ]] || [[TUFLOW Message 2023|2023 ]] || [[TUFLOW Message 2024|2024 ]] || [[TUFLOW Message 2025|2025 ]] || [[TUFLOW Message 2026|2026 ]] || [[TUFLOW Message 2027|2027 ]] || [[TUFLOW Message 2028|2028 ]] || [[TUFLOW Message 2029|2029 ]] || [[TUFLOW Message 2030|2030 ]] || [[TUFLOW Message 2031|2031 ]] || [[TUFLOW Message 2032|2032 ]] || [[TUFLOW Message 2033|2033 ]] || [[TUFLOW Message 2034|2034 ]] || [[TUFLOW Message 2035|2035 ]] || [[TUFLOW Message 2036|2036 ]] || [[TUFLOW Message 2037|2037 ]] || [[TUFLOW Message 2038|2038 ]] || [[TUFLOW Message 2039|2039 ]]
|-
|[[TUFLOW Message 2040|2040 ]] || [[TUFLOW Message 2041|2041 ]] || [[TUFLOW Message 2042|2042 ]] || [[TUFLOW Message 2043|2043 ]] || [[TUFLOW Message 2044|2044 ]] || [[TUFLOW Message 2045|2045 ]] || [[TUFLOW Message 2046|2046 ]] || [[TUFLOW Message 2047|2047 ]] || [[TUFLOW Message 2048|2048 ]] || [[TUFLOW Message 2049|2049 ]] || [[TUFLOW Message 2050|2050 ]] || [[TUFLOW Message 2051|2051 ]] || [[TUFLOW Message 2052|2052 ]] || [[TUFLOW Message 2053|2053 ]] || [[TUFLOW Message 2054|2054 ]] || [[TUFLOW Message 2055|2055 ]] || [[TUFLOW Message 2056|2056 ]] || [[TUFLOW Message 2057|2057 ]] || [[TUFLOW Message 2058|2058 ]] || [[TUFLOW Message 2059|2059 ]]
|-
|[[TUFLOW Message 2060|2060 ]] || [[TUFLOW Message 2061|2061 ]] || [[TUFLOW Message 2062|2062 ]] || [[TUFLOW Message 2063|2063 ]] || [[TUFLOW Message 2064|2064 ]] || [[TUFLOW Message 2065|2065 ]] || [[TUFLOW Message 2066|2066 ]] || [[TUFLOW Message 2067|2067 ]] || [[TUFLOW Message 2068|2068 ]] || [[TUFLOW Message 2069|2069 ]] || [[TUFLOW Message 2070|2070 ]] || [[TUFLOW Message 2071|2071 ]] || [[TUFLOW Message 2072|2072 ]] || [[TUFLOW Message 2073|2073 ]] || [[TUFLOW Message 2074|2074 ]] || [[TUFLOW Message 2075|2075 ]] || [[TUFLOW Message 2076|2076 ]] || [[TUFLOW Message 2077|2077 ]] || [[TUFLOW Message 2078|2078 ]] || [[TUFLOW Message 2079|2079 ]]
|-
|[[TUFLOW Message 2080|2080 ]] || [[TUFLOW Message 2081|2081 ]] || [[TUFLOW Message 2082|2082 ]] || [[TUFLOW Message 2083|2083 ]] || [[TUFLOW Message 2084|2084 ]] || [[TUFLOW Message 2085|2085 ]] || [[TUFLOW Message 2086|2086 ]] || [[TUFLOW Message 2087|2087 ]] || [[TUFLOW Message 2088|2088 ]] || [[TUFLOW Message 2089|2089 ]] || [[TUFLOW Message 2090|2090 ]] || [[TUFLOW Message 2091|2091 ]] || [[TUFLOW Message 2092|2092 ]] || [[TUFLOW Message 2093|2093 ]] || [[TUFLOW Message 2094|2094 ]] || [[TUFLOW Message 2095|2095 ]] || [[TUFLOW Message 2096|2096 ]] || [[TUFLOW Message 2097|2097 ]] || [[TUFLOW Message 2098|2098 ]] || [[TUFLOW Message 2099|2099 ]]
|-
|[[TUFLOW Message 2100|2100 ]] || [[TUFLOW Message 2101|2101 ]] || [[TUFLOW Message 2102|2102 ]] || [[TUFLOW Message 2103|2103 ]] || [[TUFLOW Message 2104|2104 ]] || [[TUFLOW Message 2105|2105 ]] || [[TUFLOW Message 2106|2106 ]] || [[TUFLOW Message 2107|2107 ]] || [[TUFLOW Message 2108|2108 ]] || [[TUFLOW Message 2109|2109 ]] || [[TUFLOW Message 2110|2110 ]] || [[TUFLOW Message 2111|2111 ]] || [[TUFLOW Message 2112|2112 ]] || [[TUFLOW Message 2113|2113 ]] || [[TUFLOW Message 2114|2114 ]] || [[TUFLOW Message 2115|2115 ]] || [[TUFLOW Message 2116|2116 ]] || [[TUFLOW Message 2117|2117 ]] || [[TUFLOW Message 2118|2118 ]] || [[TUFLOW Message 2119|2119 ]]
|-
|[[TUFLOW Message 2120|2120 ]] || [[TUFLOW Message 2121|2121 ]] || [[TUFLOW Message 2122|2122 ]] || [[TUFLOW Message 2123|2123 ]] || [[TUFLOW Message 2124|2124 ]] || [[TUFLOW Message 2125|2125 ]] || [[TUFLOW Message 2126|2126 ]] || [[TUFLOW Message 2127|2127 ]] || [[TUFLOW Message 2128|2128 ]] || [[TUFLOW Message 2129|2129 ]] || [[TUFLOW Message 2130|2130 ]] || [[TUFLOW Message 2131|2131 ]] || [[TUFLOW Message 2132|2132 ]] || [[TUFLOW Message 2133|2133 ]] || [[TUFLOW Message 2134|2134 ]] || [[TUFLOW Message 2135|2135 ]] || [[TUFLOW Message 2136|2136 ]] || [[TUFLOW Message 2137|2137 ]] || [[TUFLOW Message 2138|2138 ]] || [[TUFLOW Message 2139|2139 ]]
|-
|[[TUFLOW Message 2140|2140 ]] || [[TUFLOW Message 2141|2141 ]] || [[TUFLOW Message 2142|2142 ]] || [[TUFLOW Message 2143|2143 ]] || [[TUFLOW Message 2144|2144 ]] || [[TUFLOW Message 2145|2145 ]] || [[TUFLOW Message 2146|2146 ]] || [[TUFLOW Message 2147|2147 ]] || [[TUFLOW Message 2148|2148 ]] || [[TUFLOW Message 2149|2149 ]] || [[TUFLOW Message 2150|2150 ]] || [[TUFLOW Message 2151|2151 ]] || [[TUFLOW Message 2152|2152 ]] || [[TUFLOW Message 2153|2153 ]] || [[TUFLOW Message 2154|2154 ]] || [[TUFLOW Message 2155|2155 ]] || [[TUFLOW Message 2156|2156 ]] || [[TUFLOW Message 2157|2157 ]] || [[TUFLOW Message 2158|2158 ]] || [[TUFLOW Message 2159|2159 ]]
|-
|[[TUFLOW Message 2160|2160 ]] || [[TUFLOW Message 2161|2161 ]] || [[TUFLOW Message 2162|2162 ]] || [[TUFLOW Message 2163|2163 ]] || [[TUFLOW Message 2164|2164 ]] || [[TUFLOW Message 2165|2165 ]] || [[TUFLOW Message 2166|2166 ]] || [[TUFLOW Message 2167|2167 ]] || [[TUFLOW Message 2168|2168 ]] || [[TUFLOW Message 2169|2169 ]] || [[TUFLOW Message 2170|2170 ]] || [[TUFLOW Message 2171|2171 ]] || [[TUFLOW Message 2172|2172 ]] || [[TUFLOW Message 2173|2173 ]] || [[TUFLOW Message 2174|2174 ]] || [[TUFLOW Message 2175|2175 ]] || [[TUFLOW Message 2176|2176 ]] || [[TUFLOW Message 2177|2177 ]] || [[TUFLOW Message 2178|2178 ]] || [[TUFLOW Message 2179|2179 ]]
|-
|[[TUFLOW Message 2180|2180 ]] || [[TUFLOW Message 2181|2181 ]] || [[TUFLOW Message 2182|2182 ]] || [[TUFLOW Message 2183|2183 ]] || [[TUFLOW Message 2184|2184 ]] || [[TUFLOW Message 2185|2185 ]] || [[TUFLOW Message 2186|2186 ]] || [[TUFLOW Message 2187|2187 ]] || [[TUFLOW Message 2188|2188 ]] || [[TUFLOW Message 2189|2189 ]] || [[TUFLOW Message 2190|2190 ]] || [[TUFLOW Message 2191|2191 ]] || [[TUFLOW Message 2192|2192 ]] || [[TUFLOW Message 2193|2193 ]] || [[TUFLOW Message 2194|2194 ]] || [[TUFLOW Message 2195|2195 ]] || [[TUFLOW Message 2196|2196 ]] || [[TUFLOW Message 2197|2197 ]] || [[TUFLOW Message 2198|2198 ]] || [[TUFLOW Message 2199|2199 ]]
|-
|[[TUFLOW Message 2200|2200 ]] || [[TUFLOW Message 2201|2201 ]] || [[TUFLOW Message 2202|2202 ]] || [[TUFLOW Message 2203|2203 ]] || [[TUFLOW_Message_2204| 2204]] || [[TUFLOW Message 2205|2205 ]] || [[TUFLOW Message 2206|2206 ]] || 2207 || [[TUFLOW Message 2208|2208 ]] || 2209 || [[TUFLOW Message 2210|2210 ]] || [[TUFLOW Message 2211|2211 ]] || [[TUFLOW Message 2212|2212 ]] || [[TUFLOW Message 2213|2213 ]] || [[TUFLOW Message 2214|2214 ]] || [[TUFLOW Message 2215|2215 ]] || [[TUFLOW Message 2216|2216 ]] || [[TUFLOW Message 2217|2217 ]] || [[TUFLOW Message 2218|2218 ]] || [[TUFLOW Message 2219|2219 ]]
|-
|[[TUFLOW Message 2220|2220 ]] || [[TUFLOW Message 2221|2221 ]] || [[TUFLOW Message 2222|2222 ]] || [[TUFLOW Message 2223|2223 ]] || [[TUFLOW Message 2224|2224 ]] || [[TUFLOW Message 2225|2225 ]] || [[TUFLOW Message 2226|2226 ]] || [[TUFLOW Message 2227|2227 ]] || [[TUFLOW Message 2228|2228 ]] || [[TUFLOW Message 2229|2229 ]] || [[TUFLOW Message 2230|2230 ]] || [[TUFLOW Message 2231|2231 ]] || [[TUFLOW Message 2232|2232 ]] || [[TUFLOW Message 2233|2233 ]] || [[TUFLOW Message 2234|2234 ]] || [[TUFLOW Message 2235|2235 ]] || [[TUFLOW Message 2236|2236 ]] || [[TUFLOW Message 2237|2237 ]] || [[TUFLOW Message 2238|2238 ]] || [[TUFLOW Message 2239|2239 ]]
|-
|[[TUFLOW Message 2240|2240 ]] || [[TUFLOW Message 2241|2241 ]] || [[TUFLOW Message 2242|2242 ]] || 2243 || [[TUFLOW Message 2244|2244 ]] || 2245 || 2246 || 2247 || 2248 || 2249 || 2250 || 2251 || 2252 || 2253 || 2254 || 2255 || 2256 || 2257 || 2258 || 2259
|-
|2300 || 2301 || [[TUFLOW Message 2302|2302 ]] || 2303 || [[TUFLOW Message 2304|2304 ]] || [[TUFLOW Message 2305|2305 ]] || [[TUFLOW Message 2306|2306 ]] || 2307 || [[TUFLOW Message 2308|2308 ]] || [[TUFLOW Message 2309|2309 ]] || [[TUFLOW Message 2310|2310 ]] || [[TUFLOW Message 2311|2311 ]] || 2312 || [[TUFLOW Message 2313|2313 ]] || [[TUFLOW Message 2314|2314 ]] || [[TUFLOW Message 2315|2315 ]]|| [[TUFLOW Message 2316|2316 ]] || [[TUFLOW Message 2317|2317 ]] || 2318 || [[TUFLOW Message 2319|2319 ]]
|-
|[[TUFLOW Message 2320|2320 ]] || [[TUFLOW Message 2321|2321 ]] || 2322 || [[TUFLOW Message 2323|2323 ]] || 2324 || 2325 || 2326 || 2327 || 2328 || [[TUFLOW Message 2329|2329 ]] || [[TUFLOW Message 2330|2330 ]] || [[TUFLOW Message 2331|2331 ]] || 2332 || [[TUFLOW Message 2333|2333 ]] || [[TUFLOW Message 2334|2334 ]] || [[TUFLOW Message 2335|2335 ]] || [[TUFLOW Message 2336|2336 ]] || [[TUFLOW Message 2337|2337]] || [[TUFLOW Message 2338|2338]] || 2339
|-
|[[TUFLOW Message 2340|2340 ]] || 2341 || 2342 || [[TUFLOW Message 2343|2343 ]] || 2344 || 2345 || 2346 || [[TUFLOW Message 2347|2347 ]] || [[TUFLOW Message 2348|2348 ]] || [[TUFLOW Message 2349|2349 ]] || [[TUFLOW Message 2350|2350 ]] || [[TUFLOW Message 2351|2351 ]] || [[TUFLOW Message 2352|2352 ]] || [[TUFLOW Message 2353|2353 ]] || [[TUFLOW Message 2354|2354 ]] || [[TUFLOW Message 2355|2355 ]] || [[TUFLOW Message 2356|2356 ]] || [[TUFLOW Message 2357|2357 ]] || [[TUFLOW Message 2358|2358 ]] || [[TUFLOW Message 2359|2359 ]]
|-
|[[TUFLOW Message 2360|2360 ]] || [[TUFLOW Message 2361|2361 ]] || [[TUFLOW Message 2362|2362 ]] || 2363 || 2364 || [[TUFLOW Message 2365|2365 ]] || 2366 || [[TUFLOW Message 2367|2367 ]] || [[TUFLOW Message 2368|2368 ]] || 2369 || [[TUFLOW Message 2370|2370 ]] || [[TUFLOW Message 2371|2371 ]] || [[TUFLOW Message 2372|2372 ]] || [[TUFLOW Message 2373|2373 ]] || [[TUFLOW Message 2374|2374 ]] || [[TUFLOW Message 2375|2375 ]] || [[TUFLOW Message 2376|2376 ]] || [[TUFLOW Message 2377|2377 ]] || 2378 || 2379
|-
|[[TUFLOW Message 2380|2380 ]] || [[TUFLOW Message 2381|2381 ]] || [[TUFLOW Message 2382|2382 ]] || [[TUFLOW Message 2383|2383 ]] || 2384 || [[TUFLOW Message 2385|2385 ]] || [[TUFLOW Message 2386|2386 ]] || 2387 || 2388 || [[TUFLOW Message 2389|2389 ]] || [[TUFLOW Message 2390|2390 ]] || [[TUFLOW Message 2391|2391 ]] || [[TUFLOW Message 2392|2392 ]] || 2393 || 2394 || 2395 || 2396 || 2397 || 2398 || 2399
|-
|[[TUFLOW Message 2400|2400 ]] || [[TUFLOW Message 2401|2401 ]] || [[TUFLOW Message 2402|2402 ]] || [[TUFLOW Message 2403|2403 ]] || [[TUFLOW Message 2404|2404 ]] || [[TUFLOW Message 2405|2405 ]] || [[TUFLOW Message 2406|2406 ]] || [[TUFLOW Message 2407|2407 ]] || [[TUFLOW Message 2408|2408 ]] || [[TUFLOW Message 2409|2409 ]] || 2410 || [[TUFLOW Message 2411|2411 ]] || [[TUFLOW Message 2412|2412 ]] || [[TUFLOW Message 2413|2413 ]] || [[TUFLOW Message 2414|2414 ]] || [[TUFLOW Message 2415|2415 ]] || [[TUFLOW Message 2416|2416 ]] || [[TUFLOW Message 2417|2417 ]] || [[TUFLOW Message 2418|2418 ]] || [[TUFLOW Message 2419|2419 ]]
|-
|[[TUFLOW Message 2420|2420 ]] || [[TUFLOW Message 2421|2421 ]] || [[TUFLOW Message 2422|2422 ]] || [[TUFLOW Message 2423|2423 ]] || [[TUFLOW Message 2424|2424 ]] || [[TUFLOW Message 2425|2425 ]] || [[TUFLOW Message 2426|2426 ]] || [[TUFLOW Message 2427|2427 ]] || [[TUFLOW Message 2428|2428 ]] || [[TUFLOW Message 2429|2429 ]] || [[TUFLOW Message 2430|2430 ]] || [[TUFLOW Message 2431|2431 ]] || [[TUFLOW Message 2432|2432 ]] || 2433 || 2434 || [[TUFLOW Message 2435|2435 ]] || [[TUFLOW Message 2436|2436 ]] || 2437 || [[TUFLOW Message 2438|2438 ]] || 2439
|-
|[[TUFLOW Message 2440|2440 ]] || [[TUFLOW Message 2441|2441 ]] || [[TUFLOW Message 2442|2442 ]] || [[TUFLOW Message 2443|2443 ]] || [[TUFLOW Message 2444|2444 ]] || [[TUFLOW Message 2445|2445 ]] || 2446 || [[TUFLOW Message 2447|2447 ]] || 2448 || 2449 || [[TUFLOW Message 2450|2450 ]] || [[TUFLOW Message 2451|2451 ]] || 2452 || 2453 || 2454 || 2455 || 2456 || 2457 || 2458 || 2459
|-
|[[TUFLOW Message 2460|2460 ]] || [[TUFLOW Message 2461|2461 ]] || [[TUFLOW Message 2462|2462 ]] || [[TUFLOW Message 2463|2463 ]] || [[TUFLOW Message 2464|2464 ]] || [[TUFLOW Message 2465|2465 ]] || [[TUFLOW Message 2466|2466 ]] || [[TUFLOW Message 2467|2467 ]] || [[TUFLOW Message 2468|2468 ]] || [[TUFLOW Message 2469|2469 ]] || [[TUFLOW Message 2470|2470 ]] || [[TUFLOW Message 2471|2471 ]] || [[TUFLOW Message 2472|2472 ]] || [[TUFLOW Message 2473|2473 ]] || [[TUFLOW Message 2474|2474 ]] || [[TUFLOW Message 2475|2475 ]] || [[TUFLOW Message 2476|2476 ]] || [[TUFLOW Message 2477|2477 ]] || [[TUFLOW Message 2478|2478 ]] || [[TUFLOW Message 2479|2479 ]]
|-
|[[TUFLOW Message 2480|2480 ]] || [[TUFLOW Message 2481|2481 ]] || [[TUFLOW Message 2482|2482 ]] || [[TUFLOW Message 2483|2483 ]] || [[TUFLOW Message 2484|2484 ]] || [[TUFLOW Message 2485|2485 ]] || [[TUFLOW Message 2486|2486 ]] || [[TUFLOW Message 2487|2487 ]] || [[TUFLOW Message 2488|2488 ]] || [[TUFLOW Message 2489|2489 ]] || [[TUFLOW Message 2490|2490 ]] || [[TUFLOW Message 2491|2491 ]] || [[TUFLOW Message 2492|2492 ]] || [[TUFLOW Message 2493|2493 ]] || [[TUFLOW Message 2494|2494 ]] || [[TUFLOW Message 2495|2495 ]] || [[TUFLOW Message 2496|2496 ]] || [[TUFLOW Message 2497|2497 ]] || [[TUFLOW Message 2498|2498 ]] || [[TUFLOW Message 2499|2499 ]]
|-
|[[TUFLOW Message 2500|2500 ]] || 2501 || 2502 || 2503 || 2504 || 2505 || 2506 || [[TUFLOW Message 2507|2507 ]] || [[TUFLOW Message 2508|2508 ]] || [[TUFLOW Message 2509|2509 ]] || 2510 || 2511 || 2512 || 2513 || [[TUFLOW Message 2514|2514 ]] || [[TUFLOW Message 2515|2515 ]] || [[TUFLOW Message 2516|2516 ]] || [[TUFLOW Message 2517|2517 ]] || 2518 || [[TUFLOW Message 2519|2519 ]]
|-
|2520 || 2521 || [[TUFLOW Message 2522|2522 ]] || 2523 || 2524 || 2525 || 2526 || 2527 || 2528 || 2529 || 2530 || 2531 || 2532 || 2533 || 2534 || 2535 || 2536 || 2537 || 2538 || 2539
|-
|[[TUFLOW Message 2540|2540 ]] || [[TUFLOW Message 2541|2541 ]] || 2542 || 2543 || 2544 || 2545 || 2546 || 2547 || 2548 || 2549 || [[TUFLOW Message 2550|2550 ]] || [[TUFLOW Message 2551|2551 ]] || 2552 || 2553 || 2554 || 2555 || 2556 || 2557 || 2558 || 2559
|-
|[[TUFLOW Message 2560|2560 ]] || 2561 || [[TUFLOW Message 2562|2562 ]] || 2563 || [[TUFLOW Message 2564|2564 ]] || [[TUFLOW Message 2565|2565 ]] || [[TUFLOW Message 2566|2566 ]] || [[TUFLOW Message 2567|2567 ]] || [[TUFLOW Message 2568|2568 ]] || [[TUFLOW Message 2569|2569 ]] || [[TUFLOW Message 2570|2570 ]] || [[TUFLOW Message 2571|2571 ]] || [[TUFLOW Message 2572|2572 ]] || [[TUFLOW Message 2573|2573 ]] || [[TUFLOW Message 2574|2574 ]] || [[TUFLOW Message 2575|2575 ]] || [[TUFLOW Message 2576|2576 ]] || [[TUFLOW Message 2577|2577 ]] || [[TUFLOW Message 2578|2578 ]] || [[TUFLOW Message 2579|2579 ]]
|-
|[[TUFLOW Message 2580|2580 ]] || [[TUFLOW Message 2581|2581 ]] || [[TUFLOW Message 2582|2582 ]] || [[TUFLOW Message 2583|2583 ]] || [[TUFLOW Message 2584|2584 ]] || [[TUFLOW Message 2585|2585 ]] ||[[TUFLOW Message 2586|2586 ]] || [[TUFLOW Message 2587|2587 ]] || [[TUFLOW Message 2588|2588 ]] || [[TUFLOW Message 2589|2589 ]] || [[TUFLOW Message 2590|2590 ]] || 2591 ||[[TUFLOW Message 2592|2592 ]] || 2593 || [[TUFLOW Message 2594|2594 ]] || 2595 || 2596 || 2597 ||2598 || [[TUFLOW_Message_2599|2599]]
|-
|[[TUFLOW Message 2600|2600 ]] || [[TUFLOW Message 2601|2601 ]] || [[TUFLOW Message 2602|2602 ]] || [[TUFLOW Message 2603|2603 ]] || [[TUFLOW Message 2604|2604 ]] || [[TUFLOW Message 2605|2605 ]] || [[TUFLOW Message 2606|2606 ]] || [[TUFLOW Message 2607|2607 ]] || [[TUFLOW Message 2608|2608 ]] || [[TUFLOW Message 2609|2609 ]] || [[TUFLOW Message 2610|2610 ]] || [[TUFLOW Message 2611|2611 ]] || [[TUFLOW Message 2612|2612 ]] || [[TUFLOW Message 2613|2613 ]] || [[TUFLOW Message 2614|2614 ]] || [[TUFLOW Message 2615|2615 ]] || [[TUFLOW Message 2616|2616 ]] || [[TUFLOW Message 2617|2617 ]] || [[TUFLOW Message 2618|2618 ]] || [[TUFLOW Message 2619|2619 ]]
|-
|[[TUFLOW Message 2620|2620 ]] || 2621 || 2622 || 2623 || 2624 || 2625 || 2626 || 2627 || 2628 || 2629 || 2630 || [[TUFLOW Message 2631|2631 ]] || 2632 || 2633 || 2634 || 2635 || 2636 || 2637 || 2638 || 2639
|-
|2640 || [[TUFLOW Message 2641|2641 ]] || [[TUFLOW Message 2642|2642 ]] || 2643 || 2644 || 2645 || 2646 || 2647 || 2648 || [[TUFLOW Message 2649|2649 ]] || 2650 || 2651 || 2652 || 2653 || 2654 || 2655 || 2656 || 2657 || 2658 || 2659
|-
|2660 || 2661 || 2662 || 2663 || 2664 || 2665 || 2666 || 2667 || 2668 || 2669 || [[TUFLOW Message 2670|2670 ]] || [[TUFLOW Message 2671|2671 ]] || 2672 || 2673 || 2674 || 2675 || 2676 || 2677 || 2678 || 2679
|-
| [[TUFLOW Message 2720|2720 ]] || 2721 || [[TUFLOW Message 2722|2722 ]] || 2723 || 2724 || 2725 || 2726 || 2727 || 2728 || 2729 || 2730 || 2731 || 2732 || 2733 || 2734 || [[TUFLOW Message 2735|2735 ]] || 2736 || 2737 || 2738 || 2739
|-
|2760 || 2761 || 2762 || [[TUFLOW Message 2763|2763 ]] || 2764 || 2765 || 2766 || 2767 || 2768 || 2769 || 2770 || 2771 || 2772 || 2773 || 2774 || 2775 || 2776 || 2777 || 2778 || 2779
|-
|2780 || 2781 || [[TUFLOW Message 2782|2782 ]] || 2783 || [[TUFLOW Message 2784|2784 ]] || [[TUFLOW Message 2785|2785 ]] || [[TUFLOW Message 2786|2786 ]] || [[TUFLOW Message 2787|2787 ]] || 2788 || 2789 || 2790 || 2791 || 2792 || 2793 || 2794 || 2795 || 2796 || 2797 || 2798 || 2799
|-
|[[TUFLOW Message 2800|2800 ]] || [[TUFLOW Message 2801|2801 ]] || [[TUFLOW Message 2802|2802 ]] || [[TUFLOW Message 2803|2803 ]] || [[TUFLOW Message 2804|2804 ]] || [[TUFLOW Message 2805|2805 ]] || [[TUFLOW Message 2806|2806 ]] || [[TUFLOW Message 2807|2807 ]] || [[TUFLOW Message 2808|2808 ]] || [[TUFLOW Message 2809|2809 ]] || [[TUFLOW Message 2810|2810 ]] || [[TUFLOW Message 2811|2811 ]] || [[TUFLOW Message 2812|2812 ]] || [[TUFLOW Message 2813|2813 ]] || [[TUFLOW Message 2814|2814 ]] || [[TUFLOW Message 2815|2815 ]] || [[TUFLOW Message 2816|2816 ]] || [[TUFLOW Message 2817|2817 ]] || [[TUFLOW Message 2818|2818 ]] || [[TUFLOW Message 2819|2819 ]]
|-
|[[TUFLOW Message 2820|2820 ]] || [[TUFLOW Message 2821|2821 ]] || [[TUFLOW Message 2822|2822 ]] || [[TUFLOW Message 2823|2823 ]] || [[TUFLOW Message 2824|2824 ]] || [[TUFLOW Message 2825|2825 ]] || [[TUFLOW Message 2826|2826 ]] || [[TUFLOW Message 2827|2827 ]] || [[TUFLOW Message 2828|2828 ]] || [[TUFLOW Message 2829|2829 ]] || [[TUFLOW Message 2830|2830 ]] || [[TUFLOW Message 2831|2831 ]] || [[TUFLOW Message 2832|2832 ]] || [[TUFLOW Message 2833|2833 ]] || [[TUFLOW Message 2834|2834 ]] || [[TUFLOW Message 2835|2835 ]] || [[TUFLOW Message 2836|2836 ]] || [[TUFLOW Message 2837|2837 ]] || [[TUFLOW Message 2838|2838 ]] || [[TUFLOW Message 2839|2839 ]]
|-
|[[TUFLOW Message 2840|2840 ]] || [[TUFLOW Message 2841|2841 ]] || [[TUFLOW Message 2842|2842 ]] || [[TUFLOW Message 2843|2843 ]] || [[TUFLOW Message 2844|2844 ]] || [[TUFLOW Message 2845|2845 ]] || [[TUFLOW Message 2846|2846 ]] || [[TUFLOW Message 2847|2847 ]] || [[TUFLOW Message 2848|2848 ]] || [[TUFLOW Message 2849|2849 ]] || [[TUFLOW Message 2850|2850 ]] || [[TUFLOW Message 2851|2851 ]] || [[TUFLOW Message 2852|2852 ]] || [[TUFLOW Message 2853|2853 ]] || [[TUFLOW Message 2854|2854 ]] || [[TUFLOW Message 2855|2855 ]] || [[TUFLOW Message 2856|2856 ]] || [[TUFLOW Message 2857|2857 ]] || [[TUFLOW Message 2858|2858 ]] || [[TUFLOW Message 2859|2859 ]]
|-
|2900 || 2901 || [[TUFLOW Message 2902|2902 ]] || 2903 || [[TUFLOW Message 2904|2904 ]] || [[TUFLOW Message 2905|2905 ]] || 2906 || 2907 || 2908 || 2909 || 2910 || [[TUFLOW Message 2911|2911 ]] || 2912 || [[TUFLOW Message 2913|2913 ]] || 2914 || 2915 || 2916 || 2917 || 2918 || 2919
|-
|[[TUFLOW Message 2920|2920 ]] || [[TUFLOW Message 2921|2921 ]] || [[TUFLOW Message 2922|2922 ]] || [[TUFLOW Message 2923|2923 ]] || [[TUFLOW Message 2924|2924 ]] || [[TUFLOW Message 2925|2925 ]]|| [[TUFLOW Message 2926|2926 ]] || [[TUFLOW Message 2927|2927 ]] || [[TUFLOW Message 2928|2928 ]] || [[TUFLOW Message 2929|2929 ]] || [[TUFLOW Message 2930|2930 ]] || [[TUFLOW Message 2931|2931 ]] || [[TUFLOW Message 2932|2932 ]] || [[TUFLOW Message 2933|2933 ]] || [[TUFLOW Message 2934|2934 ]] || [[TUFLOW Message 2935|2935 ]] || [[TUFLOW Message 2936|2936 ]] || 2937 || 2938 || 2939
|-
|[[TUFLOW Message 2980|2980 ]] || 2981 || 2982 || 2983 || 2984 || 2985 || 2986 || 2987 || 2988 || 2989 || 2990 || [[TUFLOW Message 2991|2991 ]] || 2992 || 2993 || 2994 || 2995 || 2996 || 2997 || [[TUFLOW Message 2998|2998 ]] || [[TUFLOW Message 2999|2999 ]]
|-
|}
 
{{Tips Navigation
|uplink=[[ Main_Page | Back to Main Page]]
}}

TUFLOW 1D Channels and Hydraulic Structures

2025-04-16T06:45:31Z

ElizaCollison: /* How do I model blockage for irregular shaped culverts or channels? */

=Introduction=
The objective of the following pages is to supplement the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] and provide additional modelling guidance on 1D hydraulic channels.
=1D Channel Types=
1d_nwk channels represent open channels, hydraulic structures, operational structures and other flow controls. A channel is either digitised as a line or point with the relevant hydraulic properties entered into the appropriate GIS attributes, details for this can be found within the links below or the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual].
==Open Channels==
{| class="wikitable" width="50%"

! style="background-color:#005581; font-weight:bold; color:white;"| Channel Type
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Description of page contents
|-
| [[ 1D_Open_Channels | Open Channels]]|| This page contains information on basic commands, error checking and common check files used.
|}

==Structures==
The table below contains a complete list of 1D structures available within TUFLOW, including logic control structures. 
{| class="wikitable" width="50%"

! style="background-color:#005581; font-weight:bold; color:white;"| Channel Type
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Description of page contents
|-
| [[1D_Culverts | Culverts]]|| 1D-2D connections, flow regimes, operational control and common check files used.
|-
| [[1D_Bridges | Bridges]]|| Loss theory, irregular shaped bridges and common check files used.
|-
| [[1D_Weirs | Weirs]]|| Weir types
|-
| [[ 1D_Pumps | Pumps]]|| Pump attributes, 2D-2D & 1D-2D configurations, Estry setup, depth-discharge database and 1D results file.
|-
| [[1D_Pits | Pits]]|| Pit inlet types, depth-discharge data sources, modelling advice.
|-
| [[1D_Manholes | Manholes]]|| Losses and storage chambers.
|-
|[[1D Syphons|Syphons]]
|1D configuration, losses.
|-
|}

= Common Questions Answered (FAQ)=
== What is the difference between 1d_pit and 1d_nwk layer for pits? ==
The 1d_pit layer is a newer and simplified version of the 1d_nwk layer for pits. 
=== 1d_pit ===
* Assumes default values for any of missing attributes that are described for the 1d_nwk pits layers.
* Does not have invert attributes. The upstream invert is assumed to be the ZC elevation of the connected 2D SX cell, as such the "L" flag is not supported. The downstream invert needs to retrieve its value from the connected 1d_nwk channel.
* The nodal area assumes the default, the downstream pit channel node has its nodal area automatically assigned based on the connected 1d_nwk channel segments that have the UCS attribute set to “true”. The applied nodal area can be confirmed in the .eof file. 
* Virtual pipes can only be setup with the 1d_pit layer.
=== 1d_nwk ===
* Used for models that needs to deviate from the default approaches.

== How can I read approach-capture flow curves for on-grade pits into TUFLOW? ==
TUFLOW currently doesn't support the use of approach-capture flow curves directly. Manning's equation calculations can be used to convert on-grade approach flow information to a water depth at the pit. For example, [https://www.arr-software.org/arrdocs.html Australian Rainfall and Runoff 2019] (Engineers Australia) (Book 9, Chapter 5, Section 5.6.1) recommends using the modified Mannings equation, the Izzard's equation, for gutter and roadway flow.

The pit depth-flow curve relationship can be derived as follows:
*Select a few representative slope increments for the project area and conduct a Manning's equation calculation for each slope to calculate the gutter flow rates for incrementally increasing flow depths.
*Multiply the calculated flows by the % value in the on grade curve. This turns the % capture vs. flow curve into a depth vs. flow relationship.
*Repeat for different gutter shapes

== Should I model culverts in the 1D or 2D domain? ==
This largely depends on the size of the culvert in comparison with the cell size. Most commonly culverts are modelled within the 1D domain, however, with more computational power given by GPU devices, cell sizes are getting smaller and it might be beneficial to model bigger culverts in 2D. If the culvert is an important aspect of the study, it is always recommended to model it in number of ways by either using different methods and/or different software and the afflux is cross-checked against a desktop analysis and hand calculations. None will be 100% right, but the intent here is to establish a verification of the preferred approach. 
=== 2D only approach ===
* Benefits:
** Good stability and improved hydraulic behaviour at the culvert entrance/exit.
** The expansion loss (exit loss) can be explicitly handled in 2D provided the 2D cell resolution is sufficiently fine to model the expansion of flow downstream of the culvert.
* Challenges:
** The contraction loss (entry loss), which is related to the expansion of water after the vena-contracta and forms inside at the culvert inlet, won't be picked up well and some additional energy loss (form loss) might be needed to cover this.
** Side and soffit wall friction are not modelled unless Manning's n varies with depth, i.e. increase Manning's n with depth to account for the missing Manning's n on the side and top surfaces.
** The vertical walls not only create extra friction but also straightens the flow in the direction of the wall. Thin breaklines can be used to represent these walls in 2D, but it is likely to cause saw-tooth effect if sub-grid sampling (SGS) is not used, i.e. extra numerical head loss, if there are too few cells between the walls. SGS is recommended in this case.
** Flow overtopping can be represented to some extent by assuming 100% blockage of layer 2 in a 2d_lfcsh, but the flow upstream and downstream before the culvert is overtopped is hard to model.

=== 2D-1D-2D approach ===
* Benefits:
** A more appropriate approach where the 2D cell size is greater than around half the total culvert width.
** Contraction losses (entry losses) are handled better.
** Flow overtopping can be modelled in 2D.
* Challenges:
** Expansion losses (exit losses) are very dependent on the 2D cell resolution. A 2D cell size much larger than the culvert width will not reproduce the expansion losses very well (even with SGS) and the culvert's exit loss needs to cover this. A finer 2D cell size (several or more cells across the culvert) will reproduce the expansion losses much better and the culvert's exit loss need to be reduced to compensate it. This usually only happens for large 1D culverts with high velocities as there can be losses duplicated in the 2D on the exit side as the 2D flow expands (i.e. duplication of the exit/expansion loss). The latest release has a new feature to automatically adjust 1D culvert losses based on the 2D approach/departure velocities as what happens with a 1D-1D-1D arrangement. See this [https://downloads.tuflow.com/_archive/Publications/Modelling%20of%20Bends%20and%20Hydraulic%20Structures%20in%20a%202D%20Scheme,%20Syme,%202001.pdf paper] for more information.
** HX connections may cause instability, especially with a skewed culvert outlet, but can produce better velocity patterns downstream of the culvert to model the expansion losses, which will be occurring in the 2D domain.
** Given that the SX connection applies the flow going out of the 1D culvert as a source term without momentum, it is difficult to completely prevent the water from piling up. If required, wingwalls can be modelled as thin breaklines to help guide the water away. Using the SX boundary Z flag lowers other SX cells below the 1D culvert invert level and it can mitigate the water from piling up.

== What entry/exit loss and contraction coefficients should I use for 1D culverts? ==
We don’t provide hard recommendations on the exit and entry losses to use for culverts as we have found different organisations around the world, typically government, have their own guidelines for different types of inlets configurations and require these to be used, for example, the Queensland Urban Drainage Manual (QUDM). However, it is very important to understand how losses are applied and that different 1D solvers may treat them differently. For cross-checking your results from any hydraulic modelling software, a simple calculation applying the entry and exit losses (allowing for any automatic adjustments as discussed below) to the computed head (V2/2g), plus allowing any surface roughness losses (Manning's equation) for longer culverts, is the best practice for culverts flowing in a sub-critical flow condition (i.e. downstream controlled flow). 

For the entrance loss values, the approach should be to use values as quoted in the literature or guidelines for the inlet shape and design unless there is evidence to use another value (e.g. comparison with reliable calibration data would indicate different energy losses).

For the exit loss a value of 1.0 is recommended in nearly all situations provided losses are being adjusted every timestep. A value of 1.0 with adjusted losses is derived from the fluid flow physics (momentum or energy conservation) for expanding flow and will be the most precise approach for modelling exit losses or to apply a bend loss to the approach/departure channel if these are modelled in 1D.

Occasionally there are situations where non-standard entrance and exit loss values are needed. A good example is if the approach or departure flow is skewed to the culvert direction. In these situations there may also be a significant bend (energy) loss occurring as the water changes direction entering or leaving the structure. To account for this the modeller may need to increase the entrance and/or exit loss values. 

By default, TUFLOW adjusts the entrance and exit losses of 1D structures flowing sub-critical every timestep based on the approach/departure velocities for 1D-1D-1D and with a new feature in the 2020-10-AA build for 2D-1D-2D. The entrance losses are adjusted based on an empirical relationship from flume testing whilst the exit loss equation is theoretically derived as mentioned above - refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. The modeller should be familiar with the approach taken by the software they are using as some software either don't adjust for approach/departure velocities at structures (will overestimate losses using standard values) and some may apply a limiting loss thereby not allowing the losses to sufficiently reduce.

TUFLOW, by default, allows the losses to reduce to effectively a zero loss coefficient (i.e. 0.0001). A zero loss occurs where the approach and departure velocity is the same as the structure velocity. For example, a clear-spanning bridge over a concrete lined channel with the water level below the bridge deck will experience no energy losses until the bridge deck is surcharged so if your software is applying unadjusted or limited energy loss coefficients there will be an unrealistic energy loss at the structure for flow below the bridge deck. For culverts, in most cases there will be some losses as it is rare that the channel is of identical shape and slope to the culvert with usually the culvert being more constrictive and therefore a higher velocity so the adjusted coefficients are nearly always non-zero. At the other extreme is flow from or into a near still body of water (e.g. a lake or the ocean). In this situation the loss coefficient(s) will not be reduced and the maximum energy loss possible should occur.

If the default adjust losses approach is used (<tt>Structure Losses</tt> <tt>==</tt><tt> ADJUST</tt>) the recommendations are to use industry guidelines for the entrance loss coefficient based on the shape/design of the inlet (these coefficients are typically based on a near zero approach velocity), and to use 1.0 for the exit loss coefficient. This applies to 1D culverts connected to 1D channels. The adjusted entrance and exit losses can be viewed over time in the _TSL layer, refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. 

Since the 2020-10-AA release, TUFLOW has a new (beta functionality) to have the losses automatically adjusted for linked 1D culverts and other structures connected to 2D domains through SX links (<tt>Structure Losses SX</tt> <tt>==</tt><tt> ADJUST</tt>), see Section 6.2 from the [https://downloads.tuflow.com/TUFLOW/Releases/2020-10/TUFLOW%20Release%20Notes.2020-10-AA.pdf 2020-10 Release Notes]. 

The other values to consider for modelling culverts are the inlet contraction coefficients used when the flow is upstream controlled flow should this occur. Typically the TUFLOW default values for these values should be used unless the inlet shape and design indicates otherwise. 

== Should I model pits as R or Q type? ==
Q pits are recommended for modelling kerb inlets, catchpits, drains, etc., provided that appropriate y-Q curves are available. TUFLOW automatically extends the y-Q curve for higher depths based on the orifice equation. Under downstream controlled flow regime it reverts to a drowned condition. 
When using the R pit, whilst the pit is free-falling into the pipe system below (most of the time until the system surcharges), entrance/exit losses don't apply, because the flow is inlet controlled. The R pit would be using the weir equation for unsubmerged flow or orifice flow for submerged flow and could be a poor representation of the pit flow behaviour, especially if the pit also has a grate and other non-rectangular characteristics.

== How to model pipe network with some pipe data missing? ==
In situations where the complete pipe network is not modelled there are numerous common approaches adopted by modellers:
* Use direct rainfall boundary conditions, model all inlets, only model the larger pipes in the pipe network. Where a small pipe is being omitted, connect the flows from the inlet to the main pipe network using virtual pipes functionality. Only the location of the inlet pits are needed, they can be approximated and sometimes lumped representation of the pits. This approach is especially good if the pipe network does not surcharge back to the overland flow anywhere or only in a minor way.
* Use lumped hydrology inflows. Only model the main pipe network and connected inlets (excluding the smaller features). Apply the flows directly to the pits either with:
** 1d_bc QT polygon boundaries with a P flag. This automatically distributes the total flow to all the pits within the polygon.
** 2d_sa boundaries with a "Read GIS SA PITS" command. The flow is applied to the ground surface rather than directly into the manhole. Some of the flow will surcharge out of the pits if the downstream pipe capacity is exceeded.

== How can I get more inflow into the pipe system? ==
A shallow depth can occur in the pit inlet cell and underestimate the depth at the entrance to the pit, restricting the amount of flow entering the pit. This can happen specifically for larger cell sizes. Different options to capture more water from 2D cells into the pits are available based on the TUFLOW engine. Both approaches aim to account for changes in ground elevation that occur at a finer scale than the 2D cell resolution:
*TUFLOW HPC - use Sub-Grid Sampling (SGS) - this approach samples underlying DEM with finer resolution and represents the true topography more accurately guiding water into the pits.
*TUFLOW Classic - use "Pit Default Road Crossfall" command to increase the depth at Q pits based on the crossfall slope of the road cross section. TUFLOW calculates the water depth that is used by the Pit Inlet Database using an adjacent side triangle depth approach, instead of the actual cell flow depth.

== How is flow through the culvert calculated? ==
Computationally, information is passed between the 1D and 2D on the half timestep:
* Flow through the culvert is calculated based on the water levels at the inlet/outlet and the assigned flow regime. The volume is extracted/added to the 2D boundary cells on the half timestep.
* On the next full timestep the 1D and 2D shallow water equations are applied to move water through their respective domains.

== What should I do if 1D pump doesn't convey as much flow as expected and/or seems to be unstable? ==
A couple of things can be checked:
* The inlet of the pipe has to be fully submerged, otherwise the pump will shut down and there will be no flow through the pump.
* Add extra storage to the node upstream of the pump with 1d_na table or 1d_nwk type NODE through ANA attribute.
* Try reasonably smaller 1D timestep.
* If using non-operational pump (P), check if the depth discharge relationship is appropriate. If outlet of the pipe is lower than inlet, the pump will always try to pump at full capacity.
* Consider using operational pump (PO), where the pump would switch off if the water level upstream gets below the pump soffit.

== How BB bridges automatically switch between pressure flow and being drowned out? ==
TUFLOW considers the top of the XZ or HW table as the soffit level. If the downstream water level exceeds the soffit level, TUFLOW does the pressure flow calculation using default K = 1.56. It compares the velocity calculated by the pressure flow equation and by the form loss calculation based on LC table and uses the smaller one.
The _TSF and _TSL layers can be used to find out the regime/form loss values used for BB bridges:
*"P": pressure flow
*"D": ds water level > the soffit level, but it applies normal flow because the normal flow equation predicts smaller velocity
*" ": ds water level < the soffit level, normal flow

== Should I model bridges in the 1D or 2D Domain? ==
The recommended approach typically depends on the study objectives and if the channel upstream and downstream of the bridge is modelled in 1D or 2D. To preserve the momentum as accurately as possible the bridge should be modelled in the same dimension as the channel, e.g. 1d_nwk bridge if the channels is in 1D and 2d_bg or 2d_lfcsh if the channel is modelled in 2D. 
In 2D, the expansion/contraction losses are modelled based on the topography and don't need to be estimated as attributes as for 1D modelling. Also, for higher flows where the bridge is overtopped, 2D is preferable approach.

== What is the difference between downstream and upstream controlled flow? ==
Downstream control means a change in downstream water level will cause a change in upstream water level. Upstream control means the upstream water level is insensitive to the downstream water level and usually indicates the occurrence of supercritical flow.

== How do negative "M", "N" and "R" values deactivate 1D cross-sections? ==
When negative “M” values are used to deactivate 1D cross-sections, it changes the flow area, wetted perimeter, hydraulic radius, and the conveyance, while keeping the storage width unchanged. It is like inserting a thin plate at the middle of the channel, as shown in the figure below. This approach is preferred to retain the storage in the system but reduce the conveyance (e.g., off-stream storage not contributing to conveyance or sections either side of a constriction to generate better approach/departure velocities if using the Total Area approach). 
 
[[File:Section deactivation M.png | 200px]] 
When using negative “N” (Manning’s n) or “R” (relative resistance factor) to deactivate the 1D cross-sections, it reduces both the flow area and the storage width, as shown in the figure below. 
 
[[File:Section deactivation N R.png | 200px]]

==Calculating a 1d_bc head-discharge curve==

As of the 2023-03-AD release, it is possible for TUFLOW to automatically create a Head-Discharge curve for 1d_bc HQ boundaries. For more information see Section 3.5 of the [https://docs.tuflow.com/classic-hpc/release/2023-03-AE/OneDSolv-1.html#Auto1DHQ-2 2023-03 Release Notes].

If using older releases, this can be calculated manually as the condition to be satisfied for a normal depth is the Manning’s equation. The HQ depth should be set up with elevation and the discharge calculated from Manning’s equation (including Area and Hydraulic Radius for each elevation point) and can be calculated in a few steps: 

<ol>
<li>Set the model up your ESTRY model using a dummy downstream level boundary (e.g. a HQ boundary with no name, an error will be reported however the required check file will have been produced, otherwise any boundary will work) and run the model in test model (-t) so that check files are produced.
<li>From the check folder, open the '''*_1d_ta_tables.csv''' file.
<li>Find the entry for the most downstream cross-section (directly upstream of the 1d_bc HQ point). The '''*_1d_ta_tables.csv''' will contain a table of hydraulic parameters. The K entry highlighted is the cross-section conveyance in m3/s and is calculated as: 

K = 1/n * A * R2/3 

Where
* A is the Eff Area
* R is the Radius
 
[[File:Ta tables example.png | 800px ]] 

<li>Determine a representative slope (S), this could be taken from the last two cross-sections.
<li>Calculate the downstream Discharge (this is the same as calculated discharge from Mannings equation): 

Q = K * SQRT(S) 

Where:
* S is a representative slope value for the downstream reach.
* K is obtained from the '''1d_ta_tables.csv'''

<li>Use the Elevation (Head) vs Discharge pairs to populate the HQ table.
</ol>

==Why is the maximum 1D water level higher than 2D water level?==
TUFLOW calculates storage at 1D nodes (including manholes) and calculates flux at pipe mid-sections. The storages at the manholes are saved in the format of ‘elevation vs nodal area’ tables, which can be reviewed in the .eof file: 
[[File:1DpitHmax 1.png]] 

The change in water volume in a manhole is calculated based on the inflow from the pit above (if there is one) and the inflow/outflow from the connected pipes. The change in water level is then calculated based on the change in volume and the nodal area at that elevation. 
[[File:1DpitHmax 2.png | 300px ]] 

TUFLOW extends the ‘elevation vs nodal area’ table by 5 m (the last 2 numbers in the table above), which allows for the calculation of pressurised pipe flow when a manhole is drowned. If the maximum 1D water level is higher than the DEM, that means the manhole was drowned and pressurised during the peak of the flood. 
[[File:1DpitHmax 3.png | 300px ]] 

==How to represent the hydraulic behavior at the outlet of a pipe, including headwalls and transitions to open channels? ==
In general, pipe outlet headwalls affect the exit loss at the pipe outlet, and this can be modeled by changing the 1d_nwk “ExitC_or_WSb” attribute - exit loss coefficient for outlet controlled flow. The default exit loss coefficient is 1.0, assuming there is no headwall. For more details on these factors, refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual].
More guidance on applying entry/loss and contraction coefficients is available [[TUFLOW_1D_Channels_and_Hydraulic_Structures#What_entry.2Fexit_loss_and_contraction_coefficients_should_I_use_for_1D_culverts.3F | here]].

Once the water is in the 2D domain, headwalls can also affect the local flow field. The modelled hydraulic behavior depends on the model cell size. If the model has grid size smaller than the length of the headwall, thin breaklines or 2d_zsh tin can be added to represent the geometry in the 2D model. If the grid size is larger than the headwall, it only calculates ‘cell-averaged’ velocity including the impact of the headwall.

==Calculating velocity and bed shear stress at a pipe outlet==
The velocity and bed shear stress reported in the 2D domain at a pipe outlet depends on the model cell size. If the cell size is small enough and any outlets structures (i.e. wingwalls) are properly represented by the 2d cell/face elevations, TUFLOW can reasonably represent the flow field at the pipe outlet and estimate the bed shear stress base on the manning’s equation. However, be aware that TUFLOW solves 2D depth-averaged shallow water equation, so there is limitation of using it to estimate bed shear stress around complex structures or geometry that could experience vertical acceleration or re-circulation.

== How do I model blockage for irregular shaped culverts or channels? ==
For irregular shaped culverts and channels (1d_nwk "I" type), it is possible to model blockage by using the Skew (in degrees) attribute in the 1d_xs layer. This reduces the effective flow width of the cross section by rotating it relative to the direction of flow and can be used to approximate reduced capacity.

A skew angle of 0 means the cross section is aligned with the flow. As the angle increases, the effective width is reduced. For example, a skew of 60 degrees results results in a 50% reduction (as cos(60) = 0.5). While this does reduce the effective width of the structure, it isn’t expected to see the same reduction to conveyance as conveyance depends on the Manning’s n value, flow area and hydraulic radius.

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

Run TUFLOW From a Batch-file

2025-03-26T03:18:38Z

ElizaCollison: /* No Console Option */

TUFLOW simulations can also be started from a batch file. Batch files are text files which contain a series of commands. Batch files allow a large degree of flexibility in starting TUFLOW simulations, advanced batch files can be used to:

* Run multiple simulations
* Set CPU priority for TUFLOW simulations
* Create a wait (e.g. start a simulation in 1 hour)
* Test simulation input
* Copy a TUFLOW model
* Package a TUFLOW model
* Post process results after simulation has finished.
Batch files are executed by double clicking the created .bat file from Windows Explorer.
<ol>
==Simple batch file==
To use a batch file, create a new text file in the TUFLOW\runs directory. The name is arbitrary but the file must have the extension ".bat". For example the file name could be '''_run_TUFLOW.bat'''.

Open this file in a text editor and add the following line.

<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
This is the simplest command line for starting TUFLOW, the line above contains only two arguments, the first is the path to the TUFLOW executable and the second argument "M01_5m_001.tcf" is the simulation file name. Depending on the location of the executable the above command line will need to be modified. The quotations around the TUFLOW executable and the .tcf file name are only required if there are spaces in the file names. However, it is recommended to include these to avoid problems.

==Batch File Switches==
These switches are available in all batch files, they are not specific to TUFLOW.

===Pause===
A second line with the text "pause" can be added, this will prompt the user to press a key at the end of the batch file. This is useful if the DOS window disappears from the screen, before you can read the output. The pause command will keep the window open.
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"
pause</pre>

===Starting process in new window===
In order to run multiple simulations at the same time, each simulation needs be started in a new console window. To do this begin the batch file line with the "Start" command, a for the window is then added. For example, to start the simulation above in a new window titled "TUFLOW" the following would be used.

<pre>Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
===Wait===
If multiple simulations are to be run, it is often desirable to run these in series, i.e. the second simulation starts after the first has finished. a /wait switch can be added which makes the batch file wait until the process is finished before moving onto the next command. 
An example of this is: 
<pre>Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>
Without the wait command, both simulations would start at the same time. 
'''Note:''' Unless there is a third simulation in the batch file the /wait command in the second line is not required, this prevents the batchfile from moving onto the third line.
===Setting a priority===
The priority of a process (such a TUFLOW simulation) can be specified within a batch file. This can be useful for a number of reasons:
*Lowering the priority of a simulation to allow you to continue working;
*Setting a high priority for critical runs; or
*Making sure you runs are high priority on a shared computing resource!

The following are valid priority switches (in increasing order of priority):
*/LOW
*/BELOWNORMAL
*/NORMAL
*/ABOVENORMAL
*/HIGH
*/REALTIME

An example of a low priority simulation is: 
<pre>start "TUFLOW" /low "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
'''TIP:''' The priority of a TUFLOW simulation can be changed at a later stage by using the '''Windows Task Manager''', navigate to the '''Processes''' tab and right click on the TUFLOW process (e.g. TUFLOW_iSP_w64.exe) and select the set priority option.

===Minimising the console window===
Using the /min switch will keep the console window for TUFLOW models minimised, so it doesn't pop up to the front every time when the next model starts.
<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>

==No Console Option==
Using the -nc switch will run a simulation without opening a DOS console window. This option is desirable for people running simulation on the cloud. Note, if an invalid .tcf file is specified, the simulation stops and returns an error level of 1 to the operating system.

<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_5m_001.tcf
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_2.5m_001.tcf</pre>

It is possible to get a text output of the console using:
<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_5m_001.tcf > M01_5m_001.txt
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_2.5m_001.tcf > M01_2.5m_001.txt</pre>

== TUFLOW switches in a batch file==
These switches are specific to TUFLOW simulations.
===Testing a simulation===
The -t (test) switch is very useful for testing the data input without running the simulation. It is good practice to use this switch before carrying out the simulations, as this will tell you whether there are any data input problems. The -t switch runs TUFLOW to just before it starts the hydrodynamic computations.
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -t "M01_5m_001.tcf"</pre>

===Batch mode in TUFLOW===
The use of the –b (batch) switch which suppresses the need to press the return key at the end of a simulation. This ensures that one simulation proceeds on to the next without any need for user input. This is required for running multiple simulations in series (one after the other).
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b "M01_5m_001.tcf"</pre>

===Automatically Create Folders in a TUFLOW model===
The use of the -acf (automatically create folders) switch prevents the dialog prompt from appearing when encountering non-existent folders (ie. results folders), and creates these folders automatically. If for any reason the folder can't be created, a dialog will appear. This feature was first introduced for Build 2012-05-AE and is not available for TUFLOW builds prior to this. For models simulated with Build 2013-12-AA or later, non-existent folders are now automatically created. If you would prefer to have the create folder query dialog to appear, you can specify the –qcf run time option (stands for query create folders). 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -acf "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Suppress Queries in a TUFLOW model===
The use of the -nq (no queries) switch prevents the termination query dialog from displaying when Ctrl+C is pressed to terminate a simulation cleanly. If –nq is specified and Ctrl-C is pressed, the simulation terminates cleanly without a query dialog to check you are certain, so be careful! This feature was first introduced for Build 2012-05-AE and is not available for TUFLOW builds prior to this. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nq "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Copy a TUFLOW model===
TUFLOW can be run in copy mode, which can be useful for transferring a model to another site or for making an archive of the input data. 

To copy a TUFLOW model, the '''-c''' switch must be included on the TUFLOW command line, as a minimum. The '''-c''' switch copies only the files read by TUFLOW. As such, for MapInfo users, the .mif and .mid files read by TUFLOW will be copied. The remaining MapInfo format files (.tab, .id, .dat and .map) are not read by TUFLOW and will not be copied. By default, the '''-c''' switch copies all TUFLOW inputs for the simulation into a subdirectory where the .tcf is located (generally TUFLOW\runs\). 

Additional optional flags can be added to the base '''-c''' switch, in any combination, including: 
;* “a” (all); 
: The addition of the “a” flag (e.g. -ca) copies all files of the same name for all input files (ie. same name, but different extensions). This option is particularly useful if the .tab and other associated files of a GIS layer need to be archived or delivered. 
;*“L” (list); 
: The addition of the “L” flag will output the files used by TUFLOW into a .tcl (TUFLOW Copy List) file but not copy the files to a destination folder. This can be useful if scripting the copying of models. To run the copy list the character “L” needs to be specified after the -c input argument. This works for all copy options, for example, the following are all valid; -cL, -caL, -capL. The .tcl file produced is output in the same directory as the .tcf and takes the simulation name.
;* “p” (path); and 
: The addition of the “p” flag (e.g. -cp) allows the user to specify an alternate path in which to copy the model. Without this flag, the location defaults to the .tcf’s location. For example, specifying the following, will place a copy of the model into a folder C:\put_model_here: 
REM <tt>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cp "C:\put_model_here" "C:\TUFLOW\runs\M01_5m_001.tcf"</tt> 
;* “ncf” (no check files) 
: The addition of the “ncf” flag (e.g. -cncf) copies the essential input files and excludes all check files. 

Note that these optional flags can be added in any combination to the base '''-c''' switch (e.g.
-c, -ca, -cp, -cncf, -cap, -cancf, -cpncf, -capncf). 

Specifying '''-c''' on the TUFLOW command line creates a folder “<.tcf filename>_copy” (or “<.tcf filename>_copy_all” if the “a” flag is added) in the same location as the .tcf file. Under the folder, input files are copied (including the full folder structure), and any check files and output folders created. For example, specifying: 
: <tt>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -c “C:\tuflow_models\my model.tcf”</tt> will make a copy of the TUFLOW model based on the file <tt>“my model.tcf”</tt> in a folder <tt>"my model.tcf_copy"</tt>, or <tt>"my model.tcf_copy_all"</tt> if using the “a” flag. 

'''Note:'''
<ol>
<li> Use the full path to the .tcf file (this is the default if running from UltraEdit or using the right click approach).
<li>Make sure there is sufficient disk space (no checks for sufficient disk space are made).
<li>Output folders and some output files are created but these will be empty.
<li>Any check folder(s) are created and check files written (these can be deleted if wishing to minimise the size of the folder).
<li>The full path of the input files is reproduced to provide traceability and also handle inputs from other drives and URLs. Drive letters are replaced, for example, “C:” becomes a folder “C Drive”. URLs (denoted by “\\” or “//” at the beginning of the path) are replaced by a folder called “URL\”.
<li>To run the copied .tcf file, it will be necessary to change any non-relative pathnames according to the point above. Alternatively you can share and then map, for example, the “D Drive” folder as “D:”.
<li>The Check MI Save Date will need to be set to WARNING or OFF in the .tcf file if the –ca option has not been used as the .tab and other files will not have been copied.
<li>There is a limit of 1,000 characters (including spaces) on pathnames. As very long pathnames can result due to the above approach, if the number of characters exceeds 1,000, problems may occur.
<li>The -c switch automatically invokes the -t (ie. the simulation does not commence, only the input data is tested/checked).
<li>The -b option still applies if several models wish to be copied using a batch (.bat) file.
</ol> 

An example that copies all files (-ca switch) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -ca "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example that copies all files to an alternate path (-cap) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cap "C:\Copy_of_model" "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example that copies all files to an alternate path, excluding any check files, (-capncf) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -capncf "C:\Copy_of_model" "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Package a TUFLOW model===
Package model function attempts to copy all input files for all events and scenarios defined in the model, if only single set of events and scenarios is required, -c is preferable. Unlike the -c option, -pm does not read and process the data during the file copy, as such it is substantially faster than -c. The package model function does not require access to a TUFLOW licence.

A tool in QGIS (as part of the TUFLOW Plugin) exists which provides a dialog to the package model options, which allows users to bypass the creation of a batch file: 
[[Package_Model_in_QGIS | Package Model in QGIS]]

Additional optional flags can be added to the base '''-pm''' switch, in any combination, including: 
;* “All”; 
: The addition of the “All” flag (e.g. -pmAll) copies all file extensions (e.g. 1d_nwk_culv_L.mif, will become 1d_nwk_culv_L.*). 
;* “L” (list); and 
: The addition of the “L” flag (e.g. -pmL) list the files to be copied into an output file, but don’t copy. 
;* “ini” (file.ini) 
: The addition of the “ini” flag (e.g. -pmini) provides a .ini file with user defined options. A .ini file can be used to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames. Valid options should be separated by a vertical bar. 

Combinations of the above are also valid, with the order of the optional switches not being important (-pmAllL would be treated the same as -pmLAll). 
When using package model the default destination folder is created in the same directory as the .tcf file, with the prefix “pm_”. For example, C:\Projects\Modelling\TUFLOW\runs\Run_001.tcf will create a package in the folder “C:\Projects\Modelling\TUFLOW\runs\pm_Run_001\. 

Three options are also available for handling of the binary processed files created by TUFLOW to speed up the simulation start. These options are: 
;* “-xf0”; 
: Do not copy .xf files, only the original inputs are copied. 
;* “-xf1”; and 
: Copy both raw input files and .xf files. 
;* “-xf2” 
: Copy only .xf files, if xf files exist for an input only the xf will be copied. 
 
An example of package model that copies all files is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAll "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of package model that copies all files except .xf files, (-pmAll -xf0) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAll -xf0 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of package model that copies all files with specified .ini file (-pmAllini) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAllini package.ini "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of .ini file to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames: 
<pre>
Base Folder == <folder>
Copy Destination == <folder>
Model Scenario ~s<number>~ == <scenario A> | <scenario B> | …
Model Event ~e<number>~ == <event A> | <event B> | …
</pre>

===GPU Module Control===
The -pu switch can be used to select which GPU card or cards to direct the simulation towards. –pu must be specified once for each device. For example, to direct the simulation to GPU devices 0 and 2, specify -pu0 -pu2. (Note: the GPU device numbering starts a 0, not 1). For example:
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pu0 -pu2 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Event and Scenario Management===
The -e and -s switches can be used to manage multiple events and scenarios from a single tuflow control file. The -e and -s wildcard is replaced by the following entry specified in the batch file. For example, the following batch file commands will run two simulations in series:
* M01_Q050_24hr_2m_Dev_001.tcf; and
* M01_Q100_24hr_2m_Dev_001.tcf;

<pre>Start "TUFLOW" /wait "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 Q050 -e2 24hr -s1 2m -s2 Dev "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_~e1~_~e2~_~s1~_s2~_001.tcf"
Start "TUFLOW" /wait "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 Q100 -e2 24hr -s1 2m -s2 Dev "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_~e1~_~e2~_~s1~_s2~_001.tcf"</pre>

Please be aware that the % symbol is a special character in a batch file. If the % symbol is used within a wildcard, it will not be read when searching for that wildcard in TUFLOW. 
For example if the following event wildcard is used; 
*-e 10% 
TUFLOW will search for '10' instead of '10%' as the event wildcard. 
 
It is recommended that modellers avoid the use of a % symbol in any wildcard values. The string 'pct' is a great alternative for the % symbol. 
For example, using: 
*-e 10pct 
Alternatively, using the % symbol twice in a row as shown below should result in a desired wildcard value. 
*-e 10%% (TUFLOW will search for 10%)

===Set Hardware===
The -hwgpu or -hwcpu switches can be used overwrite any "Hardware ==' command specified in the .tcf to GPU or CPU, respectively. This feature was first introduced for Build 2023-03-AB and is not available for TUFLOW builds prior to this.

These switches can be used in conjunction with the -nt (number of threads) or -pu (processing unit id) to provide full control over the hardware usage via the command line.

The following command could be used to run a model with CPU hardware on 8 threads:
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -hwcpu -nt8 FS_Hardware_01.tcf </pre>

The following command could be used to run a model on GPU hardware using 2 devices (GPU 0 and GPU1):
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -hwgpu -pu0 -pu1 FS_Hardware_01.tcf </pre>

===Set Start Time for a Simulation===
The use of the -st<time_in_hours> (start time) switch allows the user to specify the start time for a simulation. Any start time specified via this run option argument is given the highest priority and overrides the "Start Time ==" settings in the .tcf, event files (.tef) and override files. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -st0 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Set End Time for a Simulation===
The use of the -et<time_in_hours> (end time) switch allows the user to specify the end time for a simulation. Any end time specified via this run option argument is given the highest priority and overrides the "End Time ==" settings in the .tcf, event files (.tef) and override files. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -et3 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Suppress Message Box Prompts===
The use of the -nmb (no message boxes) switch suppresses the use of Windows message boxes to prompt the user. All prompts will be via the console window. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nmb "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Search for a Network License===
The use of the -nwk (network) switch forces TUFLOW to search for a network licence. I.e. Skip the search for a local license. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nwk "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Search for a WIBU License===
The use of the -wibu (WIBU license) switch forces TUFLOW to search only for a WIBU Codemeter license. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -wibu "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Specify the Output Drive===
The -od<drive> (output drive) switch allows the user to specify the Output Drive for a simulation. 
For example, the following will redirect all outputs to the C:\ drive: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -odC "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Specify Map Output===
The -oz<name> (output zone) switch specifies that the map output includes the input zone. 
For example, the following would include output for 'Zone A': 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -ozZoneA "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Query the Creation of a Folder===
The -qcf (query the creation of a folder) switch is useful if you would prefer to have the create folder query dialog appear (rather than TUFLOW automatically creating folders - see [[Run_TUFLOW_From_a_Batch-file#Automatically_Create_Folders_in_a_TUFLOW_model | -acf]]). 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -qcf "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Execute a Simulation (the Default)===
The -x (execute) switch executes the simulation. This switch is used by default and does not need to be included on the TUFLOW command line.

===Copy or Test Model License Free===
For Build 2018-03-AA or later, it is possible to use the [[Run_TUFLOW_From_a_Batch-file#Copy_a_TUFLOW_model | copy model]] (-c option) or [[Run_TUFLOW_From_a_Batch-file#Testing_a_simulation | test model]] (-t option) without using a license. To utilise this licence free copy/test, the -nlc (no license check) input argument must be specified. If running without a TUFLOW licence, no diagnostic output is generated (e.g. messages layer). If these are required, the -nlc option must be removed.

===Simulation Log Path (Legacy)===
The -slp (simulation log path) switch is a legacy option for Solftlock (blue) dongles to set the path to a folder on the intranet to log all simulation initiated from the lock. Refer to the [https://www.tuflow.com/downloads/ TUFLOW Manual] (2018 or earlier) for details. 

==Advanced Batch Files==
The below section shows example batch files for maximizing run efficiency,
===Creating a delay===
====Windows 7 and newer====
For a Windows 7 and newer operating system a delay of a set duration can be created with the Timeout <seconds> command. For example: 
<pre>Timeout 10</pre>
Will create a 10 second delay, a countdown timer is given. Press any key to continue.

====Other Systems====
It is possible to create a delay of specified length in a batch file. The best way do this is actually to create a second batch file! To do this create a text file and call it '''wait.bat'''. Within that file enter the following text:
<pre>@ping 127.0.0.1 -n 2 -w 1000 > nul
@ping 127.0.0.1 -n %1% -w 1000> nul</pre>
To create the pause we ping an address for a set time and disregard the output. Once the wait.bat has been created, it can be called from another batchfile using the following syntax:
<pre>call wait <time in seconds.</pre>
In the example below, the first simulation is started and then 60 seconds later (using the wait.bat file) the second simulation is started. Note there is no /wait flag specified, if there was the batchfile would wait for 60 seconds after the first simulation had finished before starting the second simulation.
<pre>Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
call wait 60
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>
For this to work the wait.bat file needs to be in the same folder as the batchfile calling it. You can put the file in a specific location and add this path as an environment variable. If this is done "call wait <time in seconds> can be added to any batch file. 
To set the environment variable, you will need to have administrator access to the machine, and add a colon (;) and then the batchfile location (e.g. "C:\batch_files\" , without the quotes) in the '''path''' system variables. The separator character is a colon (;) this is added to specify a new path. For more details on modifying the environment please see here: [https://support.microsoft.com/kb/310519 https://support.microsoft.com/kb/310519].

===Variables===
Batch files can be easily setup so that they are more generic and easily customised when moving from one project to another. For example, in the below a variable, TUFLOWEXE, is used to define the path to the TUFLOW exe to be used, and a variable RUN is used to incorporate options such as the /wait so that the simulations run in series (one after the other).

<pre>set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
set RUN=start "TUFLOW" /wait %TUFLOWEXE% -b
%RUN% MR_H99_C25_Q100.tcf
%RUN% MR_H99_C25_Q050.tcf
%RUN% MR_H99_C25_Q020.tcf</pre>
The advantage of using variables is if the path to the TUFLOW exe changes, or to run a different version of TUFLOW, it is just a simple change in the .bat file. In the above, note the use of quotes the TUFLOW executable path – quotes are needed around file pathnames whenever they contain a space.

===Looping in a batch file===
If you have a large number of events to run using the event files a for loop can be used in a batch file. In this example we have 5 event magnitudes (-e1 input) and 5 event durations (-e2 input). The following batch file can be used to run all 25 simulations one after the other:
<pre>
@echo off

REM This sets the variables as local, so you can use another batch file with A and B variables
SetLocal

REM set up variables
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min

REM Loop Through
FOR %%a in (%A%) do (
FOR %%b in (%B%) DO (
start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf
)
)
pause
</pre>
In order to test the syntax, you can test the batch file by replacing the following line: 
<tt>start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt> 
With the following line: 
<tt>echo start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt> 
By using the echo in the command line, rather than starting the simulations the command line will be displayed in the DOS output. In the example above the DOS output is shown in the image below.
[[File:DOS nested batch output.png|frame|none]]

Alternatively this can be achieved using the following syntax, which is essentially the same but has the for loops compressed to a single line:
<pre>
@echo off
setlocal
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min

FOR %%a in (%A%) do FOR %%b in (%B%) do start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename_~e1~_~e2~.tcf
pause
</pre>
This can be extended to more variables for example:
<pre>
@echo off
setlocal
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min
set C=Exg Dev Mit

FOR %%a in (%A%) do (
FOR %%b in (%B%) do (
FOR %%c in (%C%) do (
start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b -s1 %%c filename_~e1~_~e2~_~s1~.tcf
)
)
)
pause
</pre>

===Looping in a batch file up to a certain number of runs===
The below example shows a method for controlling the number of concurrent simulations. 

As a brief description of the below, the "do_while_loop_start" counts the number of processes in the task manager which have "TUFLOW" in the name. If this is greater than or equal to the variable "CPU_Cores" then the batch file waits for 60 seconds.

<pre>
@ echo off

Set A=Q001 Q002 Q005 Q010 Q020 Q050 Q100
Set B=Exg Dev
set /a CPU_Cores=3

FOR %%a in (%A%) DO (
FOR %%b in (%B%) DO (
call :do_while_loop_start
Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
)
)

Pause

:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
if %count% geq %CPU_Cores% (
PING 1.1.1.1 -n 1 -w 60000 >NUL
goto do_while_loop_start
)
</pre>

Another way to achieve the same result using IF logic is shown below. This batch file will loop through the series of 14 simulations in groups of three. The batch file will pause until the last of the three active model simulations are complete. When complete, the next series of three simulations will be started in parallel.

<pre>
@ echo off
setlocal enabledelayedexpansion

SET A=Q001 Q002 Q005 Q010 Q020 Q050 Q100
SET B=Exg Dev
SET P=3

SET /A Counter=0
FOR %%a in (%A%) DO (
FOR %%b in (%B%) DO (
SET /A Counter+=1
IF /i !Counter!==!P! (
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
SET /A Counter=0
) ELSE (
Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
)
)
)
</pre>

===Looping in a batch file using scenario logic===
Sometimes when using different scenarios, it is useful to run a specific set of events for one scenario but other events for a different scenario. 
This can be automated within looped batch files using a bit of logic. 
In the the example below there is model with defended and undefended scenarios. The defended scenario needs to be run for the 20, 100 and 200 year events but the undefended scenario is only run for the 100 year event. All models are run for the hr and 3hr critical durations. 
The below batch file also uses the looping up to a certain number of runs, as seen in the point above. 
To customize this script, alter the location of the TUFLOW executable, the name of tcf and the scenarios that you would like to run (Refer to 'Set A==', 'Set C==' and 'Set B=='). 
<pre>
@ echo off
setlocal enabledelayedexpansion

REM ______________SET RUN VARIABLES_____________
set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
set RUN=start "TUFLOW" /low %TUFLOWEXE% -b
set /a CPU_Cores=5

set tcf=M01_5m_~s1~_~e1~_~e2~_001.tcf

Set A=UDEF DEF
REM set B in loop beow
Set C==01hr 03hr

REM ______________SET LOOPS____________________
FOR %%a in (%A%) do (

REM _____DEFINE RUN LOGIC______
IF "%%a"=="UDEF" (
set B=100yr
)
IF "%%a"=="DEF" (
set B=020yr 100yr 200yr
)

REM ______________RUN LOOPS____________________
FOR %%b in (!B!) do (
FOR %%c in (%C%) do (
call :do_while_loop_start
%RUN% -s1 %%a -e1 %%b -e2 %%c %tcf%
timeout 60

)
)
)

REM ___________COUNT RUN INSTANCES______________
:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
if %count% geq %CPU_Cores% (
PING 1.1.1.1 -n 1 -w 60000 >NUL
goto do_while_loop_start
)

endlocal
</pre>

===Copy model, checks and results in a looped batch file===
This batch file uses the copy model function to copy the model (inputs and check files), of both scenarios 5m and 2.5m, to a specified folder location. After copying, [https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/robocopy robocopy] is used to copy the results, based off the tcf filename and specified scenarios, to the destination result folder.
<pre>
@echo off

set TUFLOWEXE_iSP="C:\Releases\2023-03-AF\TUFLOW_iSP_w64.exe"
set RUN_iSP=start "TUFLOW" /wait %TUFLOWEXE_iSP% -cp "D:\tuflow_models\copy"

set A=5m 2.5m
set source_results=..\results
set destination_results=C:\tuflow_models\copy\results

FOR %%a in (%A%) do (
:: Copy model
%RUN_iSP% -s1 %%a M01_~s1~_001.tcf

:: Copy results folder to copy model location
robocopy "%source_results%" "%destination_results%" "M01_%%a_001*" /S

)
pause
</pre>

===Coordinating Asynchronous Simulations===
This batch file will set off asynchronous runs on separate threads, and then wait for all runs to finish before moving to the next process. This example kicks off 8 tuflow.exe processes and then waits before collating (in fortran) and processing the results (in python). Both “combine_therad_outputs.exe” and “Post_process.py” are dummy programs only (with dummy arguments), and are included just to demonstrate how any sort of post processing might be called after the synchronisation of all TUFLOW simulations.

<pre>
@echo off

:: Set local
setlocal
:: User defined variables – will need to be changed
set "for_infile=inputs_fortran.inp"
set "run_exe="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe""
set "file_prefix=C:\temp\test"
set "sum_exe=combine_thread_outputs.exe"
set "n_threads=8"
set "pyt_code=Post_process.py"
set "pyt_infile=inputs_python.inp"

:: Random lock file
set "lock=%temp%\wait%random%.lock"

:: Launch processes asynchronously, with stream 9 redirected to a lock file.
:: The lock file will remain locked until the individual exe instance ends.
:: %%a is sent to %run_exe% as an argument to set the thread to use
for /L %%a in (0,1,7) do (
start "" 9>"%lock%%%a" %run_exe% %for_infile% %%a
)

:: Wait for the processes to finish
:Waitrun
1>nul 2>nul ping /n %n_threads% ::1
for /L %%N in (0,1,7) do (
(call ) 9>"%lock%%%N" || goto :Waitrun
) 2>nul

:: Delete the lock files
del "%lock%*"

:: Collate thread outputs
%sum_exe% %file_prefix% %n_threads%

:: Make image
python %pyt_code% %pyt_infile%

:: Finish up
echo Done.
</pre>

===Shutdown on Completion===
Often we may have a number of TUFLOW simulations going when we leave work on a Friday afternoon, if these are not going to take all weekend to run, using some of the batch file logic above you can create a batch file that will shutdown the computer when no TUFLOW simulations are running. An example batch file for this purpose is below: 
<pre>
echo off

:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
IF %count%==0 (
shutdown.exe /s /t 30
) ELSE (
timeout 60
goto do_while_loop_start
)
pause
</pre>
This batch file counts the number of processes with "TUFLOW" in the process name and if this is greater than 0, a delay of 60 seconds is created and the loop started again. If no "TUFLOW" simulations are running a shutdown command is issued. 
To test the batch file it is recommended that you add an "echo" in front of the <tt>shutdown.exe /s /t 30</tt> command to ensure it is working correctly (I use this on a Windows 7 machine, but have not tested it on either XP or Windows 8). 
In order to restart the machine rather than power it off the /s can be replaced with /r. This can be useful when a heavily utilised modelling computer needs a restart!
</ol>

TUFLOW XMDF Specification

2025-03-17T04:14:22Z

ElizaCollison:

This page describes the XMDF file structure written by TUFLOW. The [https://en.wikipedia.org/wiki/XMDF XMDF format] is an open format originally developed by Aquaveo and the general XMDF specifications are not described here.

===Important Notes===
* XMDF uses a directory like structure which TUFLOW utilises when writing outputs.
* XMDF supports Scalar and Vector type outputs.
** Scalar outputs contain a single value per node (depth, water level, etc)
** Vector outputs contain 2 values per node, an X and Y component (velocity, unit flow, etc)

===Specification===
Examples are given below of XMDF outputs from TUFLOW.

====Standard Outputs====
<pre>
Maximums/Water Level
Num of Times: 1
0.000

Maximums/Depth
Num of Times: 1
0.000

Maximums/Vector Velocity
Num of Times: 1
0.000

Temporal/Water Level
Num of Times: 7
0.000
0.500
1.000
1.500
2.000
2.500
3.000

Temporal/Depth
Num of Times: 7
0.000
0.500
1.000
1.500
2.000
2.500
3.000

Temporal/Vector Velocity
Num of Times: 7
0.000
0.500
1.000
1.500
2.000
2.500
3.000

Times/Time of Peak h
Num of Times: 1
0.000
</pre>

====Time Output Cutoff Depth====
<pre>
Times/Duration Above Depth 0.500m
Num Times 1
0.000

Times/Duration Above Depth 1.000m
Num of Times: 1
0.000

Times/Time of First Depth > 0.500m
Num of Times: 1
0.000

Times/Time of First Depth > 1.000m
Num of Times: 1
0.000
</pre>

====Time Output Cutoff VxD====
<pre>
Times/Duration Above Z0 0.500m2ps
Num of Times: 1
0.000

Times/Duration Above Z0 1.000m2ps
Num of Times: 1
0.000

Times/Time of First VxD > 0.500m2ps
Num of Times: 1
0.000

Times/Time of First VxD > 1.000m2ps
Num of Times: 1
0.000
</pre>

====Time Output Cutoff <Hazard>====
<pre>
Times/Duration Above ZAEM1 1.000
Num of Times: 1
0.000

Times/Duration Above ZAEM1 2.000
Num of Times: 1
0.000

Times/Time of First ZAEM1 > 1.
Num of Times: 1
0.000

Times/Time of First ZAEM1 > 2.
Num of Times: 1
0.000
</pre>

====GLO Outputs====
<pre>
Gauge Levels/GL 50.00 (000:44)/Water Level
Num of Times: 1
0.000

Gauge Levels/GL 50.00 (000:44)/Depth
Num of Times: 1
0.000

Gauge Levels/GL 50.00 (000:44)/Vector Velocity
Num of Times: 1
0.000

Gauge Levels/GL 51.00 (000:58)/Water Level
Num of Times: 1
0.000

Gauge Levels/GL 51.00 (000:58)/Depth
Num of Times: 1
0.000

Gauge Levels/GL 51.00 (000:58)/Vector Velocity
Num of Times: 1
0.000

Gauge Levels/GL 52.00 (001:16)/Water Level
Num of Times: 1
0.000

Gauge Levels/GL 52.00 (001:16)/Depth
Num of Times: 1
0.000

Gauge Levels/GL 52.00 (001:16)/Vector Velocity
Num of Times: 1
0.000
</pre>

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

TUFLOW Modelling Guidance

2025-03-17T04:11:31Z

ElizaCollison: /* TUFLOW Results */

This section of the TUFLOW Wiki provides modelling guidance supplementing the information in the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] and the [https://wiki.tuflow.com/Main_Page Tips and Tricks] Wiki pages for the 3rd Party software that support TUFLOW.

=Project Management=
* [[Estimating_Runtimes | Estimating Simulation Run Times]]
* [[Naming_Convention | TUFLOW Naming Convention]]
* [[TUFLOW_Modelling_Log | Modelling Log ]]
* [https://downloads.tuflow.com/Training/Modelling_Log_and_Review_Template.zip Quality Assurance Reviewer Spreadsheet Download].
 

=Hydrology=
* [[QGIS_ARR_to_TUFLOW | Australian Rainfall and Runoff 2019]]
* [[Using ReFH2 to Generate TUFLOW Boundary Inputs | UK ReFH2 Processing]]
* [[QGIS_SCS_to_TUFLOW | U.S. Soil Conservation Service (SCS) Method]]
* [[Convert_to_TS1 | RORB, URBS, WBNM, XP RAFTS Convert to TS1 Utility]]
 

=TUFLOW Modelling=
* [[TUFLOW_General_Discussion| TUFLOW Software General Discussion]]
* [[GeoPackage_Tips| GeoPackage Data Format Tips]]
* [[TUFLOW_Check_Files | TUFLOW Check Files]]
* [[TUFLOW_Empty_Files | TUFLOW Template GIS (empty) Files]]
* [[TUFLOW 1D Channels and Hydraulic Structures | 1D Channels and Hydraulic Structures]]
* [[TUFLOW_2D_Hydraulic_Structures | 2D Hydraulic Structures]]
* [[TUFLOW_2D_Cell_Size_Selection | 2D Cell Size Selection]]
* [[Topography_Guidance | Topography Guidance]]
* [[TUFLOW_BC_Advice | Boundary Condition Advice (including 1D/2D and 2D/2D linking)]]
* [[Direct_Rainfall_(Rain_on_Grid)_Modelling_Guidance | Direct Rainfall (Rain on Grid) Modelling Guidance ]]
* [[HPC_Modelling_Guidance | HPC Modelling Guidance]]
* [[SWMM_Modelling_Guidance | SWMM Modelling Guidance]]
* [[Advection_Dispersion_Modelling | Advection Dispersion Modelling]]
* [[TUFLOW_Stability_Troubleshooting | TUFLOW Stability Troubleshooting]]
* [[TUFLOW_Simulation Speed | TUFLOW Simulation Speed, Storage and RAM Optimisation]]
* [[TUFLOW_Version_Backward_Compatibility | TUFLOW Executable Version Change Log]]
 

= TUFLOW Results=
* [[TUFLOW_Output_Discussion | General Simulation Output Discussion (Time Series, Grid and Binary Format)]]
* [[TUFLOW_XMDF_Specification | XMDF File Structure Description]]
* [[TUFLOW_QGIS_Plugin | TUFLOW QGIS Plugin]]
* [[TUFLOW_Remapping | TUFLOW Remapping Tool]]
* [[ARR_2019_Ensembles_Processing | Australian Rainfall and Runoff (ARR) 2019 Guideline Result Ensemble Processing]]
 

=Other=
* [[System_Requirements | System Requirements]]
* [[Hardware_Selection_Advice | Hardware Selection Advice]]
* [[New_User_Installation_Guide | Installation Guide for New Users]]
* [[Industry_Modelling_Guidelines | Industry Guidelines]]
* [[Modelling_Accuracy_Uncertainties_Impact_Mapping | Modelling Accuracy, Uncertainties and Flood Impact Mapping Tolerances]]
 
{{Tips Navigation
|uplink=[[ Main_Page | Back to Main Page]]
}}

TUFLOW Message 2323

2025-03-16T22:29:55Z

ElizaCollison:

{{TUFLOW_Message
|tuflow_message=ERROR 2323 - Problem with sending Soil Parameters for Soil ID <>
|alt_msg=NA
|type=[[ERROR]]
|message_desc=TUFLOW has hit a problem sending soil parameters to HPC.
|suggestions=If the .hpc.tlf reports "SCS infiltration requires cumulative rainfall field", turning on the RFC output (e.g. Map Output Data Types == RFC) will allow the model to run.

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
}}

TUFLOW Message 2323

2025-03-13T22:27:12Z

ElizaCollison:

{{TUFLOW_Message
|tuflow_message=ERROR 2323 - Problem with sending Soil Parameters for Soil ID <>
|alt_msg=NA
|type=[[ERROR]]
|message_desc=
|suggestions=

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
}}

TUFLOW Message 2323

2025-03-13T22:18:25Z

ElizaCollison: Created page with "{{TUFLOW_Message |tuflow_message=ERROR 2323 - Problem with sending Soil Parameters for Soil ID 99 |alt_msg=NA |type=ERROR |message_desc= |suggestions= |uplink=2xxx_TUFL..."

{{TUFLOW_Message
|tuflow_message=ERROR 2323 - Problem with sending Soil Parameters for Soil ID 99
|alt_msg=NA
|type=[[ERROR]]
|message_desc=
|suggestions=

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
}}

2xxx TUFLOW Messages

2025-03-13T22:17:02Z

ElizaCollison:

The 2xxx TUFLOW messages refer to issues that occur neither in the 2D model. Click on number to follow link to TUFLOW message description, grey numbers are reserved and do not yet have messages assigned, and red numbers have been allocated to new messages.

See also:
* [[0xxx TUFLOW Messages]]
* [[1xxx TUFLOW Messages]]
* [[3xxx TUFLOW Messages]]
* [[4xxx TUFLOW Messages]]
* [[5xxx TUFLOW Messages]]
* [[6xxx TUFLOW Messages]]

{| Border ="1" cellpadding="8" style="text-align:center"
|2000 || [[TUFLOW Message 2001|2001 ]] || [[TUFLOW Message 2002|2002 ]] || [[TUFLOW Message 2003|2003 ]] || [[TUFLOW Message 2004|2004 ]] || [[TUFLOW Message 2005|2005 ]] || [[TUFLOW Message 2006|2006 ]] || [[TUFLOW Message 2007|2007 ]] || [[TUFLOW Message 2008|2008 ]] || [[TUFLOW Message 2009|2009 ]] || [[TUFLOW Message 2010|2010 ]] || [[TUFLOW Message 2011|2011 ]] || [[TUFLOW Message 2012|2012 ]] || [[TUFLOW Message 2013|2013 ]] || [[TUFLOW Message 2014|2014 ]] || [[TUFLOW Message 2015|2015 ]] || [[TUFLOW Message 2016|2016 ]] || [[TUFLOW Message 2017|2017 ]] || [[TUFLOW Message 2018|2018 ]] || [[TUFLOW Message 2019|2019 ]]
|-
|[[TUFLOW Message 2020|2020 ]] || [[TUFLOW Message 2021|2021 ]] || [[TUFLOW Message 2022|2022 ]] || [[TUFLOW Message 2023|2023 ]] || [[TUFLOW Message 2024|2024 ]] || [[TUFLOW Message 2025|2025 ]] || [[TUFLOW Message 2026|2026 ]] || [[TUFLOW Message 2027|2027 ]] || [[TUFLOW Message 2028|2028 ]] || [[TUFLOW Message 2029|2029 ]] || [[TUFLOW Message 2030|2030 ]] || [[TUFLOW Message 2031|2031 ]] || [[TUFLOW Message 2032|2032 ]] || [[TUFLOW Message 2033|2033 ]] || [[TUFLOW Message 2034|2034 ]] || [[TUFLOW Message 2035|2035 ]] || [[TUFLOW Message 2036|2036 ]] || [[TUFLOW Message 2037|2037 ]] || [[TUFLOW Message 2038|2038 ]] || [[TUFLOW Message 2039|2039 ]]
|-
|[[TUFLOW Message 2040|2040 ]] || [[TUFLOW Message 2041|2041 ]] || [[TUFLOW Message 2042|2042 ]] || [[TUFLOW Message 2043|2043 ]] || [[TUFLOW Message 2044|2044 ]] || [[TUFLOW Message 2045|2045 ]] || [[TUFLOW Message 2046|2046 ]] || [[TUFLOW Message 2047|2047 ]] || [[TUFLOW Message 2048|2048 ]] || [[TUFLOW Message 2049|2049 ]] || [[TUFLOW Message 2050|2050 ]] || [[TUFLOW Message 2051|2051 ]] || [[TUFLOW Message 2052|2052 ]] || [[TUFLOW Message 2053|2053 ]] || [[TUFLOW Message 2054|2054 ]] || [[TUFLOW Message 2055|2055 ]] || [[TUFLOW Message 2056|2056 ]] || [[TUFLOW Message 2057|2057 ]] || [[TUFLOW Message 2058|2058 ]] || [[TUFLOW Message 2059|2059 ]]
|-
|[[TUFLOW Message 2060|2060 ]] || [[TUFLOW Message 2061|2061 ]] || [[TUFLOW Message 2062|2062 ]] || [[TUFLOW Message 2063|2063 ]] || [[TUFLOW Message 2064|2064 ]] || [[TUFLOW Message 2065|2065 ]] || [[TUFLOW Message 2066|2066 ]] || [[TUFLOW Message 2067|2067 ]] || [[TUFLOW Message 2068|2068 ]] || [[TUFLOW Message 2069|2069 ]] || [[TUFLOW Message 2070|2070 ]] || [[TUFLOW Message 2071|2071 ]] || [[TUFLOW Message 2072|2072 ]] || [[TUFLOW Message 2073|2073 ]] || [[TUFLOW Message 2074|2074 ]] || [[TUFLOW Message 2075|2075 ]] || [[TUFLOW Message 2076|2076 ]] || [[TUFLOW Message 2077|2077 ]] || [[TUFLOW Message 2078|2078 ]] || [[TUFLOW Message 2079|2079 ]]
|-
|[[TUFLOW Message 2080|2080 ]] || [[TUFLOW Message 2081|2081 ]] || [[TUFLOW Message 2082|2082 ]] || [[TUFLOW Message 2083|2083 ]] || [[TUFLOW Message 2084|2084 ]] || [[TUFLOW Message 2085|2085 ]] || [[TUFLOW Message 2086|2086 ]] || [[TUFLOW Message 2087|2087 ]] || [[TUFLOW Message 2088|2088 ]] || [[TUFLOW Message 2089|2089 ]] || [[TUFLOW Message 2090|2090 ]] || [[TUFLOW Message 2091|2091 ]] || [[TUFLOW Message 2092|2092 ]] || [[TUFLOW Message 2093|2093 ]] || [[TUFLOW Message 2094|2094 ]] || [[TUFLOW Message 2095|2095 ]] || [[TUFLOW Message 2096|2096 ]] || [[TUFLOW Message 2097|2097 ]] || [[TUFLOW Message 2098|2098 ]] || [[TUFLOW Message 2099|2099 ]]
|-
|[[TUFLOW Message 2100|2100 ]] || [[TUFLOW Message 2101|2101 ]] || [[TUFLOW Message 2102|2102 ]] || [[TUFLOW Message 2103|2103 ]] || [[TUFLOW Message 2104|2104 ]] || [[TUFLOW Message 2105|2105 ]] || [[TUFLOW Message 2106|2106 ]] || [[TUFLOW Message 2107|2107 ]] || [[TUFLOW Message 2108|2108 ]] || [[TUFLOW Message 2109|2109 ]] || [[TUFLOW Message 2110|2110 ]] || [[TUFLOW Message 2111|2111 ]] || [[TUFLOW Message 2112|2112 ]] || [[TUFLOW Message 2113|2113 ]] || [[TUFLOW Message 2114|2114 ]] || [[TUFLOW Message 2115|2115 ]] || [[TUFLOW Message 2116|2116 ]] || [[TUFLOW Message 2117|2117 ]] || [[TUFLOW Message 2118|2118 ]] || [[TUFLOW Message 2119|2119 ]]
|-
|[[TUFLOW Message 2120|2120 ]] || [[TUFLOW Message 2121|2121 ]] || [[TUFLOW Message 2122|2122 ]] || [[TUFLOW Message 2123|2123 ]] || [[TUFLOW Message 2124|2124 ]] || [[TUFLOW Message 2125|2125 ]] || [[TUFLOW Message 2126|2126 ]] || [[TUFLOW Message 2127|2127 ]] || [[TUFLOW Message 2128|2128 ]] || [[TUFLOW Message 2129|2129 ]] || [[TUFLOW Message 2130|2130 ]] || [[TUFLOW Message 2131|2131 ]] || [[TUFLOW Message 2132|2132 ]] || [[TUFLOW Message 2133|2133 ]] || [[TUFLOW Message 2134|2134 ]] || [[TUFLOW Message 2135|2135 ]] || [[TUFLOW Message 2136|2136 ]] || [[TUFLOW Message 2137|2137 ]] || [[TUFLOW Message 2138|2138 ]] || [[TUFLOW Message 2139|2139 ]]
|-
|[[TUFLOW Message 2140|2140 ]] || [[TUFLOW Message 2141|2141 ]] || [[TUFLOW Message 2142|2142 ]] || [[TUFLOW Message 2143|2143 ]] || [[TUFLOW Message 2144|2144 ]] || [[TUFLOW Message 2145|2145 ]] || [[TUFLOW Message 2146|2146 ]] || [[TUFLOW Message 2147|2147 ]] || [[TUFLOW Message 2148|2148 ]] || [[TUFLOW Message 2149|2149 ]] || [[TUFLOW Message 2150|2150 ]] || [[TUFLOW Message 2151|2151 ]] || [[TUFLOW Message 2152|2152 ]] || [[TUFLOW Message 2153|2153 ]] || [[TUFLOW Message 2154|2154 ]] || [[TUFLOW Message 2155|2155 ]] || [[TUFLOW Message 2156|2156 ]] || [[TUFLOW Message 2157|2157 ]] || [[TUFLOW Message 2158|2158 ]] || [[TUFLOW Message 2159|2159 ]]
|-
|[[TUFLOW Message 2160|2160 ]] || [[TUFLOW Message 2161|2161 ]] || [[TUFLOW Message 2162|2162 ]] || [[TUFLOW Message 2163|2163 ]] || [[TUFLOW Message 2164|2164 ]] || [[TUFLOW Message 2165|2165 ]] || [[TUFLOW Message 2166|2166 ]] || [[TUFLOW Message 2167|2167 ]] || [[TUFLOW Message 2168|2168 ]] || [[TUFLOW Message 2169|2169 ]] || [[TUFLOW Message 2170|2170 ]] || [[TUFLOW Message 2171|2171 ]] || [[TUFLOW Message 2172|2172 ]] || [[TUFLOW Message 2173|2173 ]] || [[TUFLOW Message 2174|2174 ]] || [[TUFLOW Message 2175|2175 ]] || [[TUFLOW Message 2176|2176 ]] || [[TUFLOW Message 2177|2177 ]] || [[TUFLOW Message 2178|2178 ]] || [[TUFLOW Message 2179|2179 ]]
|-
|[[TUFLOW Message 2180|2180 ]] || [[TUFLOW Message 2181|2181 ]] || [[TUFLOW Message 2182|2182 ]] || [[TUFLOW Message 2183|2183 ]] || [[TUFLOW Message 2184|2184 ]] || [[TUFLOW Message 2185|2185 ]] || [[TUFLOW Message 2186|2186 ]] || [[TUFLOW Message 2187|2187 ]] || [[TUFLOW Message 2188|2188 ]] || [[TUFLOW Message 2189|2189 ]] || [[TUFLOW Message 2190|2190 ]] || [[TUFLOW Message 2191|2191 ]] || [[TUFLOW Message 2192|2192 ]] || [[TUFLOW Message 2193|2193 ]] || [[TUFLOW Message 2194|2194 ]] || [[TUFLOW Message 2195|2195 ]] || [[TUFLOW Message 2196|2196 ]] || [[TUFLOW Message 2197|2197 ]] || [[TUFLOW Message 2198|2198 ]] || [[TUFLOW Message 2199|2199 ]]
|-
|[[TUFLOW Message 2200|2200 ]] || [[TUFLOW Message 2201|2201 ]] || [[TUFLOW Message 2202|2202 ]] || [[TUFLOW Message 2203|2203 ]] || [[TUFLOW_Message_2204| 2204]] || [[TUFLOW Message 2205|2205 ]] || [[TUFLOW Message 2206|2206 ]] || 2207 || [[TUFLOW Message 2208|2208 ]] || 2209 || [[TUFLOW Message 2210|2210 ]] || [[TUFLOW Message 2211|2211 ]] || [[TUFLOW Message 2212|2212 ]] || [[TUFLOW Message 2213|2213 ]] || [[TUFLOW Message 2214|2214 ]] || [[TUFLOW Message 2215|2215 ]] || [[TUFLOW Message 2216|2216 ]] || [[TUFLOW Message 2217|2217 ]] || [[TUFLOW Message 2218|2218 ]] || [[TUFLOW Message 2219|2219 ]]
|-
|[[TUFLOW Message 2220|2220 ]] || [[TUFLOW Message 2221|2221 ]] || [[TUFLOW Message 2222|2222 ]] || [[TUFLOW Message 2223|2223 ]] || [[TUFLOW Message 2224|2224 ]] || [[TUFLOW Message 2225|2225 ]] || [[TUFLOW Message 2226|2226 ]] || [[TUFLOW Message 2227|2227 ]] || [[TUFLOW Message 2228|2228 ]] || [[TUFLOW Message 2229|2229 ]] || [[TUFLOW Message 2230|2230 ]] || [[TUFLOW Message 2231|2231 ]] || [[TUFLOW Message 2232|2232 ]] || [[TUFLOW Message 2233|2233 ]] || [[TUFLOW Message 2234|2234 ]] || [[TUFLOW Message 2235|2235 ]] || [[TUFLOW Message 2236|2236 ]] || [[TUFLOW Message 2237|2237 ]] || [[TUFLOW Message 2238|2238 ]] || [[TUFLOW Message 2239|2239 ]]
|-
|[[TUFLOW Message 2240|2240 ]] || [[TUFLOW Message 2241|2241 ]] || [[TUFLOW Message 2242|2242 ]] || 2243 || [[TUFLOW Message 2244|2244 ]] || 2245 || 2246 || 2247 || 2248 || 2249 || 2250 || 2251 || 2252 || 2253 || 2254 || 2255 || 2256 || 2257 || 2258 || 2259
|-
|2300 || 2301 || [[TUFLOW Message 2302|2302 ]] || 2303 || [[TUFLOW Message 2304|2304 ]] || [[TUFLOW Message 2305|2305 ]] || [[TUFLOW Message 2306|2306 ]] || 2307 || [[TUFLOW Message 2308|2308 ]] || [[TUFLOW Message 2309|2309 ]] || [[TUFLOW Message 2310|2310 ]] || [[TUFLOW Message 2311|2311 ]] || 2312 || [[TUFLOW Message 2313|2313 ]] || [[TUFLOW Message 2314|2314 ]] || [[TUFLOW Message 2315|2315 ]]|| [[TUFLOW Message 2316|2316 ]] || [[TUFLOW Message 2317|2317 ]] || 2318 || [[TUFLOW Message 2319|2319 ]]
|-
|[[TUFLOW Message 2320|2320 ]] || [[TUFLOW Message 2321|2321 ]] || 2322 || [[TUFLOW Message 2323|2323 ]] || 2324 || 2325 || 2326 || 2327 || 2328 || [[TUFLOW Message 2329|2329 ]] || [[TUFLOW Message 2330|2330 ]] || [[TUFLOW Message 2331|2331 ]] || 2332 || [[TUFLOW Message 2333|2333 ]] || [[TUFLOW Message 2334|2334 ]] || [[TUFLOW Message 2335|2335 ]] || [[TUFLOW Message 2336|2336 ]] || [[TUFLOW Message 2337|2337]] || [[TUFLOW Message 2338|2338]] || 2339
|-
|[[TUFLOW Message 2340|2340 ]] || 2341 || 2342 || [[TUFLOW Message 2343|2343 ]] || 2344 || 2345 || 2346 || [[TUFLOW Message 2347|2347 ]] || [[TUFLOW Message 2348|2348 ]] || [[TUFLOW Message 2349|2349 ]] || [[TUFLOW Message 2350|2350 ]] || [[TUFLOW Message 2351|2351 ]] || [[TUFLOW Message 2352|2352 ]] || [[TUFLOW Message 2353|2353 ]] || [[TUFLOW Message 2354|2354 ]] || [[TUFLOW Message 2355|2355 ]] || [[TUFLOW Message 2356|2356 ]] || [[TUFLOW Message 2357|2357 ]] || [[TUFLOW Message 2358|2358 ]] || [[TUFLOW Message 2359|2359 ]]
|-
|[[TUFLOW Message 2360|2360 ]] || [[TUFLOW Message 2361|2361 ]] || [[TUFLOW Message 2362|2362 ]] || 2363 || 2364 || [[TUFLOW Message 2365|2365 ]] || 2366 || [[TUFLOW Message 2367|2367 ]] || [[TUFLOW Message 2368|2368 ]] || 2369 || [[TUFLOW Message 2370|2370 ]] || [[TUFLOW Message 2371|2371 ]] || [[TUFLOW Message 2372|2372 ]] || [[TUFLOW Message 2373|2373 ]] || [[TUFLOW Message 2374|2374 ]] || [[TUFLOW Message 2375|2375 ]] || [[TUFLOW Message 2376|2376 ]] || [[TUFLOW Message 2377|2377 ]] || 2378 || 2379
|-
|[[TUFLOW Message 2380|2380 ]] || [[TUFLOW Message 2381|2381 ]] || [[TUFLOW Message 2382|2382 ]] || [[TUFLOW Message 2383|2383 ]] || 2384 || [[TUFLOW Message 2385|2385 ]] || [[TUFLOW Message 2386|2386 ]] || 2387 || 2388 || [[TUFLOW Message 2389|2389 ]] || [[TUFLOW Message 2390|2390 ]] || [[TUFLOW Message 2391|2391 ]] || [[TUFLOW Message 2392|2392 ]] || 2393 || 2394 || 2395 || 2396 || 2397 || 2398 || 2399
|-
|[[TUFLOW Message 2400|2400 ]] || [[TUFLOW Message 2401|2401 ]] || [[TUFLOW Message 2402|2402 ]] || [[TUFLOW Message 2403|2403 ]] || [[TUFLOW Message 2404|2404 ]] || [[TUFLOW Message 2405|2405 ]] || [[TUFLOW Message 2406|2406 ]] || [[TUFLOW Message 2407|2407 ]] || [[TUFLOW Message 2408|2408 ]] || [[TUFLOW Message 2409|2409 ]] || 2410 || [[TUFLOW Message 2411|2411 ]] || [[TUFLOW Message 2412|2412 ]] || [[TUFLOW Message 2413|2413 ]] || [[TUFLOW Message 2414|2414 ]] || [[TUFLOW Message 2415|2415 ]] || [[TUFLOW Message 2416|2416 ]] || [[TUFLOW Message 2417|2417 ]] || [[TUFLOW Message 2418|2418 ]] || [[TUFLOW Message 2419|2419 ]]
|-
|[[TUFLOW Message 2420|2420 ]] || [[TUFLOW Message 2421|2421 ]] || [[TUFLOW Message 2422|2422 ]] || [[TUFLOW Message 2423|2423 ]] || [[TUFLOW Message 2424|2424 ]] || [[TUFLOW Message 2425|2425 ]] || [[TUFLOW Message 2426|2426 ]] || [[TUFLOW Message 2427|2427 ]] || [[TUFLOW Message 2428|2428 ]] || [[TUFLOW Message 2429|2429 ]] || [[TUFLOW Message 2430|2430 ]] || [[TUFLOW Message 2431|2431 ]] || [[TUFLOW Message 2432|2432 ]] || 2433 || 2434 || [[TUFLOW Message 2435|2435 ]] || [[TUFLOW Message 2436|2436 ]] || 2437 || [[TUFLOW Message 2438|2438 ]] || 2439
|-
|[[TUFLOW Message 2440|2440 ]] || [[TUFLOW Message 2441|2441 ]] || [[TUFLOW Message 2442|2442 ]] || [[TUFLOW Message 2443|2443 ]] || [[TUFLOW Message 2444|2444 ]] || [[TUFLOW Message 2445|2445 ]] || 2446 || [[TUFLOW Message 2447|2447 ]] || 2448 || 2449 || [[TUFLOW Message 2450|2450 ]] || [[TUFLOW Message 2451|2451 ]] || 2452 || 2453 || 2454 || 2455 || 2456 || 2457 || 2458 || 2459
|-
|[[TUFLOW Message 2460|2460 ]] || [[TUFLOW Message 2461|2461 ]] || [[TUFLOW Message 2462|2462 ]] || [[TUFLOW Message 2463|2463 ]] || [[TUFLOW Message 2464|2464 ]] || [[TUFLOW Message 2465|2465 ]] || [[TUFLOW Message 2466|2466 ]] || [[TUFLOW Message 2467|2467 ]] || [[TUFLOW Message 2468|2468 ]] || [[TUFLOW Message 2469|2469 ]] || [[TUFLOW Message 2470|2470 ]] || [[TUFLOW Message 2471|2471 ]] || [[TUFLOW Message 2472|2472 ]] || [[TUFLOW Message 2473|2473 ]] || [[TUFLOW Message 2474|2474 ]] || [[TUFLOW Message 2475|2475 ]] || [[TUFLOW Message 2476|2476 ]] || [[TUFLOW Message 2477|2477 ]] || [[TUFLOW Message 2478|2478 ]] || [[TUFLOW Message 2479|2479 ]]
|-
|[[TUFLOW Message 2480|2480 ]] || [[TUFLOW Message 2481|2481 ]] || [[TUFLOW Message 2482|2482 ]] || [[TUFLOW Message 2483|2483 ]] || [[TUFLOW Message 2484|2484 ]] || [[TUFLOW Message 2485|2485 ]] || [[TUFLOW Message 2486|2486 ]] || [[TUFLOW Message 2487|2487 ]] || [[TUFLOW Message 2488|2488 ]] || [[TUFLOW Message 2489|2489 ]] || [[TUFLOW Message 2490|2490 ]] || [[TUFLOW Message 2491|2491 ]] || [[TUFLOW Message 2492|2492 ]] || [[TUFLOW Message 2493|2493 ]] || [[TUFLOW Message 2494|2494 ]] || [[TUFLOW Message 2495|2495 ]] || [[TUFLOW Message 2496|2496 ]] || [[TUFLOW Message 2497|2497 ]] || [[TUFLOW Message 2498|2498 ]] || [[TUFLOW Message 2499|2499 ]]
|-
|[[TUFLOW Message 2500|2500 ]] || 2501 || 2502 || 2503 || 2504 || 2505 || 2506 || [[TUFLOW Message 2507|2507 ]] || [[TUFLOW Message 2508|2508 ]] || [[TUFLOW Message 2509|2509 ]] || 2510 || 2511 || 2512 || 2513 || [[TUFLOW Message 2514|2514 ]] || [[TUFLOW Message 2515|2515 ]] || [[TUFLOW Message 2516|2516 ]] || [[TUFLOW Message 2517|2517 ]] || 2518 || [[TUFLOW Message 2519|2519 ]]
|-
|2520 || 2521 || [[TUFLOW Message 2522|2522 ]] || 2523 || 2524 || 2525 || 2526 || 2527 || 2528 || 2529 || 2530 || 2531 || 2532 || 2533 || 2534 || 2535 || 2536 || 2537 || 2538 || 2539
|-
|[[TUFLOW Message 2540|2540 ]] || [[TUFLOW Message 2541|2541 ]] || 2542 || 2543 || 2544 || 2545 || 2546 || 2547 || 2548 || 2549 || [[TUFLOW Message 2550|2550 ]] || [[TUFLOW Message 2551|2551 ]] || 2552 || 2553 || 2554 || 2555 || 2556 || 2557 || 2558 || 2559
|-
|[[TUFLOW Message 2560|2560 ]] || 2561 || [[TUFLOW Message 2562|2562 ]] || 2563 || [[TUFLOW Message 2564|2564 ]] || [[TUFLOW Message 2565|2565 ]] || [[TUFLOW Message 2566|2566 ]] || [[TUFLOW Message 2567|2567 ]] || [[TUFLOW Message 2568|2568 ]] || [[TUFLOW Message 2569|2569 ]] || [[TUFLOW Message 2570|2570 ]] || [[TUFLOW Message 2571|2571 ]] || [[TUFLOW Message 2572|2572 ]] || [[TUFLOW Message 2573|2573 ]] || [[TUFLOW Message 2574|2574 ]] || [[TUFLOW Message 2575|2575 ]] || [[TUFLOW Message 2576|2576 ]] || [[TUFLOW Message 2577|2577 ]] || [[TUFLOW Message 2578|2578 ]] || [[TUFLOW Message 2579|2579 ]]
|-
|[[TUFLOW Message 2580|2580 ]] || [[TUFLOW Message 2581|2581 ]] || [[TUFLOW Message 2582|2582 ]] || [[TUFLOW Message 2583|2583 ]] || [[TUFLOW Message 2584|2584 ]] || [[TUFLOW Message 2585|2585 ]] ||[[TUFLOW Message 2586|2586 ]] || [[TUFLOW Message 2587|2587 ]] || [[TUFLOW Message 2588|2588 ]] || [[TUFLOW Message 2589|2589 ]] || [[TUFLOW Message 2590|2590 ]] || 2591 ||[[TUFLOW Message 2592|2592 ]] || 2593 || [[TUFLOW Message 2594|2594 ]] || 2595 || 2596 || 2597 ||2598 || [[TUFLOW_Message_2599|2599]]
|-
|[[TUFLOW Message 2600|2600 ]] || [[TUFLOW Message 2601|2601 ]] || [[TUFLOW Message 2602|2602 ]] || [[TUFLOW Message 2603|2603 ]] || [[TUFLOW Message 2604|2604 ]] || [[TUFLOW Message 2605|2605 ]] || [[TUFLOW Message 2606|2606 ]] || [[TUFLOW Message 2607|2607 ]] || [[TUFLOW Message 2608|2608 ]] || [[TUFLOW Message 2609|2609 ]] || [[TUFLOW Message 2610|2610 ]] || [[TUFLOW Message 2611|2611 ]] || [[TUFLOW Message 2612|2612 ]] || [[TUFLOW Message 2613|2613 ]] || [[TUFLOW Message 2614|2614 ]] || [[TUFLOW Message 2615|2615 ]] || [[TUFLOW Message 2616|2616 ]] || [[TUFLOW Message 2617|2617 ]] || [[TUFLOW Message 2618|2618 ]] || [[TUFLOW Message 2619|2619 ]]
|-
|[[TUFLOW Message 2620|2620 ]] || 2621 || 2622 || 2623 || 2624 || 2625 || 2626 || 2627 || 2628 || 2629 || 2630 || [[TUFLOW Message 2631|2631 ]] || 2632 || 2633 || 2634 || 2635 || 2636 || 2637 || 2638 || 2639
|-
|2640 || [[TUFLOW Message 2641|2641 ]] || [[TUFLOW Message 2642|2642 ]] || 2643 || 2644 || 2645 || 2646 || 2647 || 2648 || [[TUFLOW Message 2649|2649 ]] || 2650 || 2651 || 2652 || 2653 || 2654 || 2655 || 2656 || 2657 || 2658 || 2659
|-
|2660 || 2661 || 2662 || 2663 || 2664 || 2665 || 2666 || 2667 || 2668 || 2669 || [[TUFLOW Message 2670|2670 ]] || [[TUFLOW Message 2671|2671 ]] || 2672 || 2673 || 2674 || 2675 || 2676 || 2677 || 2678 || 2679
|-
| [[TUFLOW Message 2720|2720 ]] || 2721 || [[TUFLOW Message 2722|2722 ]] || 2723 || 2724 || 2725 || 2726 || 2727 || 2728 || 2729 || 2730 || 2731 || 2732 || 2733 || 2734 || [[TUFLOW Message 2735|2735 ]] || 2736 || 2737 || 2738 || 2739
|-
|2760 || 2761 || 2762 || [[TUFLOW Message 2763|2763 ]] || 2764 || 2765 || 2766 || 2767 || 2768 || 2769 || 2770 || 2771 || 2772 || 2773 || 2774 || 2775 || 2776 || 2777 || 2778 || 2779
|-
|2780 || 2781 || [[TUFLOW Message 2782|2782 ]] || 2783 || [[TUFLOW Message 2784|2784 ]] || [[TUFLOW Message 2785|2785 ]] || [[TUFLOW Message 2786|2786 ]] || [[TUFLOW Message 2787|2787 ]] || 2788 || 2789 || 2790 || 2791 || 2792 || 2793 || 2794 || 2795 || 2796 || 2797 || 2798 || 2799
|-
|[[TUFLOW Message 2800|2800 ]] || [[TUFLOW Message 2801|2801 ]] || [[TUFLOW Message 2802|2802 ]] || [[TUFLOW Message 2803|2803 ]] || [[TUFLOW Message 2804|2804 ]] || [[TUFLOW Message 2805|2805 ]] || [[TUFLOW Message 2806|2806 ]] || [[TUFLOW Message 2807|2807 ]] || [[TUFLOW Message 2808|2808 ]] || [[TUFLOW Message 2809|2809 ]] || [[TUFLOW Message 2810|2810 ]] || [[TUFLOW Message 2811|2811 ]] || [[TUFLOW Message 2812|2812 ]] || [[TUFLOW Message 2813|2813 ]] || [[TUFLOW Message 2814|2814 ]] || [[TUFLOW Message 2815|2815 ]] || [[TUFLOW Message 2816|2816 ]] || [[TUFLOW Message 2817|2817 ]] || [[TUFLOW Message 2818|2818 ]] || [[TUFLOW Message 2819|2819 ]]
|-
|[[TUFLOW Message 2820|2820 ]] || [[TUFLOW Message 2821|2821 ]] || [[TUFLOW Message 2822|2822 ]] || [[TUFLOW Message 2823|2823 ]] || [[TUFLOW Message 2824|2824 ]] || [[TUFLOW Message 2825|2825 ]] || [[TUFLOW Message 2826|2826 ]] || [[TUFLOW Message 2827|2827 ]] || [[TUFLOW Message 2828|2828 ]] || [[TUFLOW Message 2829|2829 ]] || [[TUFLOW Message 2830|2830 ]] || [[TUFLOW Message 2831|2831 ]] || [[TUFLOW Message 2832|2832 ]] || [[TUFLOW Message 2833|2833 ]] || [[TUFLOW Message 2834|2834 ]] || [[TUFLOW Message 2835|2835 ]] || [[TUFLOW Message 2836|2836 ]] || [[TUFLOW Message 2837|2837 ]] || [[TUFLOW Message 2838|2838 ]] || [[TUFLOW Message 2839|2839 ]]
|-
|[[TUFLOW Message 2840|2840 ]] || [[TUFLOW Message 2841|2841 ]] || [[TUFLOW Message 2842|2842 ]] || [[TUFLOW Message 2843|2843 ]] || [[TUFLOW Message 2844|2844 ]] || [[TUFLOW Message 2845|2845 ]] || [[TUFLOW Message 2846|2846 ]] || [[TUFLOW Message 2847|2847 ]] || [[TUFLOW Message 2848|2848 ]] || [[TUFLOW Message 2849|2849 ]] || [[TUFLOW Message 2850|2850 ]] || [[TUFLOW Message 2851|2851 ]] || [[TUFLOW Message 2852|2852 ]] || [[TUFLOW Message 2853|2853 ]] || [[TUFLOW Message 2854|2854 ]] || [[TUFLOW Message 2855|2855 ]] || [[TUFLOW Message 2856|2856 ]] || [[TUFLOW Message 2857|2857 ]] || [[TUFLOW Message 2858|2858 ]] || [[TUFLOW Message 2859|2859 ]]
|-
|2900 || 2901 || [[TUFLOW Message 2902|2902 ]] || 2903 || [[TUFLOW Message 2904|2904 ]] || [[TUFLOW Message 2905|2905 ]] || 2906 || 2907 || 2908 || 2909 || 2910 || [[TUFLOW Message 2911|2911 ]] || 2912 || [[TUFLOW Message 2913|2913 ]] || 2914 || 2915 || 2916 || 2917 || 2918 || 2919
|-
|[[TUFLOW Message 2920|2920 ]] || [[TUFLOW Message 2921|2921 ]] || [[TUFLOW Message 2922|2922 ]] || [[TUFLOW Message 2923|2923 ]] || [[TUFLOW Message 2924|2924 ]] || [[TUFLOW Message 2925|2925 ]]|| [[TUFLOW Message 2926|2926 ]] || [[TUFLOW Message 2927|2927 ]] || [[TUFLOW Message 2928|2928 ]] || [[TUFLOW Message 2929|2929 ]] || [[TUFLOW Message 2930|2930 ]] || [[TUFLOW Message 2931|2931 ]] || [[TUFLOW Message 2932|2932 ]] || [[TUFLOW Message 2933|2933 ]] || [[TUFLOW Message 2934|2934 ]] || [[TUFLOW Message 2935|2935 ]] || 2936 || 2937 || 2938 || 2939
|-
|[[TUFLOW Message 2980|2980 ]] || 2981 || 2982 || 2983 || 2984 || 2985 || 2986 || 2987 || 2988 || 2989 || 2990 || [[TUFLOW Message 2991|2991 ]] || 2992 || 2993 || 2994 || 2995 || 2996 || 2997 || [[TUFLOW Message 2998|2998 ]] || [[TUFLOW Message 2999|2999 ]]
|-
|}
 
{{Tips Navigation
|uplink=[[ Main_Page | Back to Main Page]]
}}

TUFLOW Message 0711

2025-03-11T04:52:55Z

ElizaCollison: Created page with "{{TUFLOW_Message |tuflow_message=CHECK 0711 - File does not exist: <file_name> |alt_msg=NA |type=CHECK |message_desc=When using the package model function, TUFLOW could no..."

{{TUFLOW_Message
|tuflow_message=CHECK 0711 - File does not exist: <file_name>
|alt_msg=NA
|type=[[CHECK]]
|message_desc=When using the package model function, TUFLOW could not find the specified file.
|suggestions=Check the location of the file to see why it wasn't copied. Manually copy the file into the packaged model folder if needed.

|uplink=[[0xxx_TUFLOW_Messages|0xxx Messages]]
}}

0xxx TUFLOW Messages

2025-03-11T04:50:54Z

ElizaCollison:

The 0xxx error messages refer to errors that occur neither in the 1D or the 2D. Links to detailed message descriptions are listed in the table below. Grey messages do not yet have a message assigned, and red numbers have been allocated to new messages.

See also:
* [[1xxx TUFLOW Messages]]
* [[2xxx TUFLOW Messages]]
* [[3xxx TUFLOW Messages]]
* [[4xxx TUFLOW Messages]]
* [[5xxx TUFLOW Messages]]
* [[6xxx TUFLOW Messages]]

{| Border ="1" cellpadding="8" style="text-align:center"
|0000 || [[TUFLOW Message 0001|0001 ]] || [[TUFLOW Message 0002|0002 ]] || [[TUFLOW Message 0003|0003 ]] || [[TUFLOW Message 0004|0004 ]] || [[TUFLOW Message 0005|0005 ]] || [[TUFLOW Message 0006|0006 ]] || [[TUFLOW Message 0007|0007 ]] || [[TUFLOW Message 0008|0008 ]] || [[TUFLOW Message 0009|0009 ]] || 0010 || [[TUFLOW Message 0011|0011 ]] || [[TUFLOW Message 0012|0012 ]] || [[TUFLOW Message 0013|0013 ]] || 0014 || [[TUFLOW Message 0015|0015 ]] || 0016 || 0017 || 0018 || 0019
|-
|[[TUFLOW Message 0020|0020 ]] || [[TUFLOW Message 0021|0021 ]] || [[TUFLOW Message 0022|0022 ]] || [[TUFLOW Message 0023|0023 ]] || [[TUFLOW Message 0024|0024 ]] || [[TUFLOW Message 0025|0025 ]] || [[TUFLOW Message 0026|0026 ]] || [[TUFLOW Message 0027|0027 ]] || [[TUFLOW Message 0028|0028 ]] || [[TUFLOW Message 0029|0029 ]] || [[TUFLOW Message 0030|0030 ]] || [[TUFLOW Message 0031|0031 ]] || [[TUFLOW Message 0032|0032 ]] || [[TUFLOW Message 0033|0033 ]] || [[TUFLOW Message 0034|0034 ]] || [[TUFLOW Message 0035|0035 ]] || [[TUFLOW Message 0036|0036 ]] || [[TUFLOW Message 0037|0037 ]] || [[TUFLOW Message 0038|0038 ]] || 0039
|-
|[[TUFLOW Message 0040|0040 ]] || [[TUFLOW Message 0041|0041 ]] || [[TUFLOW Message 0042|0042 ]] || [[TUFLOW Message 0043|0043 ]] || 0044 || [[TUFLOW Message 0045|0045 ]] || [[TUFLOW Message 0046|0046 ]] || [[TUFLOW Message 0047|0047 ]] || [[TUFLOW Message 0048|0048]] || 0049 || 0050 || [[TUFLOW Message 0051|0051 ]] || [[TUFLOW Message 0052|0052 ]] || 0053 || 0054 || 0055 || 0056 || 0057 || 0058 || 0059
|-
|[[TUFLOW Message 0060|0060 ]] || 0061 || 0062 || 0063 || 0064 || 0065 || 0066 || 0067 || 0068 || 0069 || 0070 || 0071 || 0072 || 0073 || 0074 || 0075 || 0076 || 0077 || 0078 || 0079
|-
|[[TUFLOW Message 0100|0100 ]] || [[TUFLOW Message 0101|0101 ]] || [[TUFLOW Message 0102|0102 ]] || [[TUFLOW Message 0103|0103 ]] || [[TUFLOW Message 0104|0104 ]] || [[TUFLOW Message 0105|0105 ]] || [[TUFLOW Message 0106|0106 ]] || [[TUFLOW Message 0107|0107 ]] || [[TUFLOW Message 0108|0108 ]] || [[TUFLOW Message 0109|0109 ]] || [[TUFLOW Message 0110|0110 ]] || [[TUFLOW Message 0111|0111 ]] || [[TUFLOW Message 0112|0112 ]] || 0113 || 0114 || [[TUFLOW Message 0115|0115 ]] || [[TUFLOW Message 0116|0116 ]] || [[TUFLOW Message 0117|0117 ]] || [[TUFLOW Message 0118|0118 ]] || 0119
|-
|[[TUFLOW Message 0120|0120 ]] || [[TUFLOW Message 0121|0121 ]] || [[TUFLOW Message 0122|0122 ]] || [[TUFLOW Message 0123|0123 ]] || 0124 || 0125 || 0126 || 0127 || 0128 || 0129 || [[TUFLOW Message 0130|0130 ]] || [[TUFLOW Message 0131|0131 ]] || 0132 || 0133 || 0134 || 0135 || 0136 || 0137 || 0138 || 0139
|-
|0140 || [[TUFLOW Message 0141|0141 ]] || [[TUFLOW Message 0142|0142 ]] || 0143 || [[TUFLOW Message 0144|0144 ]] || 0145 || 0146 || 0147 || 0148 || 0149 || 0150 || 0151 || 0152 || 0153 || 0154 || 0155 || 0156 || 0157 || 0158 || 0159
|-
|[[TUFLOW Message 0160|0160 ]] || 0161 || 0162 || [[TUFLOW Message 0163|0163 ]] || 0164 || 0165 || 0166 || 0167 || 0168 || 0169 || 0170 || 0171 || 0172 || 0173 || 0174 || [[TUFLOW Message 0175|0175 ]] || 0176 || 0177 || 0178 || 0179
|-
|-
|0180 || 0181 || 0182 || 0183 || [[TUFLOW Message 0184|0184 ]] || 0185 || 0186 || 0187 || 0188 || 0189 || 0190 || 0191 || 0192 || 0193 || 0194 || 0195 || 0176 || 0197 || 0198 || 0199
|-
|0200 || [[TUFLOW Message 0201|0201 ]] || [[TUFLOW Message 0202|0202 ]] || [[TUFLOW Message 0203|0203 ]] || 0204 || 0205 || 0206 || 0207 || 0208 || 0209 || 0210 || 0211 || 0212 || 0213 || 0214 || 0215 || 0216 || 0217 || 0218 || 0219
|-
|0240 || 0241 || [[TUFLOW Message 0242|0242 ]] || 0243 || [[TUFLOW Message 0244|0244 ]] || 0245 || 0246 || [[TUFLOW Message 0247|0247 ]] || [[TUFLOW Message 0248|0248 ]] || [[TUFLOW Message 0249|0249 ]] || [[TUFLOW Message 0250|0250 ]] || [[TUFLOW Message 0251|0251 ]] || [[TUFLOW Message 0252|0252 ]] || [[TUFLOW Message 0253|0253 ]] || [[TUFLOW Message 0254|0254 ]] || [[TUFLOW Message 0255|0255 ]] || 0256 || 0257 || 0258 || 0259
|-
|[[TUFLOW Message 0300|0300 ]] || [[TUFLOW Message 0301|0301 ]] || [[TUFLOW Message 0302|0302 ]] || [[TUFLOW Message 0303|0303 ]] || [[TUFLOW Message 0304|0304 ]] || [[TUFLOW Message 0305|0305 ]] || [[TUFLOW Message 0306|0306 ]] || [[TUFLOW Message 0307|0307 ]] || [[TUFLOW Message 0308|0308 ]] || [[TUFLOW Message 0309|0309 ]] || [[TUFLOW Message 0310|0310 ]] || [[TUFLOW Message 0311|0311 ]] || [[TUFLOW Message 0312|0312 ]] || [[TUFLOW Message 0313|0313 ]] || [[TUFLOW Message 0314|0314 ]] || [[TUFLOW Message 0315|0315 ]] || [[TUFLOW Message 0316|0316 ]] || [[TUFLOW Message 0317|0317 ]] || [[TUFLOW Message 0318|0318 ]] || [[TUFLOW Message 0319|0319 ]]
|-
|0320 || [[TUFLOW Message 0321|0321 ]] || [[TUFLOW Message 0322|0322 ]] || [[TUFLOW Message 0323|0323 ]] || 0324 || 0325 || 0326 || 0327 || 0328 || 0329 || 0330 || 0331 || 0332 || 0333 || 0334 || 0335 || 0336 || 0337 || 0338 || 0339
|-
|0340 || 0341 || 0342 || 0343 || 0344 || 0345 || 0346 || 0347 || 0348 || 0349 || [[TUFLOW Message 0350|0350 ]] || 0351 || 0352 || 0353 || 0354 || 0355 || 0356 || 0357 || 0358 || 0359
|-
|0400 || [[TUFLOW Message 0401|0401 ]] || [[TUFLOW Message 0402|0402 ]] || [[TUFLOW Message 0403|0403 ]] || [[TUFLOW Message 0404|0404 ]] || [[TUFLOW Message 0405|0405 ]] || [[TUFLOW Message 0406|0406 ]] || [[TUFLOW Message 0407|0407 ]] || [[TUFLOW Message 0408|0408 ]] || 0409 || 0410 || [[TUFLOW Message 0411|0411 ]] || [[TUFLOW Message 0412|0412 ]] || [[TUFLOW Message 0413|0413 ]] || 0414 || 0415 || 0416 || [[TUFLOW Message 0417|0417 ]] || 0418 || [[TUFLOW Message 0419|0419 ]]
|-
|[[TUFLOW Message 0420|0420 ]] || [[TUFLOW Message 0421|0421 ]] || [[TUFLOW Message 0422|0422 ]] || [[TUFLOW Message 0423|0423 ]] || [[TUFLOW Message 0424|0424 ]] || [[TUFLOW Message 0425|0425 ]] || [[TUFLOW Message 0426|0426 ]] || [[TUFLOW Message 0427|0427 ]] || [[TUFLOW Message 0428|0428 ]] || [[TUFLOW Message 0429|0429 ]] || [[TUFLOW Message 0430|0430 ]] || 0431 || 0432 || 0433 || 0434 || 0435 || 0436 || [[TUFLOW Message 0437|0437 ]] || 0438 || [[TUFLOW Message 0439|0439 ]]
|-
|[[TUFLOW Message 0500|0500 ]] || [[TUFLOW Message 0501|0501 ]] || [[TUFLOW Message 0502|0502 ]] || [[TUFLOW Message 0503|0503 ]] || 0504 || [[TUFLOW Message 0505|0505 ]] || 0506 || 0507 || 0508 || 0509 || 0510 || 0511 || 0512 || 0513 || 0514 || 0515 || 0516 || 0517 || 0518 || 0519
|-
|[[TUFLOW Message 0600|0600 ]] || [[TUFLOW Message 0601|0601 ]] || 0602 || 0603 || 0604 || 0605 || 0606 || 0607 || 0608 || 0609 || 0610 || 0611 || 0612 || 0613 || 0614 || 0615 || 0616 || 0617 || 0618 || 0619
|-
|[[TUFLOW Message 0620|0620 ]] || [[TUFLOW Message 0621|0621 ]] || [[TUFLOW Message 0622|0622 ]] || [[TUFLOW Message 0623|0623 ]] || [[TUFLOW Message 0624|0624 ]] || [[TUFLOW Message 0625|0625 ]] || [[TUFLOW Message 0626|0626 ]] || [[TUFLOW Message 0627|0627 ]] || [[TUFLOW Message 0628|0628 ]] || [[TUFLOW Message 0629|0629 ]] || [[TUFLOW Message 0630|0630 ]] || [[TUFLOW Message 0631|0631 ]] || [[TUFLOW Message 0632|0632 ]] || [[TUFLOW Message 0633|0633 ]] || [[TUFLOW Message 0634|0634 ]] || [[TUFLOW Message 0635|0635 ]] || [[TUFLOW Message 0636|0636 ]] || [[TUFLOW Message 0637|0637 ]] || [[TUFLOW Message 0638|0638 ]] || [[TUFLOW Message 0639|0639 ]]
|-
|[[TUFLOW Message 0640|0640 ]] || [[TUFLOW Message 0641|0641 ]] || [[TUFLOW Message 0642|0642 ]] || [[TUFLOW Message 0643|0643 ]] || [[TUFLOW Message 0644|0644 ]] || [[TUFLOW Message 0645|0645 ]] || [[TUFLOW Message 0646|0646 ]] || [[TUFLOW Message 0647|0647 ]] || 0648 || 0649 || [[TUFLOW Message 0650|0650 ]] || [[TUFLOW Message 0651|0651 ]] || 0652 || 0653 || 0654 || 0655 || [[TUFLOW_Message_0656|0656]] || [[TUFLOW_Message_0657|0657]] || 0658 || [[TUFLOW Message 0659|0659 ]]
|-
|0700 || 0701 || 0702 || 0703 || [[TUFLOW Message 0704|0704 ]] || 0705 || 0706 || [[TUFLOW Message 0707|0707 ]] || 0708 || 0709 || [[TUFLOW Message 0710|0710 ]] || [[TUFLOW Message 0711|0711 ]] || [[TUFLOW Message 0712|0712 ]] || [[TUFLOW Message 0713|0713 ]] || 0714 || 0715 || 0716 || 0717 || 0718 || 0719
|-
|[[TUFLOW Message 0900|0900 ]] || [[TUFLOW Message 0901|0901 ]] || [[TUFLOW Message 0902|0902 ]] || [[TUFLOW Message 0903|0903 ]] || [[TUFLOW Message 0904|0904 ]] || [[TUFLOW Message 0905|0905 ]] || [[TUFLOW Message 0906|0906 ]] || 0907 || 0908 || [[TUFLOW Message 0909|0909 ]] || [[TUFLOW Message 0910|0910 ]] || [[TUFLOW Message 0911|0911 ]] || [[TUFLOW Message 0912|0912 ]] || [[TUFLOW Message 0913|0913 ]] || [[TUFLOW Message 0914|0914 ]] || [[TUFLOW Message 0915|0915 ]] || [[TUFLOW Message 0916|0916 ]] || [[TUFLOW Message 0917|0917 ]] || 0918 || [[TUFLOW Message 0919|0919 ]]
|-
|[[TUFLOW Message 0920|0920 ]] || [[TUFLOW Message 0921|0921 ]] || [[TUFLOW Message 0922|0922 ]] || [[TUFLOW Message 0923|0923 ]] || 0924 || 0925 || 0926 || 0927 || 0928 || 0929 || 0930 || [[TUFLOW Message 0931|0931 ]] || [[TUFLOW Message 0932|0932 ]] || [[TUFLOW Message 0933|0933 ]] || 0934 || [[TUFLOW Message 0935|0935 ]] || 0936 || 0937 || [[TUFLOW Message 0938|0938 ]] || [[TUFLOW Message 0939|0939 ]]
|-
|0940 || [[TUFLOW Message 0941|0941 ]] || [[TUFLOW Message 0942|0942 ]] || 0943 || 0944 || 0945 || 0946 || 0947 || 0948 || 0949 || 0950 || 0951 || 0952 || 0953 || 0954 || 0955 || 0956 || 0957 || 0958 || 0959
|-
|}
 
{{Tips Navigation
|uplink=[[ Main_Page | Back to Main Page]]
}}

Run TUFLOW From a Batch-file

2025-03-07T05:13:59Z

ElizaCollison: /* Copy model, checks and results in a looped batch file */

TUFLOW simulations can also be started from a batch file. Batch files are text files which contain a series of commands. Batch files allow a large degree of flexibility in starting TUFLOW simulations, advanced batch files can be used to:

* Run multiple simulations
* Set CPU priority for TUFLOW simulations
* Create a wait (e.g. start a simulation in 1 hour)
* Test simulation input
* Copy a TUFLOW model
* Package a TUFLOW model
* Post process results after simulation has finished.
Batch files are executed by double clicking the created .bat file from Windows Explorer.
<ol>
==Simple batch file==
To use a batch file, create a new text file in the TUFLOW\runs directory. The name is arbitrary but the file must have the extension ".bat". For example the file name could be '''_run_TUFLOW.bat'''.

Open this file in a text editor and add the following line.

<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
This is the simplest command line for starting TUFLOW, the line above contains only two arguments, the first is the path to the TUFLOW executable and the second argument "M01_5m_001.tcf" is the simulation file name. Depending on the location of the executable the above command line will need to be modified. The quotations around the TUFLOW executable and the .tcf file name are only required if there are spaces in the file names. However, it is recommended to include these to avoid problems.

==Batch File Switches==
These switches are available in all batch files, they are not specific to TUFLOW.

===Pause===
A second line with the text "pause" can be added, this will prompt the user to press a key at the end of the batch file. This is useful if the DOS window disappears from the screen, before you can read the output. The pause command will keep the window open.
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"
pause</pre>

===Starting process in new window===
In order to run multiple simulations at the same time, each simulation needs be started in a new console window. To do this begin the batch file line with the "Start" command, a for the window is then added. For example, to start the simulation above in a new window titled "TUFLOW" the following would be used.

<pre>Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
===Wait===
If multiple simulations are to be run, it is often desirable to run these in series, i.e. the second simulation starts after the first has finished. a /wait switch can be added which makes the batch file wait until the process is finished before moving onto the next command. 
An example of this is: 
<pre>Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>
Without the wait command, both simulations would start at the same time. 
'''Note:''' Unless there is a third simulation in the batch file the /wait command in the second line is not required, this prevents the batchfile from moving onto the third line.
===Setting a priority===
The priority of a process (such a TUFLOW simulation) can be specified within a batch file. This can be useful for a number of reasons:
*Lowering the priority of a simulation to allow you to continue working;
*Setting a high priority for critical runs; or
*Making sure you runs are high priority on a shared computing resource!

The following are valid priority switches (in increasing order of priority):
*/LOW
*/BELOWNORMAL
*/NORMAL
*/ABOVENORMAL
*/HIGH
*/REALTIME

An example of a low priority simulation is: 
<pre>start "TUFLOW" /low "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
'''TIP:''' The priority of a TUFLOW simulation can be changed at a later stage by using the '''Windows Task Manager''', navigate to the '''Processes''' tab and right click on the TUFLOW process (e.g. TUFLOW_iSP_w64.exe) and select the set priority option.

===Minimising the console window===
Using the /min switch will keep the console window for TUFLOW models minimised, so it doesn't pop up to the front every time when the next model starts.
<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>

==No Console Option==
Using the -nc switch will run a simulation without opening a DOS console window. This option is desirable for people running simulation on the cloud. Note, if an invalid .tcf file is specified, the simulation stops and returns an error level of 1 to the operating system.

<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_5m_001.tcf
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_2.5m_001.tcf</pre>

== TUFLOW switches in a batch file==
These switches are specific to TUFLOW simulations.
===Testing a simulation===
The -t (test) switch is very useful for testing the data input without running the simulation. It is good practice to use this switch before carrying out the simulations, as this will tell you whether there are any data input problems. The -t switch runs TUFLOW to just before it starts the hydrodynamic computations.
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -t "M01_5m_001.tcf"</pre>

===Batch mode in TUFLOW===
The use of the –b (batch) switch which suppresses the need to press the return key at the end of a simulation. This ensures that one simulation proceeds on to the next without any need for user input. This is required for running multiple simulations in series (one after the other).
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b "M01_5m_001.tcf"</pre>

===Automatically Create Folders in a TUFLOW model===
The use of the -acf (automatically create folders) switch prevents the dialog prompt from appearing when encountering non-existent folders (ie. results folders), and creates these folders automatically. If for any reason the folder can't be created, a dialog will appear. This feature was first introduced for Build 2012-05-AE and is not available for TUFLOW builds prior to this. For models simulated with Build 2013-12-AA or later, non-existent folders are now automatically created. If you would prefer to have the create folder query dialog to appear, you can specify the –qcf run time option (stands for query create folders). 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -acf "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Suppress Queries in a TUFLOW model===
The use of the -nq (no queries) switch prevents the termination query dialog from displaying when Ctrl+C is pressed to terminate a simulation cleanly. If –nq is specified and Ctrl-C is pressed, the simulation terminates cleanly without a query dialog to check you are certain, so be careful! This feature was first introduced for Build 2012-05-AE and is not available for TUFLOW builds prior to this. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nq "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Copy a TUFLOW model===
TUFLOW can be run in copy mode, which can be useful for transferring a model to another site or for making an archive of the input data. 

To copy a TUFLOW model, the '''-c''' switch must be included on the TUFLOW command line, as a minimum. The '''-c''' switch copies only the files read by TUFLOW. As such, for MapInfo users, the .mif and .mid files read by TUFLOW will be copied. The remaining MapInfo format files (.tab, .id, .dat and .map) are not read by TUFLOW and will not be copied. By default, the '''-c''' switch copies all TUFLOW inputs for the simulation into a subdirectory where the .tcf is located (generally TUFLOW\runs\). 

Additional optional flags can be added to the base '''-c''' switch, in any combination, including: 
;* “a” (all); 
: The addition of the “a” flag (e.g. -ca) copies all files of the same name for all input files (ie. same name, but different extensions). This option is particularly useful if the .tab and other associated files of a GIS layer need to be archived or delivered. 
;*“L” (list); 
: The addition of the “L” flag will output the files used by TUFLOW into a .tcl (TUFLOW Copy List) file but not copy the files to a destination folder. This can be useful if scripting the copying of models. To run the copy list the character “L” needs to be specified after the -c input argument. This works for all copy options, for example, the following are all valid; -cL, -caL, -capL. The .tcl file produced is output in the same directory as the .tcf and takes the simulation name.
;* “p” (path); and 
: The addition of the “p” flag (e.g. -cp) allows the user to specify an alternate path in which to copy the model. Without this flag, the location defaults to the .tcf’s location. For example, specifying the following, will place a copy of the model into a folder C:\put_model_here: 
REM <tt>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cp "C:\put_model_here" "C:\TUFLOW\runs\M01_5m_001.tcf"</tt> 
;* “ncf” (no check files) 
: The addition of the “ncf” flag (e.g. -cncf) copies the essential input files and excludes all check files. 

Note that these optional flags can be added in any combination to the base '''-c''' switch (e.g.
-c, -ca, -cp, -cncf, -cap, -cancf, -cpncf, -capncf). 

Specifying '''-c''' on the TUFLOW command line creates a folder “<.tcf filename>_copy” (or “<.tcf filename>_copy_all” if the “a” flag is added) in the same location as the .tcf file. Under the folder, input files are copied (including the full folder structure), and any check files and output folders created. For example, specifying: 
: <tt>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -c “C:\tuflow_models\my model.tcf”</tt> will make a copy of the TUFLOW model based on the file <tt>“my model.tcf”</tt> in a folder <tt>"my model.tcf_copy"</tt>, or <tt>"my model.tcf_copy_all"</tt> if using the “a” flag. 

'''Note:'''
<ol>
<li> Use the full path to the .tcf file (this is the default if running from UltraEdit or using the right click approach).
<li>Make sure there is sufficient disk space (no checks for sufficient disk space are made).
<li>Output folders and some output files are created but these will be empty.
<li>Any check folder(s) are created and check files written (these can be deleted if wishing to minimise the size of the folder).
<li>The full path of the input files is reproduced to provide traceability and also handle inputs from other drives and URLs. Drive letters are replaced, for example, “C:” becomes a folder “C Drive”. URLs (denoted by “\\” or “//” at the beginning of the path) are replaced by a folder called “URL\”.
<li>To run the copied .tcf file, it will be necessary to change any non-relative pathnames according to the point above. Alternatively you can share and then map, for example, the “D Drive” folder as “D:”.
<li>The Check MI Save Date will need to be set to WARNING or OFF in the .tcf file if the –ca option has not been used as the .tab and other files will not have been copied.
<li>There is a limit of 1,000 characters (including spaces) on pathnames. As very long pathnames can result due to the above approach, if the number of characters exceeds 1,000, problems may occur.
<li>The -c switch automatically invokes the -t (ie. the simulation does not commence, only the input data is tested/checked).
<li>The -b option still applies if several models wish to be copied using a batch (.bat) file.
</ol> 

An example that copies all files (-ca switch) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -ca "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example that copies all files to an alternate path (-cap) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cap "C:\Copy_of_model" "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example that copies all files to an alternate path, excluding any check files, (-capncf) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -capncf "C:\Copy_of_model" "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Package a TUFLOW model===
Package model function attempts to copy all input files for all events and scenarios defined in the model, if only single set of events and scenarios is required, -c is preferable. Unlike the -c option, -pm does not read and process the data during the file copy, as such it is substantially faster than -c. The package model function does not require access to a TUFLOW licence.

A tool in QGIS (as part of the TUFLOW Plugin) exists which provides a dialog to the package model options, which allows users to bypass the creation of a batch file: 
[[Package_Model_in_QGIS | Package Model in QGIS]]

Additional optional flags can be added to the base '''-pm''' switch, in any combination, including: 
;* “All”; 
: The addition of the “All” flag (e.g. -pmAll) copies all file extensions (e.g. 1d_nwk_culv_L.mif, will become 1d_nwk_culv_L.*). 
;* “L” (list); and 
: The addition of the “L” flag (e.g. -pmL) list the files to be copied into an output file, but don’t copy. 
;* “ini” (file.ini) 
: The addition of the “ini” flag (e.g. -pmini) provides a .ini file with user defined options. A .ini file can be used to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames. Valid options should be separated by a vertical bar. 

Combinations of the above are also valid, with the order of the optional switches not being important (-pmAllL would be treated the same as -pmLAll). 
When using package model the default destination folder is created in the same directory as the .tcf file, with the prefix “pm_”. For example, C:\Projects\Modelling\TUFLOW\runs\Run_001.tcf will create a package in the folder “C:\Projects\Modelling\TUFLOW\runs\pm_Run_001\. 

Three options are also available for handling of the binary processed files created by TUFLOW to speed up the simulation start. These options are: 
;* “-xf0”; 
: Do not copy .xf files, only the original inputs are copied. 
;* “-xf1”; and 
: Copy both raw input files and .xf files. 
;* “-xf2” 
: Copy only .xf files, if xf files exist for an input only the xf will be copied. 
 
An example of package model that copies all files is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAll "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of package model that copies all files except .xf files, (-pmAll -xf0) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAll -xf0 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of package model that copies all files with specified .ini file (-pmAllini) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAllini package.ini "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of .ini file to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames: 
<pre>
Base Folder == <folder>
Copy Destination == <folder>
Model Scenario ~s<number>~ == <scenario A> | <scenario B> | …
Model Event ~e<number>~ == <event A> | <event B> | …
</pre>

===GPU Module Control===
The -pu switch can be used to select which GPU card or cards to direct the simulation towards. –pu must be specified once for each device. For example, to direct the simulation to GPU devices 0 and 2, specify -pu0 -pu2. (Note: the GPU device numbering starts a 0, not 1). For example:
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pu0 -pu2 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Event and Scenario Management===
The -e and -s switches can be used to manage multiple events and scenarios from a single tuflow control file. The -e and -s wildcard is replaced by the following entry specified in the batch file. For example, the following batch file commands will run two simulations in series:
* M01_Q050_24hr_2m_Dev_001.tcf; and
* M01_Q100_24hr_2m_Dev_001.tcf;

<pre>Start "TUFLOW" /wait "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 Q050 -e2 24hr -s1 2m -s2 Dev "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_~e1~_~e2~_~s1~_s2~_001.tcf"
Start "TUFLOW" /wait "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 Q100 -e2 24hr -s1 2m -s2 Dev "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_~e1~_~e2~_~s1~_s2~_001.tcf"</pre>

Please be aware that the % symbol is a special character in a batch file. If the % symbol is used within a wildcard, it will not be read when searching for that wildcard in TUFLOW. 
For example if the following event wildcard is used; 
*-e 10% 
TUFLOW will search for '10' instead of '10%' as the event wildcard. 
 
It is recommended that modellers avoid the use of a % symbol in any wildcard values. The string 'pct' is a great alternative for the % symbol. 
For example, using: 
*-e 10pct 
Alternatively, using the % symbol twice in a row as shown below should result in a desired wildcard value. 
*-e 10%% (TUFLOW will search for 10%)

===Set Hardware===
The -hwgpu or -hwcpu switches can be used overwrite any "Hardware ==' command specified in the .tcf to GPU or CPU, respectively. This feature was first introduced for Build 2023-03-AB and is not available for TUFLOW builds prior to this.

These switches can be used in conjunction with the -nt (number of threads) or -pu (processing unit id) to provide full control over the hardware usage via the command line.

The following command could be used to run a model with CPU hardware on 8 threads:
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -hwcpu -nt8 FS_Hardware_01.tcf </pre>

The following command could be used to run a model on GPU hardware using 2 devices (GPU 0 and GPU1):
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -hwgpu -pu0 -pu1 FS_Hardware_01.tcf </pre>

===Set Start Time for a Simulation===
The use of the -st<time_in_hours> (start time) switch allows the user to specify the start time for a simulation. Any start time specified via this run option argument is given the highest priority and overrides the "Start Time ==" settings in the .tcf, event files (.tef) and override files. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -st0 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Set End Time for a Simulation===
The use of the -et<time_in_hours> (end time) switch allows the user to specify the end time for a simulation. Any end time specified via this run option argument is given the highest priority and overrides the "End Time ==" settings in the .tcf, event files (.tef) and override files. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -et3 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Suppress Message Box Prompts===
The use of the -nmb (no message boxes) switch suppresses the use of Windows message boxes to prompt the user. All prompts will be via the console window. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nmb "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Search for a Network License===
The use of the -nwk (network) switch forces TUFLOW to search for a network licence. I.e. Skip the search for a local license. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nwk "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Search for a WIBU License===
The use of the -wibu (WIBU license) switch forces TUFLOW to search only for a WIBU Codemeter license. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -wibu "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Specify the Output Drive===
The -od<drive> (output drive) switch allows the user to specify the Output Drive for a simulation. 
For example, the following will redirect all outputs to the C:\ drive: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -odC "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Specify Map Output===
The -oz<name> (output zone) switch specifies that the map output includes the input zone. 
For example, the following would include output for 'Zone A': 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -ozZoneA "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Query the Creation of a Folder===
The -qcf (query the creation of a folder) switch is useful if you would prefer to have the create folder query dialog appear (rather than TUFLOW automatically creating folders - see [[Run_TUFLOW_From_a_Batch-file#Automatically_Create_Folders_in_a_TUFLOW_model | -acf]]). 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -qcf "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Execute a Simulation (the Default)===
The -x (execute) switch executes the simulation. This switch is used by default and does not need to be included on the TUFLOW command line.

===Copy or Test Model License Free===
For Build 2018-03-AA or later, it is possible to use the [[Run_TUFLOW_From_a_Batch-file#Copy_a_TUFLOW_model | copy model]] (-c option) or [[Run_TUFLOW_From_a_Batch-file#Testing_a_simulation | test model]] (-t option) without using a license. To utilise this licence free copy/test, the -nlc (no license check) input argument must be specified. If running without a TUFLOW licence, no diagnostic output is generated (e.g. messages layer). If these are required, the -nlc option must be removed.

===Simulation Log Path (Legacy)===
The -slp (simulation log path) switch is a legacy option for Solftlock (blue) dongles to set the path to a folder on the intranet to log all simulation initiated from the lock. Refer to the [https://www.tuflow.com/downloads/ TUFLOW Manual] (2018 or earlier) for details. 

==Advanced Batch Files==
The below section shows example batch files for maximizing run efficiency,
===Creating a delay===
====Windows 7 and newer====
For a Windows 7 and newer operating system a delay of a set duration can be created with the Timeout <seconds> command. For example: 
<pre>Timeout 10</pre>
Will create a 10 second delay, a countdown timer is given. Press any key to continue.

====Other Systems====
It is possible to create a delay of specified length in a batch file. The best way do this is actually to create a second batch file! To do this create a text file and call it '''wait.bat'''. Within that file enter the following text:
<pre>@ping 127.0.0.1 -n 2 -w 1000 > nul
@ping 127.0.0.1 -n %1% -w 1000> nul</pre>
To create the pause we ping an address for a set time and disregard the output. Once the wait.bat has been created, it can be called from another batchfile using the following syntax:
<pre>call wait <time in seconds.</pre>
In the example below, the first simulation is started and then 60 seconds later (using the wait.bat file) the second simulation is started. Note there is no /wait flag specified, if there was the batchfile would wait for 60 seconds after the first simulation had finished before starting the second simulation.
<pre>Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
call wait 60
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>
For this to work the wait.bat file needs to be in the same folder as the batchfile calling it. You can put the file in a specific location and add this path as an environment variable. If this is done "call wait <time in seconds> can be added to any batch file. 
To set the environment variable, you will need to have administrator access to the machine, and add a colon (;) and then the batchfile location (e.g. "C:\batch_files\" , without the quotes) in the '''path''' system variables. The separator character is a colon (;) this is added to specify a new path. For more details on modifying the environment please see here: [https://support.microsoft.com/kb/310519 https://support.microsoft.com/kb/310519].

===Variables===
Batch files can be easily setup so that they are more generic and easily customised when moving from one project to another. For example, in the below a variable, TUFLOWEXE, is used to define the path to the TUFLOW exe to be used, and a variable RUN is used to incorporate options such as the /wait so that the simulations run in series (one after the other).

<pre>set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
set RUN=start "TUFLOW" /wait %TUFLOWEXE% -b
%RUN% MR_H99_C25_Q100.tcf
%RUN% MR_H99_C25_Q050.tcf
%RUN% MR_H99_C25_Q020.tcf</pre>
The advantage of using variables is if the path to the TUFLOW exe changes, or to run a different version of TUFLOW, it is just a simple change in the .bat file. In the above, note the use of quotes the TUFLOW executable path – quotes are needed around file pathnames whenever they contain a space.

===Looping in a batch file===
If you have a large number of events to run using the event files a for loop can be used in a batch file. In this example we have 5 event magnitudes (-e1 input) and 5 event durations (-e2 input). The following batch file can be used to run all 25 simulations one after the other:
<pre>
@echo off

REM This sets the variables as local, so you can use another batch file with A and B variables
SetLocal

REM set up variables
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min

REM Loop Through
FOR %%a in (%A%) do (
FOR %%b in (%B%) DO (
start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf
)
)
pause
</pre>
In order to test the syntax, you can test the batch file by replacing the following line: 
<tt>start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt> 
With the following line: 
<tt>echo start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt> 
By using the echo in the command line, rather than starting the simulations the command line will be displayed in the DOS output. In the example above the DOS output is shown in the image below.
[[File:DOS nested batch output.png|frame|none]]

Alternatively this can be achieved using the following syntax, which is essentially the same but has the for loops compressed to a single line:
<pre>
@echo off
setlocal
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min

FOR %%a in (%A%) do FOR %%b in (%B%) do start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename_~e1~_~e2~.tcf
pause
</pre>
This can be extended to more variables for example:
<pre>
@echo off
setlocal
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min
set C=Exg Dev Mit

FOR %%a in (%A%) do (
FOR %%b in (%B%) do (
FOR %%c in (%C%) do (
start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b -s1 %%c filename_~e1~_~e2~_~s1~.tcf
)
)
)
pause
</pre>

===Looping in a batch file up to a certain number of runs===
The below example shows a method for controlling the number of concurrent simulations. 

As a brief description of the below, the "do_while_loop_start" counts the number of processes in the task manager which have "TUFLOW" in the name. If this is greater than or equal to the variable "CPU_Cores" then the batch file waits for 60 seconds.

<pre>
@ echo off

Set A=Q001 Q002 Q005 Q010 Q020 Q050 Q100
Set B=Exg Dev
set /a CPU_Cores=3

FOR %%a in (%A%) DO (
FOR %%b in (%B%) DO (
call :do_while_loop_start
Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
)
)

Pause

:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
if %count% geq %CPU_Cores% (
PING 1.1.1.1 -n 1 -w 60000 >NUL
goto do_while_loop_start
)
</pre>

Another way to achieve the same result using IF logic is shown below. This batch file will loop through the series of 14 simulations in groups of three. The batch file will pause until the last of the three active model simulations are complete. When complete, the next series of three simulations will be started in parallel.

<pre>
@ echo off
setlocal enabledelayedexpansion

SET A=Q001 Q002 Q005 Q010 Q020 Q050 Q100
SET B=Exg Dev
SET P=3

SET /A Counter=0
FOR %%a in (%A%) DO (
FOR %%b in (%B%) DO (
SET /A Counter+=1
IF /i !Counter!==!P! (
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
SET /A Counter=0
) ELSE (
Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
)
)
)
</pre>

===Looping in a batch file using scenario logic===
Sometimes when using different scenarios, it is useful to run a specific set of events for one scenario but other events for a different scenario. 
This can be automated within looped batch files using a bit of logic. 
In the the example below there is model with defended and undefended scenarios. The defended scenario needs to be run for the 20, 100 and 200 year events but the undefended scenario is only run for the 100 year event. All models are run for the hr and 3hr critical durations. 
The below batch file also uses the looping up to a certain number of runs, as seen in the point above. 
To customize this script, alter the location of the TUFLOW executable, the name of tcf and the scenarios that you would like to run (Refer to 'Set A==', 'Set C==' and 'Set B=='). 
<pre>
@ echo off
setlocal enabledelayedexpansion

REM ______________SET RUN VARIABLES_____________
set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
set RUN=start "TUFLOW" /low %TUFLOWEXE% -b
set /a CPU_Cores=5

set tcf=M01_5m_~s1~_~e1~_~e2~_001.tcf

Set A=UDEF DEF
REM set B in loop beow
Set C==01hr 03hr

REM ______________SET LOOPS____________________
FOR %%a in (%A%) do (

REM _____DEFINE RUN LOGIC______
IF "%%a"=="UDEF" (
set B=100yr
)
IF "%%a"=="DEF" (
set B=020yr 100yr 200yr
)

REM ______________RUN LOOPS____________________
FOR %%b in (!B!) do (
FOR %%c in (%C%) do (
call :do_while_loop_start
%RUN% -s1 %%a -e1 %%b -e2 %%c %tcf%
timeout 60

)
)
)

REM ___________COUNT RUN INSTANCES______________
:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
if %count% geq %CPU_Cores% (
PING 1.1.1.1 -n 1 -w 60000 >NUL
goto do_while_loop_start
)

endlocal
</pre>

===Copy model, checks and results in a looped batch file===
This batch file uses the copy model function to copy the model (inputs and check files), of both scenarios 5m and 2.5m, to a specified folder location. After copying, [https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/robocopy robocopy] is used to copy the results, based off the tcf filename and specified scenarios, to the destination result folder.
<pre>
@echo off

set TUFLOWEXE_iSP="C:\Releases\2023-03-AF\TUFLOW_iSP_w64.exe"
set RUN_iSP=start "TUFLOW" /wait %TUFLOWEXE_iSP% -cp "D:\tuflow_models\copy"

set A=5m 2.5m
set source_results=..\results
set destination_results=C:\tuflow_models\copy\results

FOR %%a in (%A%) do (
:: Copy model
%RUN_iSP% -s1 %%a M01_~s1~_001.tcf

:: Copy results folder to copy model location
robocopy "%source_results%" "%destination_results%" "M01_%%a_001*" /S

)
pause
</pre>

===Coordinating Asynchronous Simulations===
This batch file will set off asynchronous runs on separate threads, and then wait for all runs to finish before moving to the next process. This example kicks off 8 tuflow.exe processes and then waits before collating (in fortran) and processing the results (in python). Both “combine_therad_outputs.exe” and “Post_process.py” are dummy programs only (with dummy arguments), and are included just to demonstrate how any sort of post processing might be called after the synchronisation of all TUFLOW simulations.

<pre>
@echo off

:: Set local
setlocal
:: User defined variables – will need to be changed
set "for_infile=inputs_fortran.inp"
set "run_exe="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe""
set "file_prefix=C:\temp\test"
set "sum_exe=combine_thread_outputs.exe"
set "n_threads=8"
set "pyt_code=Post_process.py"
set "pyt_infile=inputs_python.inp"

:: Random lock file
set "lock=%temp%\wait%random%.lock"

:: Launch processes asynchronously, with stream 9 redirected to a lock file.
:: The lock file will remain locked until the individual exe instance ends.
:: %%a is sent to %run_exe% as an argument to set the thread to use
for /L %%a in (0,1,7) do (
start "" 9>"%lock%%%a" %run_exe% %for_infile% %%a
)

:: Wait for the processes to finish
:Waitrun
1>nul 2>nul ping /n %n_threads% ::1
for /L %%N in (0,1,7) do (
(call ) 9>"%lock%%%N" || goto :Waitrun
) 2>nul

:: Delete the lock files
del "%lock%*"

:: Collate thread outputs
%sum_exe% %file_prefix% %n_threads%

:: Make image
python %pyt_code% %pyt_infile%

:: Finish up
echo Done.
</pre>

===Shutdown on Completion===
Often we may have a number of TUFLOW simulations going when we leave work on a Friday afternoon, if these are not going to take all weekend to run, using some of the batch file logic above you can create a batch file that will shutdown the computer when no TUFLOW simulations are running. An example batch file for this purpose is below: 
<pre>
echo off

:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
IF %count%==0 (
shutdown.exe /s /t 30
) ELSE (
timeout 60
goto do_while_loop_start
)
pause
</pre>
This batch file counts the number of processes with "TUFLOW" in the process name and if this is greater than 0, a delay of 60 seconds is created and the loop started again. If no "TUFLOW" simulations are running a shutdown command is issued. 
To test the batch file it is recommended that you add an "echo" in front of the <tt>shutdown.exe /s /t 30</tt> command to ensure it is working correctly (I use this on a Windows 7 machine, but have not tested it on either XP or Windows 8). 
In order to restart the machine rather than power it off the /s can be replaced with /r. This can be useful when a heavily utilised modelling computer needs a restart!
</ol>

Run TUFLOW From a Batch-file

2025-03-07T05:13:17Z

ElizaCollison: /* Variables */

TUFLOW simulations can also be started from a batch file. Batch files are text files which contain a series of commands. Batch files allow a large degree of flexibility in starting TUFLOW simulations, advanced batch files can be used to:

* Run multiple simulations
* Set CPU priority for TUFLOW simulations
* Create a wait (e.g. start a simulation in 1 hour)
* Test simulation input
* Copy a TUFLOW model
* Package a TUFLOW model
* Post process results after simulation has finished.
Batch files are executed by double clicking the created .bat file from Windows Explorer.
<ol>
==Simple batch file==
To use a batch file, create a new text file in the TUFLOW\runs directory. The name is arbitrary but the file must have the extension ".bat". For example the file name could be '''_run_TUFLOW.bat'''.

Open this file in a text editor and add the following line.

<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
This is the simplest command line for starting TUFLOW, the line above contains only two arguments, the first is the path to the TUFLOW executable and the second argument "M01_5m_001.tcf" is the simulation file name. Depending on the location of the executable the above command line will need to be modified. The quotations around the TUFLOW executable and the .tcf file name are only required if there are spaces in the file names. However, it is recommended to include these to avoid problems.

==Batch File Switches==
These switches are available in all batch files, they are not specific to TUFLOW.

===Pause===
A second line with the text "pause" can be added, this will prompt the user to press a key at the end of the batch file. This is useful if the DOS window disappears from the screen, before you can read the output. The pause command will keep the window open.
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"
pause</pre>

===Starting process in new window===
In order to run multiple simulations at the same time, each simulation needs be started in a new console window. To do this begin the batch file line with the "Start" command, a for the window is then added. For example, to start the simulation above in a new window titled "TUFLOW" the following would be used.

<pre>Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
===Wait===
If multiple simulations are to be run, it is often desirable to run these in series, i.e. the second simulation starts after the first has finished. a /wait switch can be added which makes the batch file wait until the process is finished before moving onto the next command. 
An example of this is: 
<pre>Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>
Without the wait command, both simulations would start at the same time. 
'''Note:''' Unless there is a third simulation in the batch file the /wait command in the second line is not required, this prevents the batchfile from moving onto the third line.
===Setting a priority===
The priority of a process (such a TUFLOW simulation) can be specified within a batch file. This can be useful for a number of reasons:
*Lowering the priority of a simulation to allow you to continue working;
*Setting a high priority for critical runs; or
*Making sure you runs are high priority on a shared computing resource!

The following are valid priority switches (in increasing order of priority):
*/LOW
*/BELOWNORMAL
*/NORMAL
*/ABOVENORMAL
*/HIGH
*/REALTIME

An example of a low priority simulation is: 
<pre>start "TUFLOW" /low "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
'''TIP:''' The priority of a TUFLOW simulation can be changed at a later stage by using the '''Windows Task Manager''', navigate to the '''Processes''' tab and right click on the TUFLOW process (e.g. TUFLOW_iSP_w64.exe) and select the set priority option.

===Minimising the console window===
Using the /min switch will keep the console window for TUFLOW models minimised, so it doesn't pop up to the front every time when the next model starts.
<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>

==No Console Option==
Using the -nc switch will run a simulation without opening a DOS console window. This option is desirable for people running simulation on the cloud. Note, if an invalid .tcf file is specified, the simulation stops and returns an error level of 1 to the operating system.

<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_5m_001.tcf
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_2.5m_001.tcf</pre>

== TUFLOW switches in a batch file==
These switches are specific to TUFLOW simulations.
===Testing a simulation===
The -t (test) switch is very useful for testing the data input without running the simulation. It is good practice to use this switch before carrying out the simulations, as this will tell you whether there are any data input problems. The -t switch runs TUFLOW to just before it starts the hydrodynamic computations.
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -t "M01_5m_001.tcf"</pre>

===Batch mode in TUFLOW===
The use of the –b (batch) switch which suppresses the need to press the return key at the end of a simulation. This ensures that one simulation proceeds on to the next without any need for user input. This is required for running multiple simulations in series (one after the other).
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b "M01_5m_001.tcf"</pre>

===Automatically Create Folders in a TUFLOW model===
The use of the -acf (automatically create folders) switch prevents the dialog prompt from appearing when encountering non-existent folders (ie. results folders), and creates these folders automatically. If for any reason the folder can't be created, a dialog will appear. This feature was first introduced for Build 2012-05-AE and is not available for TUFLOW builds prior to this. For models simulated with Build 2013-12-AA or later, non-existent folders are now automatically created. If you would prefer to have the create folder query dialog to appear, you can specify the –qcf run time option (stands for query create folders). 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -acf "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Suppress Queries in a TUFLOW model===
The use of the -nq (no queries) switch prevents the termination query dialog from displaying when Ctrl+C is pressed to terminate a simulation cleanly. If –nq is specified and Ctrl-C is pressed, the simulation terminates cleanly without a query dialog to check you are certain, so be careful! This feature was first introduced for Build 2012-05-AE and is not available for TUFLOW builds prior to this. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nq "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Copy a TUFLOW model===
TUFLOW can be run in copy mode, which can be useful for transferring a model to another site or for making an archive of the input data. 

To copy a TUFLOW model, the '''-c''' switch must be included on the TUFLOW command line, as a minimum. The '''-c''' switch copies only the files read by TUFLOW. As such, for MapInfo users, the .mif and .mid files read by TUFLOW will be copied. The remaining MapInfo format files (.tab, .id, .dat and .map) are not read by TUFLOW and will not be copied. By default, the '''-c''' switch copies all TUFLOW inputs for the simulation into a subdirectory where the .tcf is located (generally TUFLOW\runs\). 

Additional optional flags can be added to the base '''-c''' switch, in any combination, including: 
;* “a” (all); 
: The addition of the “a” flag (e.g. -ca) copies all files of the same name for all input files (ie. same name, but different extensions). This option is particularly useful if the .tab and other associated files of a GIS layer need to be archived or delivered. 
;*“L” (list); 
: The addition of the “L” flag will output the files used by TUFLOW into a .tcl (TUFLOW Copy List) file but not copy the files to a destination folder. This can be useful if scripting the copying of models. To run the copy list the character “L” needs to be specified after the -c input argument. This works for all copy options, for example, the following are all valid; -cL, -caL, -capL. The .tcl file produced is output in the same directory as the .tcf and takes the simulation name.
;* “p” (path); and 
: The addition of the “p” flag (e.g. -cp) allows the user to specify an alternate path in which to copy the model. Without this flag, the location defaults to the .tcf’s location. For example, specifying the following, will place a copy of the model into a folder C:\put_model_here: 
REM <tt>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cp "C:\put_model_here" "C:\TUFLOW\runs\M01_5m_001.tcf"</tt> 
;* “ncf” (no check files) 
: The addition of the “ncf” flag (e.g. -cncf) copies the essential input files and excludes all check files. 

Note that these optional flags can be added in any combination to the base '''-c''' switch (e.g.
-c, -ca, -cp, -cncf, -cap, -cancf, -cpncf, -capncf). 

Specifying '''-c''' on the TUFLOW command line creates a folder “<.tcf filename>_copy” (or “<.tcf filename>_copy_all” if the “a” flag is added) in the same location as the .tcf file. Under the folder, input files are copied (including the full folder structure), and any check files and output folders created. For example, specifying: 
: <tt>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -c “C:\tuflow_models\my model.tcf”</tt> will make a copy of the TUFLOW model based on the file <tt>“my model.tcf”</tt> in a folder <tt>"my model.tcf_copy"</tt>, or <tt>"my model.tcf_copy_all"</tt> if using the “a” flag. 

'''Note:'''
<ol>
<li> Use the full path to the .tcf file (this is the default if running from UltraEdit or using the right click approach).
<li>Make sure there is sufficient disk space (no checks for sufficient disk space are made).
<li>Output folders and some output files are created but these will be empty.
<li>Any check folder(s) are created and check files written (these can be deleted if wishing to minimise the size of the folder).
<li>The full path of the input files is reproduced to provide traceability and also handle inputs from other drives and URLs. Drive letters are replaced, for example, “C:” becomes a folder “C Drive”. URLs (denoted by “\\” or “//” at the beginning of the path) are replaced by a folder called “URL\”.
<li>To run the copied .tcf file, it will be necessary to change any non-relative pathnames according to the point above. Alternatively you can share and then map, for example, the “D Drive” folder as “D:”.
<li>The Check MI Save Date will need to be set to WARNING or OFF in the .tcf file if the –ca option has not been used as the .tab and other files will not have been copied.
<li>There is a limit of 1,000 characters (including spaces) on pathnames. As very long pathnames can result due to the above approach, if the number of characters exceeds 1,000, problems may occur.
<li>The -c switch automatically invokes the -t (ie. the simulation does not commence, only the input data is tested/checked).
<li>The -b option still applies if several models wish to be copied using a batch (.bat) file.
</ol> 

An example that copies all files (-ca switch) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -ca "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example that copies all files to an alternate path (-cap) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cap "C:\Copy_of_model" "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example that copies all files to an alternate path, excluding any check files, (-capncf) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -capncf "C:\Copy_of_model" "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Package a TUFLOW model===
Package model function attempts to copy all input files for all events and scenarios defined in the model, if only single set of events and scenarios is required, -c is preferable. Unlike the -c option, -pm does not read and process the data during the file copy, as such it is substantially faster than -c. The package model function does not require access to a TUFLOW licence.

A tool in QGIS (as part of the TUFLOW Plugin) exists which provides a dialog to the package model options, which allows users to bypass the creation of a batch file: 
[[Package_Model_in_QGIS | Package Model in QGIS]]

Additional optional flags can be added to the base '''-pm''' switch, in any combination, including: 
;* “All”; 
: The addition of the “All” flag (e.g. -pmAll) copies all file extensions (e.g. 1d_nwk_culv_L.mif, will become 1d_nwk_culv_L.*). 
;* “L” (list); and 
: The addition of the “L” flag (e.g. -pmL) list the files to be copied into an output file, but don’t copy. 
;* “ini” (file.ini) 
: The addition of the “ini” flag (e.g. -pmini) provides a .ini file with user defined options. A .ini file can be used to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames. Valid options should be separated by a vertical bar. 

Combinations of the above are also valid, with the order of the optional switches not being important (-pmAllL would be treated the same as -pmLAll). 
When using package model the default destination folder is created in the same directory as the .tcf file, with the prefix “pm_”. For example, C:\Projects\Modelling\TUFLOW\runs\Run_001.tcf will create a package in the folder “C:\Projects\Modelling\TUFLOW\runs\pm_Run_001\. 

Three options are also available for handling of the binary processed files created by TUFLOW to speed up the simulation start. These options are: 
;* “-xf0”; 
: Do not copy .xf files, only the original inputs are copied. 
;* “-xf1”; and 
: Copy both raw input files and .xf files. 
;* “-xf2” 
: Copy only .xf files, if xf files exist for an input only the xf will be copied. 
 
An example of package model that copies all files is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAll "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of package model that copies all files except .xf files, (-pmAll -xf0) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAll -xf0 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of package model that copies all files with specified .ini file (-pmAllini) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAllini package.ini "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of .ini file to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames: 
<pre>
Base Folder == <folder>
Copy Destination == <folder>
Model Scenario ~s<number>~ == <scenario A> | <scenario B> | …
Model Event ~e<number>~ == <event A> | <event B> | …
</pre>

===GPU Module Control===
The -pu switch can be used to select which GPU card or cards to direct the simulation towards. –pu must be specified once for each device. For example, to direct the simulation to GPU devices 0 and 2, specify -pu0 -pu2. (Note: the GPU device numbering starts a 0, not 1). For example:
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pu0 -pu2 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Event and Scenario Management===
The -e and -s switches can be used to manage multiple events and scenarios from a single tuflow control file. The -e and -s wildcard is replaced by the following entry specified in the batch file. For example, the following batch file commands will run two simulations in series:
* M01_Q050_24hr_2m_Dev_001.tcf; and
* M01_Q100_24hr_2m_Dev_001.tcf;

<pre>Start "TUFLOW" /wait "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 Q050 -e2 24hr -s1 2m -s2 Dev "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_~e1~_~e2~_~s1~_s2~_001.tcf"
Start "TUFLOW" /wait "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 Q100 -e2 24hr -s1 2m -s2 Dev "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_~e1~_~e2~_~s1~_s2~_001.tcf"</pre>

Please be aware that the % symbol is a special character in a batch file. If the % symbol is used within a wildcard, it will not be read when searching for that wildcard in TUFLOW. 
For example if the following event wildcard is used; 
*-e 10% 
TUFLOW will search for '10' instead of '10%' as the event wildcard. 
 
It is recommended that modellers avoid the use of a % symbol in any wildcard values. The string 'pct' is a great alternative for the % symbol. 
For example, using: 
*-e 10pct 
Alternatively, using the % symbol twice in a row as shown below should result in a desired wildcard value. 
*-e 10%% (TUFLOW will search for 10%)

===Set Hardware===
The -hwgpu or -hwcpu switches can be used overwrite any "Hardware ==' command specified in the .tcf to GPU or CPU, respectively. This feature was first introduced for Build 2023-03-AB and is not available for TUFLOW builds prior to this.

These switches can be used in conjunction with the -nt (number of threads) or -pu (processing unit id) to provide full control over the hardware usage via the command line.

The following command could be used to run a model with CPU hardware on 8 threads:
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -hwcpu -nt8 FS_Hardware_01.tcf </pre>

The following command could be used to run a model on GPU hardware using 2 devices (GPU 0 and GPU1):
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -hwgpu -pu0 -pu1 FS_Hardware_01.tcf </pre>

===Set Start Time for a Simulation===
The use of the -st<time_in_hours> (start time) switch allows the user to specify the start time for a simulation. Any start time specified via this run option argument is given the highest priority and overrides the "Start Time ==" settings in the .tcf, event files (.tef) and override files. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -st0 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Set End Time for a Simulation===
The use of the -et<time_in_hours> (end time) switch allows the user to specify the end time for a simulation. Any end time specified via this run option argument is given the highest priority and overrides the "End Time ==" settings in the .tcf, event files (.tef) and override files. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -et3 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Suppress Message Box Prompts===
The use of the -nmb (no message boxes) switch suppresses the use of Windows message boxes to prompt the user. All prompts will be via the console window. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nmb "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Search for a Network License===
The use of the -nwk (network) switch forces TUFLOW to search for a network licence. I.e. Skip the search for a local license. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nwk "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Search for a WIBU License===
The use of the -wibu (WIBU license) switch forces TUFLOW to search only for a WIBU Codemeter license. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -wibu "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Specify the Output Drive===
The -od<drive> (output drive) switch allows the user to specify the Output Drive for a simulation. 
For example, the following will redirect all outputs to the C:\ drive: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -odC "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Specify Map Output===
The -oz<name> (output zone) switch specifies that the map output includes the input zone. 
For example, the following would include output for 'Zone A': 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -ozZoneA "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Query the Creation of a Folder===
The -qcf (query the creation of a folder) switch is useful if you would prefer to have the create folder query dialog appear (rather than TUFLOW automatically creating folders - see [[Run_TUFLOW_From_a_Batch-file#Automatically_Create_Folders_in_a_TUFLOW_model | -acf]]). 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -qcf "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Execute a Simulation (the Default)===
The -x (execute) switch executes the simulation. This switch is used by default and does not need to be included on the TUFLOW command line.

===Copy or Test Model License Free===
For Build 2018-03-AA or later, it is possible to use the [[Run_TUFLOW_From_a_Batch-file#Copy_a_TUFLOW_model | copy model]] (-c option) or [[Run_TUFLOW_From_a_Batch-file#Testing_a_simulation | test model]] (-t option) without using a license. To utilise this licence free copy/test, the -nlc (no license check) input argument must be specified. If running without a TUFLOW licence, no diagnostic output is generated (e.g. messages layer). If these are required, the -nlc option must be removed.

===Simulation Log Path (Legacy)===
The -slp (simulation log path) switch is a legacy option for Solftlock (blue) dongles to set the path to a folder on the intranet to log all simulation initiated from the lock. Refer to the [https://www.tuflow.com/downloads/ TUFLOW Manual] (2018 or earlier) for details. 

==Advanced Batch Files==
The below section shows example batch files for maximizing run efficiency,
===Creating a delay===
====Windows 7 and newer====
For a Windows 7 and newer operating system a delay of a set duration can be created with the Timeout <seconds> command. For example: 
<pre>Timeout 10</pre>
Will create a 10 second delay, a countdown timer is given. Press any key to continue.

====Other Systems====
It is possible to create a delay of specified length in a batch file. The best way do this is actually to create a second batch file! To do this create a text file and call it '''wait.bat'''. Within that file enter the following text:
<pre>@ping 127.0.0.1 -n 2 -w 1000 > nul
@ping 127.0.0.1 -n %1% -w 1000> nul</pre>
To create the pause we ping an address for a set time and disregard the output. Once the wait.bat has been created, it can be called from another batchfile using the following syntax:
<pre>call wait <time in seconds.</pre>
In the example below, the first simulation is started and then 60 seconds later (using the wait.bat file) the second simulation is started. Note there is no /wait flag specified, if there was the batchfile would wait for 60 seconds after the first simulation had finished before starting the second simulation.
<pre>Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
call wait 60
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>
For this to work the wait.bat file needs to be in the same folder as the batchfile calling it. You can put the file in a specific location and add this path as an environment variable. If this is done "call wait <time in seconds> can be added to any batch file. 
To set the environment variable, you will need to have administrator access to the machine, and add a colon (;) and then the batchfile location (e.g. "C:\batch_files\" , without the quotes) in the '''path''' system variables. The separator character is a colon (;) this is added to specify a new path. For more details on modifying the environment please see here: [https://support.microsoft.com/kb/310519 https://support.microsoft.com/kb/310519].

===Variables===
Batch files can be easily setup so that they are more generic and easily customised when moving from one project to another. For example, in the below a variable, TUFLOWEXE, is used to define the path to the TUFLOW exe to be used, and a variable RUN is used to incorporate options such as the /wait so that the simulations run in series (one after the other).

<pre>set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
set RUN=start "TUFLOW" /wait %TUFLOWEXE% -b
%RUN% MR_H99_C25_Q100.tcf
%RUN% MR_H99_C25_Q050.tcf
%RUN% MR_H99_C25_Q020.tcf</pre>
The advantage of using variables is if the path to the TUFLOW exe changes, or to run a different version of TUFLOW, it is just a simple change in the .bat file. In the above, note the use of quotes the TUFLOW executable path – quotes are needed around file pathnames whenever they contain a space.

===Looping in a batch file===
If you have a large number of events to run using the event files a for loop can be used in a batch file. In this example we have 5 event magnitudes (-e1 input) and 5 event durations (-e2 input). The following batch file can be used to run all 25 simulations one after the other:
<pre>
@echo off

REM This sets the variables as local, so you can use another batch file with A and B variables
SetLocal

REM set up variables
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min

REM Loop Through
FOR %%a in (%A%) do (
FOR %%b in (%B%) DO (
start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf
)
)
pause
</pre>
In order to test the syntax, you can test the batch file by replacing the following line: 
<tt>start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt> 
With the following line: 
<tt>echo start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt> 
By using the echo in the command line, rather than starting the simulations the command line will be displayed in the DOS output. In the example above the DOS output is shown in the image below.
[[File:DOS nested batch output.png|frame|none]]

Alternatively this can be achieved using the following syntax, which is essentially the same but has the for loops compressed to a single line:
<pre>
@echo off
setlocal
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min

FOR %%a in (%A%) do FOR %%b in (%B%) do start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename_~e1~_~e2~.tcf
pause
</pre>
This can be extended to more variables for example:
<pre>
@echo off
setlocal
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min
set C=Exg Dev Mit

FOR %%a in (%A%) do (
FOR %%b in (%B%) do (
FOR %%c in (%C%) do (
start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b -s1 %%c filename_~e1~_~e2~_~s1~.tcf
)
)
)
pause
</pre>

===Looping in a batch file up to a certain number of runs===
The below example shows a method for controlling the number of concurrent simulations. 

As a brief description of the below, the "do_while_loop_start" counts the number of processes in the task manager which have "TUFLOW" in the name. If this is greater than or equal to the variable "CPU_Cores" then the batch file waits for 60 seconds.

<pre>
@ echo off

Set A=Q001 Q002 Q005 Q010 Q020 Q050 Q100
Set B=Exg Dev
set /a CPU_Cores=3

FOR %%a in (%A%) DO (
FOR %%b in (%B%) DO (
call :do_while_loop_start
Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
)
)

Pause

:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
if %count% geq %CPU_Cores% (
PING 1.1.1.1 -n 1 -w 60000 >NUL
goto do_while_loop_start
)
</pre>

Another way to achieve the same result using IF logic is shown below. This batch file will loop through the series of 14 simulations in groups of three. The batch file will pause until the last of the three active model simulations are complete. When complete, the next series of three simulations will be started in parallel.

<pre>
@ echo off
setlocal enabledelayedexpansion

SET A=Q001 Q002 Q005 Q010 Q020 Q050 Q100
SET B=Exg Dev
SET P=3

SET /A Counter=0
FOR %%a in (%A%) DO (
FOR %%b in (%B%) DO (
SET /A Counter+=1
IF /i !Counter!==!P! (
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
SET /A Counter=0
) ELSE (
Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
)
)
)
</pre>

===Looping in a batch file using scenario logic===
Sometimes when using different scenarios, it is useful to run a specific set of events for one scenario but other events for a different scenario. 
This can be automated within looped batch files using a bit of logic. 
In the the example below there is model with defended and undefended scenarios. The defended scenario needs to be run for the 20, 100 and 200 year events but the undefended scenario is only run for the 100 year event. All models are run for the hr and 3hr critical durations. 
The below batch file also uses the looping up to a certain number of runs, as seen in the point above. 
To customize this script, alter the location of the TUFLOW executable, the name of tcf and the scenarios that you would like to run (Refer to 'Set A==', 'Set C==' and 'Set B=='). 
<pre>
@ echo off
setlocal enabledelayedexpansion

REM ______________SET RUN VARIABLES_____________
set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
set RUN=start "TUFLOW" /low %TUFLOWEXE% -b
set /a CPU_Cores=5

set tcf=M01_5m_~s1~_~e1~_~e2~_001.tcf

Set A=UDEF DEF
REM set B in loop beow
Set C==01hr 03hr

REM ______________SET LOOPS____________________
FOR %%a in (%A%) do (

REM _____DEFINE RUN LOGIC______
IF "%%a"=="UDEF" (
set B=100yr
)
IF "%%a"=="DEF" (
set B=020yr 100yr 200yr
)

REM ______________RUN LOOPS____________________
FOR %%b in (!B!) do (
FOR %%c in (%C%) do (
call :do_while_loop_start
%RUN% -s1 %%a -e1 %%b -e2 %%c %tcf%
timeout 60

)
)
)

REM ___________COUNT RUN INSTANCES______________
:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
if %count% geq %CPU_Cores% (
PING 1.1.1.1 -n 1 -w 60000 >NUL
goto do_while_loop_start
)

endlocal
</pre>

===Copy model, checks and results in a looped batch file===
This batch file uses the copy model function to copy the model (inputs and check files), of both scenarios 5m and 2.5m, to a specified folder location. After copying, [https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/robocopy robocopy] is used to copy the results, based off the tcf filename and specified scenarios, to the destination result folder.
<pre>
@echo off

set TUFLOWEXE_iSP=C:\Releases\2023-03-AF\TUFLOW_iSP_w64.exe
set RUN_iSP=start "TUFLOW" /wait "%TUFLOWEXE_iSP%" -cp "D:\tuflow_models\copy"

set A=5m 2.5m
set source_results=..\results
set destination_results=C:\tuflow_models\copy\results

FOR %%a in (%A%) do (
:: Copy model
%RUN_iSP% -s1 %%a M01_~s1~_001.tcf

:: Copy results folder to copy model location
robocopy "%source_results%" "%destination_results%" "M01_%%a_001*" /S

)
pause
</pre>

===Coordinating Asynchronous Simulations===
This batch file will set off asynchronous runs on separate threads, and then wait for all runs to finish before moving to the next process. This example kicks off 8 tuflow.exe processes and then waits before collating (in fortran) and processing the results (in python). Both “combine_therad_outputs.exe” and “Post_process.py” are dummy programs only (with dummy arguments), and are included just to demonstrate how any sort of post processing might be called after the synchronisation of all TUFLOW simulations.

<pre>
@echo off

:: Set local
setlocal
:: User defined variables – will need to be changed
set "for_infile=inputs_fortran.inp"
set "run_exe="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe""
set "file_prefix=C:\temp\test"
set "sum_exe=combine_thread_outputs.exe"
set "n_threads=8"
set "pyt_code=Post_process.py"
set "pyt_infile=inputs_python.inp"

:: Random lock file
set "lock=%temp%\wait%random%.lock"

:: Launch processes asynchronously, with stream 9 redirected to a lock file.
:: The lock file will remain locked until the individual exe instance ends.
:: %%a is sent to %run_exe% as an argument to set the thread to use
for /L %%a in (0,1,7) do (
start "" 9>"%lock%%%a" %run_exe% %for_infile% %%a
)

:: Wait for the processes to finish
:Waitrun
1>nul 2>nul ping /n %n_threads% ::1
for /L %%N in (0,1,7) do (
(call ) 9>"%lock%%%N" || goto :Waitrun
) 2>nul

:: Delete the lock files
del "%lock%*"

:: Collate thread outputs
%sum_exe% %file_prefix% %n_threads%

:: Make image
python %pyt_code% %pyt_infile%

:: Finish up
echo Done.
</pre>

===Shutdown on Completion===
Often we may have a number of TUFLOW simulations going when we leave work on a Friday afternoon, if these are not going to take all weekend to run, using some of the batch file logic above you can create a batch file that will shutdown the computer when no TUFLOW simulations are running. An example batch file for this purpose is below: 
<pre>
echo off

:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
IF %count%==0 (
shutdown.exe /s /t 30
) ELSE (
timeout 60
goto do_while_loop_start
)
pause
</pre>
This batch file counts the number of processes with "TUFLOW" in the process name and if this is greater than 0, a delay of 60 seconds is created and the loop started again. If no "TUFLOW" simulations are running a shutdown command is issued. 
To test the batch file it is recommended that you add an "echo" in front of the <tt>shutdown.exe /s /t 30</tt> command to ensure it is working correctly (I use this on a Windows 7 machine, but have not tested it on either XP or Windows 8). 
In order to restart the machine rather than power it off the /s can be replaced with /r. This can be useful when a heavily utilised modelling computer needs a restart!
</ol>

Run TUFLOW From a Batch-file

2025-03-07T05:12:55Z

ElizaCollison: /* Variables */

TUFLOW simulations can also be started from a batch file. Batch files are text files which contain a series of commands. Batch files allow a large degree of flexibility in starting TUFLOW simulations, advanced batch files can be used to:

* Run multiple simulations
* Set CPU priority for TUFLOW simulations
* Create a wait (e.g. start a simulation in 1 hour)
* Test simulation input
* Copy a TUFLOW model
* Package a TUFLOW model
* Post process results after simulation has finished.
Batch files are executed by double clicking the created .bat file from Windows Explorer.
<ol>
==Simple batch file==
To use a batch file, create a new text file in the TUFLOW\runs directory. The name is arbitrary but the file must have the extension ".bat". For example the file name could be '''_run_TUFLOW.bat'''.

Open this file in a text editor and add the following line.

<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
This is the simplest command line for starting TUFLOW, the line above contains only two arguments, the first is the path to the TUFLOW executable and the second argument "M01_5m_001.tcf" is the simulation file name. Depending on the location of the executable the above command line will need to be modified. The quotations around the TUFLOW executable and the .tcf file name are only required if there are spaces in the file names. However, it is recommended to include these to avoid problems.

==Batch File Switches==
These switches are available in all batch files, they are not specific to TUFLOW.

===Pause===
A second line with the text "pause" can be added, this will prompt the user to press a key at the end of the batch file. This is useful if the DOS window disappears from the screen, before you can read the output. The pause command will keep the window open.
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"
pause</pre>

===Starting process in new window===
In order to run multiple simulations at the same time, each simulation needs be started in a new console window. To do this begin the batch file line with the "Start" command, a for the window is then added. For example, to start the simulation above in a new window titled "TUFLOW" the following would be used.

<pre>Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
===Wait===
If multiple simulations are to be run, it is often desirable to run these in series, i.e. the second simulation starts after the first has finished. a /wait switch can be added which makes the batch file wait until the process is finished before moving onto the next command. 
An example of this is: 
<pre>Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>
Without the wait command, both simulations would start at the same time. 
'''Note:''' Unless there is a third simulation in the batch file the /wait command in the second line is not required, this prevents the batchfile from moving onto the third line.
===Setting a priority===
The priority of a process (such a TUFLOW simulation) can be specified within a batch file. This can be useful for a number of reasons:
*Lowering the priority of a simulation to allow you to continue working;
*Setting a high priority for critical runs; or
*Making sure you runs are high priority on a shared computing resource!

The following are valid priority switches (in increasing order of priority):
*/LOW
*/BELOWNORMAL
*/NORMAL
*/ABOVENORMAL
*/HIGH
*/REALTIME

An example of a low priority simulation is: 
<pre>start "TUFLOW" /low "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
'''TIP:''' The priority of a TUFLOW simulation can be changed at a later stage by using the '''Windows Task Manager''', navigate to the '''Processes''' tab and right click on the TUFLOW process (e.g. TUFLOW_iSP_w64.exe) and select the set priority option.

===Minimising the console window===
Using the /min switch will keep the console window for TUFLOW models minimised, so it doesn't pop up to the front every time when the next model starts.
<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>

==No Console Option==
Using the -nc switch will run a simulation without opening a DOS console window. This option is desirable for people running simulation on the cloud. Note, if an invalid .tcf file is specified, the simulation stops and returns an error level of 1 to the operating system.

<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_5m_001.tcf
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_2.5m_001.tcf</pre>

== TUFLOW switches in a batch file==
These switches are specific to TUFLOW simulations.
===Testing a simulation===
The -t (test) switch is very useful for testing the data input without running the simulation. It is good practice to use this switch before carrying out the simulations, as this will tell you whether there are any data input problems. The -t switch runs TUFLOW to just before it starts the hydrodynamic computations.
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -t "M01_5m_001.tcf"</pre>

===Batch mode in TUFLOW===
The use of the –b (batch) switch which suppresses the need to press the return key at the end of a simulation. This ensures that one simulation proceeds on to the next without any need for user input. This is required for running multiple simulations in series (one after the other).
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b "M01_5m_001.tcf"</pre>

===Automatically Create Folders in a TUFLOW model===
The use of the -acf (automatically create folders) switch prevents the dialog prompt from appearing when encountering non-existent folders (ie. results folders), and creates these folders automatically. If for any reason the folder can't be created, a dialog will appear. This feature was first introduced for Build 2012-05-AE and is not available for TUFLOW builds prior to this. For models simulated with Build 2013-12-AA or later, non-existent folders are now automatically created. If you would prefer to have the create folder query dialog to appear, you can specify the –qcf run time option (stands for query create folders). 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -acf "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Suppress Queries in a TUFLOW model===
The use of the -nq (no queries) switch prevents the termination query dialog from displaying when Ctrl+C is pressed to terminate a simulation cleanly. If –nq is specified and Ctrl-C is pressed, the simulation terminates cleanly without a query dialog to check you are certain, so be careful! This feature was first introduced for Build 2012-05-AE and is not available for TUFLOW builds prior to this. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nq "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Copy a TUFLOW model===
TUFLOW can be run in copy mode, which can be useful for transferring a model to another site or for making an archive of the input data. 

To copy a TUFLOW model, the '''-c''' switch must be included on the TUFLOW command line, as a minimum. The '''-c''' switch copies only the files read by TUFLOW. As such, for MapInfo users, the .mif and .mid files read by TUFLOW will be copied. The remaining MapInfo format files (.tab, .id, .dat and .map) are not read by TUFLOW and will not be copied. By default, the '''-c''' switch copies all TUFLOW inputs for the simulation into a subdirectory where the .tcf is located (generally TUFLOW\runs\). 

Additional optional flags can be added to the base '''-c''' switch, in any combination, including: 
;* “a” (all); 
: The addition of the “a” flag (e.g. -ca) copies all files of the same name for all input files (ie. same name, but different extensions). This option is particularly useful if the .tab and other associated files of a GIS layer need to be archived or delivered. 
;*“L” (list); 
: The addition of the “L” flag will output the files used by TUFLOW into a .tcl (TUFLOW Copy List) file but not copy the files to a destination folder. This can be useful if scripting the copying of models. To run the copy list the character “L” needs to be specified after the -c input argument. This works for all copy options, for example, the following are all valid; -cL, -caL, -capL. The .tcl file produced is output in the same directory as the .tcf and takes the simulation name.
;* “p” (path); and 
: The addition of the “p” flag (e.g. -cp) allows the user to specify an alternate path in which to copy the model. Without this flag, the location defaults to the .tcf’s location. For example, specifying the following, will place a copy of the model into a folder C:\put_model_here: 
REM <tt>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cp "C:\put_model_here" "C:\TUFLOW\runs\M01_5m_001.tcf"</tt> 
;* “ncf” (no check files) 
: The addition of the “ncf” flag (e.g. -cncf) copies the essential input files and excludes all check files. 

Note that these optional flags can be added in any combination to the base '''-c''' switch (e.g.
-c, -ca, -cp, -cncf, -cap, -cancf, -cpncf, -capncf). 

Specifying '''-c''' on the TUFLOW command line creates a folder “<.tcf filename>_copy” (or “<.tcf filename>_copy_all” if the “a” flag is added) in the same location as the .tcf file. Under the folder, input files are copied (including the full folder structure), and any check files and output folders created. For example, specifying: 
: <tt>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -c “C:\tuflow_models\my model.tcf”</tt> will make a copy of the TUFLOW model based on the file <tt>“my model.tcf”</tt> in a folder <tt>"my model.tcf_copy"</tt>, or <tt>"my model.tcf_copy_all"</tt> if using the “a” flag. 

'''Note:'''
<ol>
<li> Use the full path to the .tcf file (this is the default if running from UltraEdit or using the right click approach).
<li>Make sure there is sufficient disk space (no checks for sufficient disk space are made).
<li>Output folders and some output files are created but these will be empty.
<li>Any check folder(s) are created and check files written (these can be deleted if wishing to minimise the size of the folder).
<li>The full path of the input files is reproduced to provide traceability and also handle inputs from other drives and URLs. Drive letters are replaced, for example, “C:” becomes a folder “C Drive”. URLs (denoted by “\\” or “//” at the beginning of the path) are replaced by a folder called “URL\”.
<li>To run the copied .tcf file, it will be necessary to change any non-relative pathnames according to the point above. Alternatively you can share and then map, for example, the “D Drive” folder as “D:”.
<li>The Check MI Save Date will need to be set to WARNING or OFF in the .tcf file if the –ca option has not been used as the .tab and other files will not have been copied.
<li>There is a limit of 1,000 characters (including spaces) on pathnames. As very long pathnames can result due to the above approach, if the number of characters exceeds 1,000, problems may occur.
<li>The -c switch automatically invokes the -t (ie. the simulation does not commence, only the input data is tested/checked).
<li>The -b option still applies if several models wish to be copied using a batch (.bat) file.
</ol> 

An example that copies all files (-ca switch) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -ca "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example that copies all files to an alternate path (-cap) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cap "C:\Copy_of_model" "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example that copies all files to an alternate path, excluding any check files, (-capncf) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -capncf "C:\Copy_of_model" "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Package a TUFLOW model===
Package model function attempts to copy all input files for all events and scenarios defined in the model, if only single set of events and scenarios is required, -c is preferable. Unlike the -c option, -pm does not read and process the data during the file copy, as such it is substantially faster than -c. The package model function does not require access to a TUFLOW licence.

A tool in QGIS (as part of the TUFLOW Plugin) exists which provides a dialog to the package model options, which allows users to bypass the creation of a batch file: 
[[Package_Model_in_QGIS | Package Model in QGIS]]

Additional optional flags can be added to the base '''-pm''' switch, in any combination, including: 
;* “All”; 
: The addition of the “All” flag (e.g. -pmAll) copies all file extensions (e.g. 1d_nwk_culv_L.mif, will become 1d_nwk_culv_L.*). 
;* “L” (list); and 
: The addition of the “L” flag (e.g. -pmL) list the files to be copied into an output file, but don’t copy. 
;* “ini” (file.ini) 
: The addition of the “ini” flag (e.g. -pmini) provides a .ini file with user defined options. A .ini file can be used to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames. Valid options should be separated by a vertical bar. 

Combinations of the above are also valid, with the order of the optional switches not being important (-pmAllL would be treated the same as -pmLAll). 
When using package model the default destination folder is created in the same directory as the .tcf file, with the prefix “pm_”. For example, C:\Projects\Modelling\TUFLOW\runs\Run_001.tcf will create a package in the folder “C:\Projects\Modelling\TUFLOW\runs\pm_Run_001\. 

Three options are also available for handling of the binary processed files created by TUFLOW to speed up the simulation start. These options are: 
;* “-xf0”; 
: Do not copy .xf files, only the original inputs are copied. 
;* “-xf1”; and 
: Copy both raw input files and .xf files. 
;* “-xf2” 
: Copy only .xf files, if xf files exist for an input only the xf will be copied. 
 
An example of package model that copies all files is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAll "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of package model that copies all files except .xf files, (-pmAll -xf0) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAll -xf0 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of package model that copies all files with specified .ini file (-pmAllini) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAllini package.ini "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of .ini file to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames: 
<pre>
Base Folder == <folder>
Copy Destination == <folder>
Model Scenario ~s<number>~ == <scenario A> | <scenario B> | …
Model Event ~e<number>~ == <event A> | <event B> | …
</pre>

===GPU Module Control===
The -pu switch can be used to select which GPU card or cards to direct the simulation towards. –pu must be specified once for each device. For example, to direct the simulation to GPU devices 0 and 2, specify -pu0 -pu2. (Note: the GPU device numbering starts a 0, not 1). For example:
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pu0 -pu2 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Event and Scenario Management===
The -e and -s switches can be used to manage multiple events and scenarios from a single tuflow control file. The -e and -s wildcard is replaced by the following entry specified in the batch file. For example, the following batch file commands will run two simulations in series:
* M01_Q050_24hr_2m_Dev_001.tcf; and
* M01_Q100_24hr_2m_Dev_001.tcf;

<pre>Start "TUFLOW" /wait "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 Q050 -e2 24hr -s1 2m -s2 Dev "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_~e1~_~e2~_~s1~_s2~_001.tcf"
Start "TUFLOW" /wait "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 Q100 -e2 24hr -s1 2m -s2 Dev "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_~e1~_~e2~_~s1~_s2~_001.tcf"</pre>

Please be aware that the % symbol is a special character in a batch file. If the % symbol is used within a wildcard, it will not be read when searching for that wildcard in TUFLOW. 
For example if the following event wildcard is used; 
*-e 10% 
TUFLOW will search for '10' instead of '10%' as the event wildcard. 
 
It is recommended that modellers avoid the use of a % symbol in any wildcard values. The string 'pct' is a great alternative for the % symbol. 
For example, using: 
*-e 10pct 
Alternatively, using the % symbol twice in a row as shown below should result in a desired wildcard value. 
*-e 10%% (TUFLOW will search for 10%)

===Set Hardware===
The -hwgpu or -hwcpu switches can be used overwrite any "Hardware ==' command specified in the .tcf to GPU or CPU, respectively. This feature was first introduced for Build 2023-03-AB and is not available for TUFLOW builds prior to this.

These switches can be used in conjunction with the -nt (number of threads) or -pu (processing unit id) to provide full control over the hardware usage via the command line.

The following command could be used to run a model with CPU hardware on 8 threads:
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -hwcpu -nt8 FS_Hardware_01.tcf </pre>

The following command could be used to run a model on GPU hardware using 2 devices (GPU 0 and GPU1):
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -hwgpu -pu0 -pu1 FS_Hardware_01.tcf </pre>

===Set Start Time for a Simulation===
The use of the -st<time_in_hours> (start time) switch allows the user to specify the start time for a simulation. Any start time specified via this run option argument is given the highest priority and overrides the "Start Time ==" settings in the .tcf, event files (.tef) and override files. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -st0 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Set End Time for a Simulation===
The use of the -et<time_in_hours> (end time) switch allows the user to specify the end time for a simulation. Any end time specified via this run option argument is given the highest priority and overrides the "End Time ==" settings in the .tcf, event files (.tef) and override files. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -et3 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Suppress Message Box Prompts===
The use of the -nmb (no message boxes) switch suppresses the use of Windows message boxes to prompt the user. All prompts will be via the console window. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nmb "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Search for a Network License===
The use of the -nwk (network) switch forces TUFLOW to search for a network licence. I.e. Skip the search for a local license. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nwk "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Search for a WIBU License===
The use of the -wibu (WIBU license) switch forces TUFLOW to search only for a WIBU Codemeter license. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -wibu "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Specify the Output Drive===
The -od<drive> (output drive) switch allows the user to specify the Output Drive for a simulation. 
For example, the following will redirect all outputs to the C:\ drive: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -odC "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Specify Map Output===
The -oz<name> (output zone) switch specifies that the map output includes the input zone. 
For example, the following would include output for 'Zone A': 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -ozZoneA "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Query the Creation of a Folder===
The -qcf (query the creation of a folder) switch is useful if you would prefer to have the create folder query dialog appear (rather than TUFLOW automatically creating folders - see [[Run_TUFLOW_From_a_Batch-file#Automatically_Create_Folders_in_a_TUFLOW_model | -acf]]). 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -qcf "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Execute a Simulation (the Default)===
The -x (execute) switch executes the simulation. This switch is used by default and does not need to be included on the TUFLOW command line.

===Copy or Test Model License Free===
For Build 2018-03-AA or later, it is possible to use the [[Run_TUFLOW_From_a_Batch-file#Copy_a_TUFLOW_model | copy model]] (-c option) or [[Run_TUFLOW_From_a_Batch-file#Testing_a_simulation | test model]] (-t option) without using a license. To utilise this licence free copy/test, the -nlc (no license check) input argument must be specified. If running without a TUFLOW licence, no diagnostic output is generated (e.g. messages layer). If these are required, the -nlc option must be removed.

===Simulation Log Path (Legacy)===
The -slp (simulation log path) switch is a legacy option for Solftlock (blue) dongles to set the path to a folder on the intranet to log all simulation initiated from the lock. Refer to the [https://www.tuflow.com/downloads/ TUFLOW Manual] (2018 or earlier) for details. 

==Advanced Batch Files==
The below section shows example batch files for maximizing run efficiency,
===Creating a delay===
====Windows 7 and newer====
For a Windows 7 and newer operating system a delay of a set duration can be created with the Timeout <seconds> command. For example: 
<pre>Timeout 10</pre>
Will create a 10 second delay, a countdown timer is given. Press any key to continue.

====Other Systems====
It is possible to create a delay of specified length in a batch file. The best way do this is actually to create a second batch file! To do this create a text file and call it '''wait.bat'''. Within that file enter the following text:
<pre>@ping 127.0.0.1 -n 2 -w 1000 > nul
@ping 127.0.0.1 -n %1% -w 1000> nul</pre>
To create the pause we ping an address for a set time and disregard the output. Once the wait.bat has been created, it can be called from another batchfile using the following syntax:
<pre>call wait <time in seconds.</pre>
In the example below, the first simulation is started and then 60 seconds later (using the wait.bat file) the second simulation is started. Note there is no /wait flag specified, if there was the batchfile would wait for 60 seconds after the first simulation had finished before starting the second simulation.
<pre>Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
call wait 60
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>
For this to work the wait.bat file needs to be in the same folder as the batchfile calling it. You can put the file in a specific location and add this path as an environment variable. If this is done "call wait <time in seconds> can be added to any batch file. 
To set the environment variable, you will need to have administrator access to the machine, and add a colon (;) and then the batchfile location (e.g. "C:\batch_files\" , without the quotes) in the '''path''' system variables. The separator character is a colon (;) this is added to specify a new path. For more details on modifying the environment please see here: [https://support.microsoft.com/kb/310519 https://support.microsoft.com/kb/310519].

===Variables===
Batch files can be easily setup so that they are more generic and easily customised when moving from one project to another. For example, in the below a variable, TUFLOWEXE, is used to define the path to the TUFLOW exe to be used, and a variable RUN is used to incorporate options such as the /wait so that the simulations run in series (one after the other).

<pre>set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
set RUN=start "TUFLOW" /wait %TUFLOWEXE% -b
%RUN% MR_H99_C25_Q100.tcf
%RUN% MR_H99_C25_Q050.tcf
%RUN% MR_H99_C25_Q020.tcf</pre>
The advantage of using variables is if the path to the TUFLOW exe changes, or to run a different version of TUFLOW, it is just a simple change in the .bat file. In the above, note the use of quotes the %TUFLOWEXE% – quotes are needed around file pathnames whenever they contain a space.

===Looping in a batch file===
If you have a large number of events to run using the event files a for loop can be used in a batch file. In this example we have 5 event magnitudes (-e1 input) and 5 event durations (-e2 input). The following batch file can be used to run all 25 simulations one after the other:
<pre>
@echo off

REM This sets the variables as local, so you can use another batch file with A and B variables
SetLocal

REM set up variables
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min

REM Loop Through
FOR %%a in (%A%) do (
FOR %%b in (%B%) DO (
start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf
)
)
pause
</pre>
In order to test the syntax, you can test the batch file by replacing the following line: 
<tt>start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt> 
With the following line: 
<tt>echo start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt> 
By using the echo in the command line, rather than starting the simulations the command line will be displayed in the DOS output. In the example above the DOS output is shown in the image below.
[[File:DOS nested batch output.png|frame|none]]

Alternatively this can be achieved using the following syntax, which is essentially the same but has the for loops compressed to a single line:
<pre>
@echo off
setlocal
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min

FOR %%a in (%A%) do FOR %%b in (%B%) do start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename_~e1~_~e2~.tcf
pause
</pre>
This can be extended to more variables for example:
<pre>
@echo off
setlocal
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min
set C=Exg Dev Mit

FOR %%a in (%A%) do (
FOR %%b in (%B%) do (
FOR %%c in (%C%) do (
start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b -s1 %%c filename_~e1~_~e2~_~s1~.tcf
)
)
)
pause
</pre>

===Looping in a batch file up to a certain number of runs===
The below example shows a method for controlling the number of concurrent simulations. 

As a brief description of the below, the "do_while_loop_start" counts the number of processes in the task manager which have "TUFLOW" in the name. If this is greater than or equal to the variable "CPU_Cores" then the batch file waits for 60 seconds.

<pre>
@ echo off

Set A=Q001 Q002 Q005 Q010 Q020 Q050 Q100
Set B=Exg Dev
set /a CPU_Cores=3

FOR %%a in (%A%) DO (
FOR %%b in (%B%) DO (
call :do_while_loop_start
Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
)
)

Pause

:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
if %count% geq %CPU_Cores% (
PING 1.1.1.1 -n 1 -w 60000 >NUL
goto do_while_loop_start
)
</pre>

Another way to achieve the same result using IF logic is shown below. This batch file will loop through the series of 14 simulations in groups of three. The batch file will pause until the last of the three active model simulations are complete. When complete, the next series of three simulations will be started in parallel.

<pre>
@ echo off
setlocal enabledelayedexpansion

SET A=Q001 Q002 Q005 Q010 Q020 Q050 Q100
SET B=Exg Dev
SET P=3

SET /A Counter=0
FOR %%a in (%A%) DO (
FOR %%b in (%B%) DO (
SET /A Counter+=1
IF /i !Counter!==!P! (
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
SET /A Counter=0
) ELSE (
Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
)
)
)
</pre>

===Looping in a batch file using scenario logic===
Sometimes when using different scenarios, it is useful to run a specific set of events for one scenario but other events for a different scenario. 
This can be automated within looped batch files using a bit of logic. 
In the the example below there is model with defended and undefended scenarios. The defended scenario needs to be run for the 20, 100 and 200 year events but the undefended scenario is only run for the 100 year event. All models are run for the hr and 3hr critical durations. 
The below batch file also uses the looping up to a certain number of runs, as seen in the point above. 
To customize this script, alter the location of the TUFLOW executable, the name of tcf and the scenarios that you would like to run (Refer to 'Set A==', 'Set C==' and 'Set B=='). 
<pre>
@ echo off
setlocal enabledelayedexpansion

REM ______________SET RUN VARIABLES_____________
set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
set RUN=start "TUFLOW" /low %TUFLOWEXE% -b
set /a CPU_Cores=5

set tcf=M01_5m_~s1~_~e1~_~e2~_001.tcf

Set A=UDEF DEF
REM set B in loop beow
Set C==01hr 03hr

REM ______________SET LOOPS____________________
FOR %%a in (%A%) do (

REM _____DEFINE RUN LOGIC______
IF "%%a"=="UDEF" (
set B=100yr
)
IF "%%a"=="DEF" (
set B=020yr 100yr 200yr
)

REM ______________RUN LOOPS____________________
FOR %%b in (!B!) do (
FOR %%c in (%C%) do (
call :do_while_loop_start
%RUN% -s1 %%a -e1 %%b -e2 %%c %tcf%
timeout 60

)
)
)

REM ___________COUNT RUN INSTANCES______________
:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
if %count% geq %CPU_Cores% (
PING 1.1.1.1 -n 1 -w 60000 >NUL
goto do_while_loop_start
)

endlocal
</pre>

===Copy model, checks and results in a looped batch file===
This batch file uses the copy model function to copy the model (inputs and check files), of both scenarios 5m and 2.5m, to a specified folder location. After copying, [https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/robocopy robocopy] is used to copy the results, based off the tcf filename and specified scenarios, to the destination result folder.
<pre>
@echo off

set TUFLOWEXE_iSP=C:\Releases\2023-03-AF\TUFLOW_iSP_w64.exe
set RUN_iSP=start "TUFLOW" /wait "%TUFLOWEXE_iSP%" -cp "D:\tuflow_models\copy"

set A=5m 2.5m
set source_results=..\results
set destination_results=C:\tuflow_models\copy\results

FOR %%a in (%A%) do (
:: Copy model
%RUN_iSP% -s1 %%a M01_~s1~_001.tcf

:: Copy results folder to copy model location
robocopy "%source_results%" "%destination_results%" "M01_%%a_001*" /S

)
pause
</pre>

===Coordinating Asynchronous Simulations===
This batch file will set off asynchronous runs on separate threads, and then wait for all runs to finish before moving to the next process. This example kicks off 8 tuflow.exe processes and then waits before collating (in fortran) and processing the results (in python). Both “combine_therad_outputs.exe” and “Post_process.py” are dummy programs only (with dummy arguments), and are included just to demonstrate how any sort of post processing might be called after the synchronisation of all TUFLOW simulations.

<pre>
@echo off

:: Set local
setlocal
:: User defined variables – will need to be changed
set "for_infile=inputs_fortran.inp"
set "run_exe="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe""
set "file_prefix=C:\temp\test"
set "sum_exe=combine_thread_outputs.exe"
set "n_threads=8"
set "pyt_code=Post_process.py"
set "pyt_infile=inputs_python.inp"

:: Random lock file
set "lock=%temp%\wait%random%.lock"

:: Launch processes asynchronously, with stream 9 redirected to a lock file.
:: The lock file will remain locked until the individual exe instance ends.
:: %%a is sent to %run_exe% as an argument to set the thread to use
for /L %%a in (0,1,7) do (
start "" 9>"%lock%%%a" %run_exe% %for_infile% %%a
)

:: Wait for the processes to finish
:Waitrun
1>nul 2>nul ping /n %n_threads% ::1
for /L %%N in (0,1,7) do (
(call ) 9>"%lock%%%N" || goto :Waitrun
) 2>nul

:: Delete the lock files
del "%lock%*"

:: Collate thread outputs
%sum_exe% %file_prefix% %n_threads%

:: Make image
python %pyt_code% %pyt_infile%

:: Finish up
echo Done.
</pre>

===Shutdown on Completion===
Often we may have a number of TUFLOW simulations going when we leave work on a Friday afternoon, if these are not going to take all weekend to run, using some of the batch file logic above you can create a batch file that will shutdown the computer when no TUFLOW simulations are running. An example batch file for this purpose is below: 
<pre>
echo off

:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
IF %count%==0 (
shutdown.exe /s /t 30
) ELSE (
timeout 60
goto do_while_loop_start
)
pause
</pre>
This batch file counts the number of processes with "TUFLOW" in the process name and if this is greater than 0, a delay of 60 seconds is created and the loop started again. If no "TUFLOW" simulations are running a shutdown command is issued. 
To test the batch file it is recommended that you add an "echo" in front of the <tt>shutdown.exe /s /t 30</tt> command to ensure it is working correctly (I use this on a Windows 7 machine, but have not tested it on either XP or Windows 8). 
In order to restart the machine rather than power it off the /s can be replaced with /r. This can be useful when a heavily utilised modelling computer needs a restart!
</ol>

Run TUFLOW From a Batch-file

2025-03-07T05:12:00Z

ElizaCollison: /* Looping in a batch file using scenario logic */

TUFLOW simulations can also be started from a batch file. Batch files are text files which contain a series of commands. Batch files allow a large degree of flexibility in starting TUFLOW simulations, advanced batch files can be used to:

* Run multiple simulations
* Set CPU priority for TUFLOW simulations
* Create a wait (e.g. start a simulation in 1 hour)
* Test simulation input
* Copy a TUFLOW model
* Package a TUFLOW model
* Post process results after simulation has finished.
Batch files are executed by double clicking the created .bat file from Windows Explorer.
<ol>
==Simple batch file==
To use a batch file, create a new text file in the TUFLOW\runs directory. The name is arbitrary but the file must have the extension ".bat". For example the file name could be '''_run_TUFLOW.bat'''.

Open this file in a text editor and add the following line.

<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
This is the simplest command line for starting TUFLOW, the line above contains only two arguments, the first is the path to the TUFLOW executable and the second argument "M01_5m_001.tcf" is the simulation file name. Depending on the location of the executable the above command line will need to be modified. The quotations around the TUFLOW executable and the .tcf file name are only required if there are spaces in the file names. However, it is recommended to include these to avoid problems.

==Batch File Switches==
These switches are available in all batch files, they are not specific to TUFLOW.

===Pause===
A second line with the text "pause" can be added, this will prompt the user to press a key at the end of the batch file. This is useful if the DOS window disappears from the screen, before you can read the output. The pause command will keep the window open.
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"
pause</pre>

===Starting process in new window===
In order to run multiple simulations at the same time, each simulation needs be started in a new console window. To do this begin the batch file line with the "Start" command, a for the window is then added. For example, to start the simulation above in a new window titled "TUFLOW" the following would be used.

<pre>Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
===Wait===
If multiple simulations are to be run, it is often desirable to run these in series, i.e. the second simulation starts after the first has finished. a /wait switch can be added which makes the batch file wait until the process is finished before moving onto the next command. 
An example of this is: 
<pre>Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>
Without the wait command, both simulations would start at the same time. 
'''Note:''' Unless there is a third simulation in the batch file the /wait command in the second line is not required, this prevents the batchfile from moving onto the third line.
===Setting a priority===
The priority of a process (such a TUFLOW simulation) can be specified within a batch file. This can be useful for a number of reasons:
*Lowering the priority of a simulation to allow you to continue working;
*Setting a high priority for critical runs; or
*Making sure you runs are high priority on a shared computing resource!

The following are valid priority switches (in increasing order of priority):
*/LOW
*/BELOWNORMAL
*/NORMAL
*/ABOVENORMAL
*/HIGH
*/REALTIME

An example of a low priority simulation is: 
<pre>start "TUFLOW" /low "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
'''TIP:''' The priority of a TUFLOW simulation can be changed at a later stage by using the '''Windows Task Manager''', navigate to the '''Processes''' tab and right click on the TUFLOW process (e.g. TUFLOW_iSP_w64.exe) and select the set priority option.

===Minimising the console window===
Using the /min switch will keep the console window for TUFLOW models minimised, so it doesn't pop up to the front every time when the next model starts.
<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>

==No Console Option==
Using the -nc switch will run a simulation without opening a DOS console window. This option is desirable for people running simulation on the cloud. Note, if an invalid .tcf file is specified, the simulation stops and returns an error level of 1 to the operating system.

<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_5m_001.tcf
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_2.5m_001.tcf</pre>

== TUFLOW switches in a batch file==
These switches are specific to TUFLOW simulations.
===Testing a simulation===
The -t (test) switch is very useful for testing the data input without running the simulation. It is good practice to use this switch before carrying out the simulations, as this will tell you whether there are any data input problems. The -t switch runs TUFLOW to just before it starts the hydrodynamic computations.
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -t "M01_5m_001.tcf"</pre>

===Batch mode in TUFLOW===
The use of the –b (batch) switch which suppresses the need to press the return key at the end of a simulation. This ensures that one simulation proceeds on to the next without any need for user input. This is required for running multiple simulations in series (one after the other).
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b "M01_5m_001.tcf"</pre>

===Automatically Create Folders in a TUFLOW model===
The use of the -acf (automatically create folders) switch prevents the dialog prompt from appearing when encountering non-existent folders (ie. results folders), and creates these folders automatically. If for any reason the folder can't be created, a dialog will appear. This feature was first introduced for Build 2012-05-AE and is not available for TUFLOW builds prior to this. For models simulated with Build 2013-12-AA or later, non-existent folders are now automatically created. If you would prefer to have the create folder query dialog to appear, you can specify the –qcf run time option (stands for query create folders). 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -acf "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Suppress Queries in a TUFLOW model===
The use of the -nq (no queries) switch prevents the termination query dialog from displaying when Ctrl+C is pressed to terminate a simulation cleanly. If –nq is specified and Ctrl-C is pressed, the simulation terminates cleanly without a query dialog to check you are certain, so be careful! This feature was first introduced for Build 2012-05-AE and is not available for TUFLOW builds prior to this. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nq "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Copy a TUFLOW model===
TUFLOW can be run in copy mode, which can be useful for transferring a model to another site or for making an archive of the input data. 

To copy a TUFLOW model, the '''-c''' switch must be included on the TUFLOW command line, as a minimum. The '''-c''' switch copies only the files read by TUFLOW. As such, for MapInfo users, the .mif and .mid files read by TUFLOW will be copied. The remaining MapInfo format files (.tab, .id, .dat and .map) are not read by TUFLOW and will not be copied. By default, the '''-c''' switch copies all TUFLOW inputs for the simulation into a subdirectory where the .tcf is located (generally TUFLOW\runs\). 

Additional optional flags can be added to the base '''-c''' switch, in any combination, including: 
;* “a” (all); 
: The addition of the “a” flag (e.g. -ca) copies all files of the same name for all input files (ie. same name, but different extensions). This option is particularly useful if the .tab and other associated files of a GIS layer need to be archived or delivered. 
;*“L” (list); 
: The addition of the “L” flag will output the files used by TUFLOW into a .tcl (TUFLOW Copy List) file but not copy the files to a destination folder. This can be useful if scripting the copying of models. To run the copy list the character “L” needs to be specified after the -c input argument. This works for all copy options, for example, the following are all valid; -cL, -caL, -capL. The .tcl file produced is output in the same directory as the .tcf and takes the simulation name.
;* “p” (path); and 
: The addition of the “p” flag (e.g. -cp) allows the user to specify an alternate path in which to copy the model. Without this flag, the location defaults to the .tcf’s location. For example, specifying the following, will place a copy of the model into a folder C:\put_model_here: 
REM <tt>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cp "C:\put_model_here" "C:\TUFLOW\runs\M01_5m_001.tcf"</tt> 
;* “ncf” (no check files) 
: The addition of the “ncf” flag (e.g. -cncf) copies the essential input files and excludes all check files. 

Note that these optional flags can be added in any combination to the base '''-c''' switch (e.g.
-c, -ca, -cp, -cncf, -cap, -cancf, -cpncf, -capncf). 

Specifying '''-c''' on the TUFLOW command line creates a folder “<.tcf filename>_copy” (or “<.tcf filename>_copy_all” if the “a” flag is added) in the same location as the .tcf file. Under the folder, input files are copied (including the full folder structure), and any check files and output folders created. For example, specifying: 
: <tt>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -c “C:\tuflow_models\my model.tcf”</tt> will make a copy of the TUFLOW model based on the file <tt>“my model.tcf”</tt> in a folder <tt>"my model.tcf_copy"</tt>, or <tt>"my model.tcf_copy_all"</tt> if using the “a” flag. 

'''Note:'''
<ol>
<li> Use the full path to the .tcf file (this is the default if running from UltraEdit or using the right click approach).
<li>Make sure there is sufficient disk space (no checks for sufficient disk space are made).
<li>Output folders and some output files are created but these will be empty.
<li>Any check folder(s) are created and check files written (these can be deleted if wishing to minimise the size of the folder).
<li>The full path of the input files is reproduced to provide traceability and also handle inputs from other drives and URLs. Drive letters are replaced, for example, “C:” becomes a folder “C Drive”. URLs (denoted by “\\” or “//” at the beginning of the path) are replaced by a folder called “URL\”.
<li>To run the copied .tcf file, it will be necessary to change any non-relative pathnames according to the point above. Alternatively you can share and then map, for example, the “D Drive” folder as “D:”.
<li>The Check MI Save Date will need to be set to WARNING or OFF in the .tcf file if the –ca option has not been used as the .tab and other files will not have been copied.
<li>There is a limit of 1,000 characters (including spaces) on pathnames. As very long pathnames can result due to the above approach, if the number of characters exceeds 1,000, problems may occur.
<li>The -c switch automatically invokes the -t (ie. the simulation does not commence, only the input data is tested/checked).
<li>The -b option still applies if several models wish to be copied using a batch (.bat) file.
</ol> 

An example that copies all files (-ca switch) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -ca "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example that copies all files to an alternate path (-cap) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cap "C:\Copy_of_model" "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example that copies all files to an alternate path, excluding any check files, (-capncf) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -capncf "C:\Copy_of_model" "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Package a TUFLOW model===
Package model function attempts to copy all input files for all events and scenarios defined in the model, if only single set of events and scenarios is required, -c is preferable. Unlike the -c option, -pm does not read and process the data during the file copy, as such it is substantially faster than -c. The package model function does not require access to a TUFLOW licence.

A tool in QGIS (as part of the TUFLOW Plugin) exists which provides a dialog to the package model options, which allows users to bypass the creation of a batch file: 
[[Package_Model_in_QGIS | Package Model in QGIS]]

Additional optional flags can be added to the base '''-pm''' switch, in any combination, including: 
;* “All”; 
: The addition of the “All” flag (e.g. -pmAll) copies all file extensions (e.g. 1d_nwk_culv_L.mif, will become 1d_nwk_culv_L.*). 
;* “L” (list); and 
: The addition of the “L” flag (e.g. -pmL) list the files to be copied into an output file, but don’t copy. 
;* “ini” (file.ini) 
: The addition of the “ini” flag (e.g. -pmini) provides a .ini file with user defined options. A .ini file can be used to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames. Valid options should be separated by a vertical bar. 

Combinations of the above are also valid, with the order of the optional switches not being important (-pmAllL would be treated the same as -pmLAll). 
When using package model the default destination folder is created in the same directory as the .tcf file, with the prefix “pm_”. For example, C:\Projects\Modelling\TUFLOW\runs\Run_001.tcf will create a package in the folder “C:\Projects\Modelling\TUFLOW\runs\pm_Run_001\. 

Three options are also available for handling of the binary processed files created by TUFLOW to speed up the simulation start. These options are: 
;* “-xf0”; 
: Do not copy .xf files, only the original inputs are copied. 
;* “-xf1”; and 
: Copy both raw input files and .xf files. 
;* “-xf2” 
: Copy only .xf files, if xf files exist for an input only the xf will be copied. 
 
An example of package model that copies all files is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAll "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of package model that copies all files except .xf files, (-pmAll -xf0) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAll -xf0 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of package model that copies all files with specified .ini file (-pmAllini) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAllini package.ini "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of .ini file to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames: 
<pre>
Base Folder == <folder>
Copy Destination == <folder>
Model Scenario ~s<number>~ == <scenario A> | <scenario B> | …
Model Event ~e<number>~ == <event A> | <event B> | …
</pre>

===GPU Module Control===
The -pu switch can be used to select which GPU card or cards to direct the simulation towards. –pu must be specified once for each device. For example, to direct the simulation to GPU devices 0 and 2, specify -pu0 -pu2. (Note: the GPU device numbering starts a 0, not 1). For example:
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pu0 -pu2 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Event and Scenario Management===
The -e and -s switches can be used to manage multiple events and scenarios from a single tuflow control file. The -e and -s wildcard is replaced by the following entry specified in the batch file. For example, the following batch file commands will run two simulations in series:
* M01_Q050_24hr_2m_Dev_001.tcf; and
* M01_Q100_24hr_2m_Dev_001.tcf;

<pre>Start "TUFLOW" /wait "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 Q050 -e2 24hr -s1 2m -s2 Dev "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_~e1~_~e2~_~s1~_s2~_001.tcf"
Start "TUFLOW" /wait "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 Q100 -e2 24hr -s1 2m -s2 Dev "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_~e1~_~e2~_~s1~_s2~_001.tcf"</pre>

Please be aware that the % symbol is a special character in a batch file. If the % symbol is used within a wildcard, it will not be read when searching for that wildcard in TUFLOW. 
For example if the following event wildcard is used; 
*-e 10% 
TUFLOW will search for '10' instead of '10%' as the event wildcard. 
 
It is recommended that modellers avoid the use of a % symbol in any wildcard values. The string 'pct' is a great alternative for the % symbol. 
For example, using: 
*-e 10pct 
Alternatively, using the % symbol twice in a row as shown below should result in a desired wildcard value. 
*-e 10%% (TUFLOW will search for 10%)

===Set Hardware===
The -hwgpu or -hwcpu switches can be used overwrite any "Hardware ==' command specified in the .tcf to GPU or CPU, respectively. This feature was first introduced for Build 2023-03-AB and is not available for TUFLOW builds prior to this.

These switches can be used in conjunction with the -nt (number of threads) or -pu (processing unit id) to provide full control over the hardware usage via the command line.

The following command could be used to run a model with CPU hardware on 8 threads:
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -hwcpu -nt8 FS_Hardware_01.tcf </pre>

The following command could be used to run a model on GPU hardware using 2 devices (GPU 0 and GPU1):
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -hwgpu -pu0 -pu1 FS_Hardware_01.tcf </pre>

===Set Start Time for a Simulation===
The use of the -st<time_in_hours> (start time) switch allows the user to specify the start time for a simulation. Any start time specified via this run option argument is given the highest priority and overrides the "Start Time ==" settings in the .tcf, event files (.tef) and override files. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -st0 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Set End Time for a Simulation===
The use of the -et<time_in_hours> (end time) switch allows the user to specify the end time for a simulation. Any end time specified via this run option argument is given the highest priority and overrides the "End Time ==" settings in the .tcf, event files (.tef) and override files. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -et3 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Suppress Message Box Prompts===
The use of the -nmb (no message boxes) switch suppresses the use of Windows message boxes to prompt the user. All prompts will be via the console window. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nmb "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Search for a Network License===
The use of the -nwk (network) switch forces TUFLOW to search for a network licence. I.e. Skip the search for a local license. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nwk "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Search for a WIBU License===
The use of the -wibu (WIBU license) switch forces TUFLOW to search only for a WIBU Codemeter license. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -wibu "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Specify the Output Drive===
The -od<drive> (output drive) switch allows the user to specify the Output Drive for a simulation. 
For example, the following will redirect all outputs to the C:\ drive: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -odC "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Specify Map Output===
The -oz<name> (output zone) switch specifies that the map output includes the input zone. 
For example, the following would include output for 'Zone A': 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -ozZoneA "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Query the Creation of a Folder===
The -qcf (query the creation of a folder) switch is useful if you would prefer to have the create folder query dialog appear (rather than TUFLOW automatically creating folders - see [[Run_TUFLOW_From_a_Batch-file#Automatically_Create_Folders_in_a_TUFLOW_model | -acf]]). 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -qcf "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Execute a Simulation (the Default)===
The -x (execute) switch executes the simulation. This switch is used by default and does not need to be included on the TUFLOW command line.

===Copy or Test Model License Free===
For Build 2018-03-AA or later, it is possible to use the [[Run_TUFLOW_From_a_Batch-file#Copy_a_TUFLOW_model | copy model]] (-c option) or [[Run_TUFLOW_From_a_Batch-file#Testing_a_simulation | test model]] (-t option) without using a license. To utilise this licence free copy/test, the -nlc (no license check) input argument must be specified. If running without a TUFLOW licence, no diagnostic output is generated (e.g. messages layer). If these are required, the -nlc option must be removed.

===Simulation Log Path (Legacy)===
The -slp (simulation log path) switch is a legacy option for Solftlock (blue) dongles to set the path to a folder on the intranet to log all simulation initiated from the lock. Refer to the [https://www.tuflow.com/downloads/ TUFLOW Manual] (2018 or earlier) for details. 

==Advanced Batch Files==
The below section shows example batch files for maximizing run efficiency,
===Creating a delay===
====Windows 7 and newer====
For a Windows 7 and newer operating system a delay of a set duration can be created with the Timeout <seconds> command. For example: 
<pre>Timeout 10</pre>
Will create a 10 second delay, a countdown timer is given. Press any key to continue.

====Other Systems====
It is possible to create a delay of specified length in a batch file. The best way do this is actually to create a second batch file! To do this create a text file and call it '''wait.bat'''. Within that file enter the following text:
<pre>@ping 127.0.0.1 -n 2 -w 1000 > nul
@ping 127.0.0.1 -n %1% -w 1000> nul</pre>
To create the pause we ping an address for a set time and disregard the output. Once the wait.bat has been created, it can be called from another batchfile using the following syntax:
<pre>call wait <time in seconds.</pre>
In the example below, the first simulation is started and then 60 seconds later (using the wait.bat file) the second simulation is started. Note there is no /wait flag specified, if there was the batchfile would wait for 60 seconds after the first simulation had finished before starting the second simulation.
<pre>Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
call wait 60
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>
For this to work the wait.bat file needs to be in the same folder as the batchfile calling it. You can put the file in a specific location and add this path as an environment variable. If this is done "call wait <time in seconds> can be added to any batch file. 
To set the environment variable, you will need to have administrator access to the machine, and add a colon (;) and then the batchfile location (e.g. "C:\batch_files\" , without the quotes) in the '''path''' system variables. The separator character is a colon (;) this is added to specify a new path. For more details on modifying the environment please see here: [https://support.microsoft.com/kb/310519 https://support.microsoft.com/kb/310519].

===Variables===
Batch files can be easily setup so that they are more generic and easily customised when moving from one project to another. For example, in the below a variable, TUFLOWEXE, is used to define the path to the TUFLOW exe to be used, and a variable RUN is used to incorporate options such as the /wait so that the simulations run in series (one after the other).

<pre>set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
set RUN=start "TUFLOW" /wait %TUFLOWEXE% -b
%RUN% MR_H99_C25_Q100.tcf
%RUN% MR_H99_C25_Q050.tcf
%RUN% MR_H99_C25_Q020.tcf</pre>
The advantage of using variables is if the path to the TUFLOW exe changes, or to run a different version of TUFLOW, it is just a simple change in the .bat file. In the above, note the use of quotes around %TUFLOWEXE% in the definition for the RUN variable – quotes are needed around file pathnames whenever they contain a space.

===Looping in a batch file===
If you have a large number of events to run using the event files a for loop can be used in a batch file. In this example we have 5 event magnitudes (-e1 input) and 5 event durations (-e2 input). The following batch file can be used to run all 25 simulations one after the other:
<pre>
@echo off

REM This sets the variables as local, so you can use another batch file with A and B variables
SetLocal

REM set up variables
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min

REM Loop Through
FOR %%a in (%A%) do (
FOR %%b in (%B%) DO (
start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf
)
)
pause
</pre>
In order to test the syntax, you can test the batch file by replacing the following line: 
<tt>start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt> 
With the following line: 
<tt>echo start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt> 
By using the echo in the command line, rather than starting the simulations the command line will be displayed in the DOS output. In the example above the DOS output is shown in the image below.
[[File:DOS nested batch output.png|frame|none]]

Alternatively this can be achieved using the following syntax, which is essentially the same but has the for loops compressed to a single line:
<pre>
@echo off
setlocal
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min

FOR %%a in (%A%) do FOR %%b in (%B%) do start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename_~e1~_~e2~.tcf
pause
</pre>
This can be extended to more variables for example:
<pre>
@echo off
setlocal
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min
set C=Exg Dev Mit

FOR %%a in (%A%) do (
FOR %%b in (%B%) do (
FOR %%c in (%C%) do (
start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b -s1 %%c filename_~e1~_~e2~_~s1~.tcf
)
)
)
pause
</pre>

===Looping in a batch file up to a certain number of runs===
The below example shows a method for controlling the number of concurrent simulations. 

As a brief description of the below, the "do_while_loop_start" counts the number of processes in the task manager which have "TUFLOW" in the name. If this is greater than or equal to the variable "CPU_Cores" then the batch file waits for 60 seconds.

<pre>
@ echo off

Set A=Q001 Q002 Q005 Q010 Q020 Q050 Q100
Set B=Exg Dev
set /a CPU_Cores=3

FOR %%a in (%A%) DO (
FOR %%b in (%B%) DO (
call :do_while_loop_start
Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
)
)

Pause

:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
if %count% geq %CPU_Cores% (
PING 1.1.1.1 -n 1 -w 60000 >NUL
goto do_while_loop_start
)
</pre>

Another way to achieve the same result using IF logic is shown below. This batch file will loop through the series of 14 simulations in groups of three. The batch file will pause until the last of the three active model simulations are complete. When complete, the next series of three simulations will be started in parallel.

<pre>
@ echo off
setlocal enabledelayedexpansion

SET A=Q001 Q002 Q005 Q010 Q020 Q050 Q100
SET B=Exg Dev
SET P=3

SET /A Counter=0
FOR %%a in (%A%) DO (
FOR %%b in (%B%) DO (
SET /A Counter+=1
IF /i !Counter!==!P! (
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
SET /A Counter=0
) ELSE (
Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
)
)
)
</pre>

===Looping in a batch file using scenario logic===
Sometimes when using different scenarios, it is useful to run a specific set of events for one scenario but other events for a different scenario. 
This can be automated within looped batch files using a bit of logic. 
In the the example below there is model with defended and undefended scenarios. The defended scenario needs to be run for the 20, 100 and 200 year events but the undefended scenario is only run for the 100 year event. All models are run for the hr and 3hr critical durations. 
The below batch file also uses the looping up to a certain number of runs, as seen in the point above. 
To customize this script, alter the location of the TUFLOW executable, the name of tcf and the scenarios that you would like to run (Refer to 'Set A==', 'Set C==' and 'Set B=='). 
<pre>
@ echo off
setlocal enabledelayedexpansion

REM ______________SET RUN VARIABLES_____________
set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
set RUN=start "TUFLOW" /low %TUFLOWEXE% -b
set /a CPU_Cores=5

set tcf=M01_5m_~s1~_~e1~_~e2~_001.tcf

Set A=UDEF DEF
REM set B in loop beow
Set C==01hr 03hr

REM ______________SET LOOPS____________________
FOR %%a in (%A%) do (

REM _____DEFINE RUN LOGIC______
IF "%%a"=="UDEF" (
set B=100yr
)
IF "%%a"=="DEF" (
set B=020yr 100yr 200yr
)

REM ______________RUN LOOPS____________________
FOR %%b in (!B!) do (
FOR %%c in (%C%) do (
call :do_while_loop_start
%RUN% -s1 %%a -e1 %%b -e2 %%c %tcf%
timeout 60

)
)
)

REM ___________COUNT RUN INSTANCES______________
:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
if %count% geq %CPU_Cores% (
PING 1.1.1.1 -n 1 -w 60000 >NUL
goto do_while_loop_start
)

endlocal
</pre>

===Copy model, checks and results in a looped batch file===
This batch file uses the copy model function to copy the model (inputs and check files), of both scenarios 5m and 2.5m, to a specified folder location. After copying, [https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/robocopy robocopy] is used to copy the results, based off the tcf filename and specified scenarios, to the destination result folder.
<pre>
@echo off

set TUFLOWEXE_iSP=C:\Releases\2023-03-AF\TUFLOW_iSP_w64.exe
set RUN_iSP=start "TUFLOW" /wait "%TUFLOWEXE_iSP%" -cp "D:\tuflow_models\copy"

set A=5m 2.5m
set source_results=..\results
set destination_results=C:\tuflow_models\copy\results

FOR %%a in (%A%) do (
:: Copy model
%RUN_iSP% -s1 %%a M01_~s1~_001.tcf

:: Copy results folder to copy model location
robocopy "%source_results%" "%destination_results%" "M01_%%a_001*" /S

)
pause
</pre>

===Coordinating Asynchronous Simulations===
This batch file will set off asynchronous runs on separate threads, and then wait for all runs to finish before moving to the next process. This example kicks off 8 tuflow.exe processes and then waits before collating (in fortran) and processing the results (in python). Both “combine_therad_outputs.exe” and “Post_process.py” are dummy programs only (with dummy arguments), and are included just to demonstrate how any sort of post processing might be called after the synchronisation of all TUFLOW simulations.

<pre>
@echo off

:: Set local
setlocal
:: User defined variables – will need to be changed
set "for_infile=inputs_fortran.inp"
set "run_exe="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe""
set "file_prefix=C:\temp\test"
set "sum_exe=combine_thread_outputs.exe"
set "n_threads=8"
set "pyt_code=Post_process.py"
set "pyt_infile=inputs_python.inp"

:: Random lock file
set "lock=%temp%\wait%random%.lock"

:: Launch processes asynchronously, with stream 9 redirected to a lock file.
:: The lock file will remain locked until the individual exe instance ends.
:: %%a is sent to %run_exe% as an argument to set the thread to use
for /L %%a in (0,1,7) do (
start "" 9>"%lock%%%a" %run_exe% %for_infile% %%a
)

:: Wait for the processes to finish
:Waitrun
1>nul 2>nul ping /n %n_threads% ::1
for /L %%N in (0,1,7) do (
(call ) 9>"%lock%%%N" || goto :Waitrun
) 2>nul

:: Delete the lock files
del "%lock%*"

:: Collate thread outputs
%sum_exe% %file_prefix% %n_threads%

:: Make image
python %pyt_code% %pyt_infile%

:: Finish up
echo Done.
</pre>

===Shutdown on Completion===
Often we may have a number of TUFLOW simulations going when we leave work on a Friday afternoon, if these are not going to take all weekend to run, using some of the batch file logic above you can create a batch file that will shutdown the computer when no TUFLOW simulations are running. An example batch file for this purpose is below: 
<pre>
echo off

:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
IF %count%==0 (
shutdown.exe /s /t 30
) ELSE (
timeout 60
goto do_while_loop_start
)
pause
</pre>
This batch file counts the number of processes with "TUFLOW" in the process name and if this is greater than 0, a delay of 60 seconds is created and the loop started again. If no "TUFLOW" simulations are running a shutdown command is issued. 
To test the batch file it is recommended that you add an "echo" in front of the <tt>shutdown.exe /s /t 30</tt> command to ensure it is working correctly (I use this on a Windows 7 machine, but have not tested it on either XP or Windows 8). 
In order to restart the machine rather than power it off the /s can be replaced with /r. This can be useful when a heavily utilised modelling computer needs a restart!
</ol>

Run TUFLOW From a Batch-file

2025-03-07T05:11:40Z

ElizaCollison: /* Variables */

TUFLOW simulations can also be started from a batch file. Batch files are text files which contain a series of commands. Batch files allow a large degree of flexibility in starting TUFLOW simulations, advanced batch files can be used to:

* Run multiple simulations
* Set CPU priority for TUFLOW simulations
* Create a wait (e.g. start a simulation in 1 hour)
* Test simulation input
* Copy a TUFLOW model
* Package a TUFLOW model
* Post process results after simulation has finished.
Batch files are executed by double clicking the created .bat file from Windows Explorer.
<ol>
==Simple batch file==
To use a batch file, create a new text file in the TUFLOW\runs directory. The name is arbitrary but the file must have the extension ".bat". For example the file name could be '''_run_TUFLOW.bat'''.

Open this file in a text editor and add the following line.

<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
This is the simplest command line for starting TUFLOW, the line above contains only two arguments, the first is the path to the TUFLOW executable and the second argument "M01_5m_001.tcf" is the simulation file name. Depending on the location of the executable the above command line will need to be modified. The quotations around the TUFLOW executable and the .tcf file name are only required if there are spaces in the file names. However, it is recommended to include these to avoid problems.

==Batch File Switches==
These switches are available in all batch files, they are not specific to TUFLOW.

===Pause===
A second line with the text "pause" can be added, this will prompt the user to press a key at the end of the batch file. This is useful if the DOS window disappears from the screen, before you can read the output. The pause command will keep the window open.
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"
pause</pre>

===Starting process in new window===
In order to run multiple simulations at the same time, each simulation needs be started in a new console window. To do this begin the batch file line with the "Start" command, a for the window is then added. For example, to start the simulation above in a new window titled "TUFLOW" the following would be used.

<pre>Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
===Wait===
If multiple simulations are to be run, it is often desirable to run these in series, i.e. the second simulation starts after the first has finished. a /wait switch can be added which makes the batch file wait until the process is finished before moving onto the next command. 
An example of this is: 
<pre>Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>
Without the wait command, both simulations would start at the same time. 
'''Note:''' Unless there is a third simulation in the batch file the /wait command in the second line is not required, this prevents the batchfile from moving onto the third line.
===Setting a priority===
The priority of a process (such a TUFLOW simulation) can be specified within a batch file. This can be useful for a number of reasons:
*Lowering the priority of a simulation to allow you to continue working;
*Setting a high priority for critical runs; or
*Making sure you runs are high priority on a shared computing resource!

The following are valid priority switches (in increasing order of priority):
*/LOW
*/BELOWNORMAL
*/NORMAL
*/ABOVENORMAL
*/HIGH
*/REALTIME

An example of a low priority simulation is: 
<pre>start "TUFLOW" /low "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"</pre>
'''TIP:''' The priority of a TUFLOW simulation can be changed at a later stage by using the '''Windows Task Manager''', navigate to the '''Processes''' tab and right click on the TUFLOW process (e.g. TUFLOW_iSP_w64.exe) and select the set priority option.

===Minimising the console window===
Using the /min switch will keep the console window for TUFLOW models minimised, so it doesn't pop up to the front every time when the next model starts.
<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>

==No Console Option==
Using the -nc switch will run a simulation without opening a DOS console window. This option is desirable for people running simulation on the cloud. Note, if an invalid .tcf file is specified, the simulation stops and returns an error level of 1 to the operating system.

<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_5m_001.tcf
Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_2.5m_001.tcf</pre>

== TUFLOW switches in a batch file==
These switches are specific to TUFLOW simulations.
===Testing a simulation===
The -t (test) switch is very useful for testing the data input without running the simulation. It is good practice to use this switch before carrying out the simulations, as this will tell you whether there are any data input problems. The -t switch runs TUFLOW to just before it starts the hydrodynamic computations.
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -t "M01_5m_001.tcf"</pre>

===Batch mode in TUFLOW===
The use of the –b (batch) switch which suppresses the need to press the return key at the end of a simulation. This ensures that one simulation proceeds on to the next without any need for user input. This is required for running multiple simulations in series (one after the other).
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b "M01_5m_001.tcf"</pre>

===Automatically Create Folders in a TUFLOW model===
The use of the -acf (automatically create folders) switch prevents the dialog prompt from appearing when encountering non-existent folders (ie. results folders), and creates these folders automatically. If for any reason the folder can't be created, a dialog will appear. This feature was first introduced for Build 2012-05-AE and is not available for TUFLOW builds prior to this. For models simulated with Build 2013-12-AA or later, non-existent folders are now automatically created. If you would prefer to have the create folder query dialog to appear, you can specify the –qcf run time option (stands for query create folders). 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -acf "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Suppress Queries in a TUFLOW model===
The use of the -nq (no queries) switch prevents the termination query dialog from displaying when Ctrl+C is pressed to terminate a simulation cleanly. If –nq is specified and Ctrl-C is pressed, the simulation terminates cleanly without a query dialog to check you are certain, so be careful! This feature was first introduced for Build 2012-05-AE and is not available for TUFLOW builds prior to this. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nq "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Copy a TUFLOW model===
TUFLOW can be run in copy mode, which can be useful for transferring a model to another site or for making an archive of the input data. 

To copy a TUFLOW model, the '''-c''' switch must be included on the TUFLOW command line, as a minimum. The '''-c''' switch copies only the files read by TUFLOW. As such, for MapInfo users, the .mif and .mid files read by TUFLOW will be copied. The remaining MapInfo format files (.tab, .id, .dat and .map) are not read by TUFLOW and will not be copied. By default, the '''-c''' switch copies all TUFLOW inputs for the simulation into a subdirectory where the .tcf is located (generally TUFLOW\runs\). 

Additional optional flags can be added to the base '''-c''' switch, in any combination, including: 
;* “a” (all); 
: The addition of the “a” flag (e.g. -ca) copies all files of the same name for all input files (ie. same name, but different extensions). This option is particularly useful if the .tab and other associated files of a GIS layer need to be archived or delivered. 
;*“L” (list); 
: The addition of the “L” flag will output the files used by TUFLOW into a .tcl (TUFLOW Copy List) file but not copy the files to a destination folder. This can be useful if scripting the copying of models. To run the copy list the character “L” needs to be specified after the -c input argument. This works for all copy options, for example, the following are all valid; -cL, -caL, -capL. The .tcl file produced is output in the same directory as the .tcf and takes the simulation name.
;* “p” (path); and 
: The addition of the “p” flag (e.g. -cp) allows the user to specify an alternate path in which to copy the model. Without this flag, the location defaults to the .tcf’s location. For example, specifying the following, will place a copy of the model into a folder C:\put_model_here: 
REM <tt>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cp "C:\put_model_here" "C:\TUFLOW\runs\M01_5m_001.tcf"</tt> 
;* “ncf” (no check files) 
: The addition of the “ncf” flag (e.g. -cncf) copies the essential input files and excludes all check files. 

Note that these optional flags can be added in any combination to the base '''-c''' switch (e.g.
-c, -ca, -cp, -cncf, -cap, -cancf, -cpncf, -capncf). 

Specifying '''-c''' on the TUFLOW command line creates a folder “<.tcf filename>_copy” (or “<.tcf filename>_copy_all” if the “a” flag is added) in the same location as the .tcf file. Under the folder, input files are copied (including the full folder structure), and any check files and output folders created. For example, specifying: 
: <tt>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -c “C:\tuflow_models\my model.tcf”</tt> will make a copy of the TUFLOW model based on the file <tt>“my model.tcf”</tt> in a folder <tt>"my model.tcf_copy"</tt>, or <tt>"my model.tcf_copy_all"</tt> if using the “a” flag. 

'''Note:'''
<ol>
<li> Use the full path to the .tcf file (this is the default if running from UltraEdit or using the right click approach).
<li>Make sure there is sufficient disk space (no checks for sufficient disk space are made).
<li>Output folders and some output files are created but these will be empty.
<li>Any check folder(s) are created and check files written (these can be deleted if wishing to minimise the size of the folder).
<li>The full path of the input files is reproduced to provide traceability and also handle inputs from other drives and URLs. Drive letters are replaced, for example, “C:” becomes a folder “C Drive”. URLs (denoted by “\\” or “//” at the beginning of the path) are replaced by a folder called “URL\”.
<li>To run the copied .tcf file, it will be necessary to change any non-relative pathnames according to the point above. Alternatively you can share and then map, for example, the “D Drive” folder as “D:”.
<li>The Check MI Save Date will need to be set to WARNING or OFF in the .tcf file if the –ca option has not been used as the .tab and other files will not have been copied.
<li>There is a limit of 1,000 characters (including spaces) on pathnames. As very long pathnames can result due to the above approach, if the number of characters exceeds 1,000, problems may occur.
<li>The -c switch automatically invokes the -t (ie. the simulation does not commence, only the input data is tested/checked).
<li>The -b option still applies if several models wish to be copied using a batch (.bat) file.
</ol> 

An example that copies all files (-ca switch) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -ca "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example that copies all files to an alternate path (-cap) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cap "C:\Copy_of_model" "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example that copies all files to an alternate path, excluding any check files, (-capncf) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -capncf "C:\Copy_of_model" "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Package a TUFLOW model===
Package model function attempts to copy all input files for all events and scenarios defined in the model, if only single set of events and scenarios is required, -c is preferable. Unlike the -c option, -pm does not read and process the data during the file copy, as such it is substantially faster than -c. The package model function does not require access to a TUFLOW licence.

A tool in QGIS (as part of the TUFLOW Plugin) exists which provides a dialog to the package model options, which allows users to bypass the creation of a batch file: 
[[Package_Model_in_QGIS | Package Model in QGIS]]

Additional optional flags can be added to the base '''-pm''' switch, in any combination, including: 
;* “All”; 
: The addition of the “All” flag (e.g. -pmAll) copies all file extensions (e.g. 1d_nwk_culv_L.mif, will become 1d_nwk_culv_L.*). 
;* “L” (list); and 
: The addition of the “L” flag (e.g. -pmL) list the files to be copied into an output file, but don’t copy. 
;* “ini” (file.ini) 
: The addition of the “ini” flag (e.g. -pmini) provides a .ini file with user defined options. A .ini file can be used to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames. Valid options should be separated by a vertical bar. 

Combinations of the above are also valid, with the order of the optional switches not being important (-pmAllL would be treated the same as -pmLAll). 
When using package model the default destination folder is created in the same directory as the .tcf file, with the prefix “pm_”. For example, C:\Projects\Modelling\TUFLOW\runs\Run_001.tcf will create a package in the folder “C:\Projects\Modelling\TUFLOW\runs\pm_Run_001\. 

Three options are also available for handling of the binary processed files created by TUFLOW to speed up the simulation start. These options are: 
;* “-xf0”; 
: Do not copy .xf files, only the original inputs are copied. 
;* “-xf1”; and 
: Copy both raw input files and .xf files. 
;* “-xf2” 
: Copy only .xf files, if xf files exist for an input only the xf will be copied. 
 
An example of package model that copies all files is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAll "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of package model that copies all files except .xf files, (-pmAll -xf0) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAll -xf0 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of package model that copies all files with specified .ini file (-pmAllini) is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pmAllini package.ini "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>
An example of .ini file to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames: 
<pre>
Base Folder == <folder>
Copy Destination == <folder>
Model Scenario ~s<number>~ == <scenario A> | <scenario B> | …
Model Event ~e<number>~ == <event A> | <event B> | …
</pre>

===GPU Module Control===
The -pu switch can be used to select which GPU card or cards to direct the simulation towards. –pu must be specified once for each device. For example, to direct the simulation to GPU devices 0 and 2, specify -pu0 -pu2. (Note: the GPU device numbering starts a 0, not 1). For example:
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -pu0 -pu2 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Event and Scenario Management===
The -e and -s switches can be used to manage multiple events and scenarios from a single tuflow control file. The -e and -s wildcard is replaced by the following entry specified in the batch file. For example, the following batch file commands will run two simulations in series:
* M01_Q050_24hr_2m_Dev_001.tcf; and
* M01_Q100_24hr_2m_Dev_001.tcf;

<pre>Start "TUFLOW" /wait "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 Q050 -e2 24hr -s1 2m -s2 Dev "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_~e1~_~e2~_~s1~_s2~_001.tcf"
Start "TUFLOW" /wait "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 Q100 -e2 24hr -s1 2m -s2 Dev "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_~e1~_~e2~_~s1~_s2~_001.tcf"</pre>

Please be aware that the % symbol is a special character in a batch file. If the % symbol is used within a wildcard, it will not be read when searching for that wildcard in TUFLOW. 
For example if the following event wildcard is used; 
*-e 10% 
TUFLOW will search for '10' instead of '10%' as the event wildcard. 
 
It is recommended that modellers avoid the use of a % symbol in any wildcard values. The string 'pct' is a great alternative for the % symbol. 
For example, using: 
*-e 10pct 
Alternatively, using the % symbol twice in a row as shown below should result in a desired wildcard value. 
*-e 10%% (TUFLOW will search for 10%)

===Set Hardware===
The -hwgpu or -hwcpu switches can be used overwrite any "Hardware ==' command specified in the .tcf to GPU or CPU, respectively. This feature was first introduced for Build 2023-03-AB and is not available for TUFLOW builds prior to this.

These switches can be used in conjunction with the -nt (number of threads) or -pu (processing unit id) to provide full control over the hardware usage via the command line.

The following command could be used to run a model with CPU hardware on 8 threads:
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -hwcpu -nt8 FS_Hardware_01.tcf </pre>

The following command could be used to run a model on GPU hardware using 2 devices (GPU 0 and GPU1):
<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -hwgpu -pu0 -pu1 FS_Hardware_01.tcf </pre>

===Set Start Time for a Simulation===
The use of the -st<time_in_hours> (start time) switch allows the user to specify the start time for a simulation. Any start time specified via this run option argument is given the highest priority and overrides the "Start Time ==" settings in the .tcf, event files (.tef) and override files. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -st0 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Set End Time for a Simulation===
The use of the -et<time_in_hours> (end time) switch allows the user to specify the end time for a simulation. Any end time specified via this run option argument is given the highest priority and overrides the "End Time ==" settings in the .tcf, event files (.tef) and override files. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -et3 "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Suppress Message Box Prompts===
The use of the -nmb (no message boxes) switch suppresses the use of Windows message boxes to prompt the user. All prompts will be via the console window. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nmb "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Search for a Network License===
The use of the -nwk (network) switch forces TUFLOW to search for a network licence. I.e. Skip the search for a local license. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nwk "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Search for a WIBU License===
The use of the -wibu (WIBU license) switch forces TUFLOW to search only for a WIBU Codemeter license. 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -wibu "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Specify the Output Drive===
The -od<drive> (output drive) switch allows the user to specify the Output Drive for a simulation. 
For example, the following will redirect all outputs to the C:\ drive: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -odC "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Specify Map Output===
The -oz<name> (output zone) switch specifies that the map output includes the input zone. 
For example, the following would include output for 'Zone A': 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -ozZoneA "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Query the Creation of a Folder===
The -qcf (query the creation of a folder) switch is useful if you would prefer to have the create folder query dialog appear (rather than TUFLOW automatically creating folders - see [[Run_TUFLOW_From_a_Batch-file#Automatically_Create_Folders_in_a_TUFLOW_model | -acf]]). 
An example is: 
<pre>start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -qcf "C:\TUFLOW\Tutorial_Wiki\TUFLOW\runs\M01_5m_001.tcf"</pre>

===Execute a Simulation (the Default)===
The -x (execute) switch executes the simulation. This switch is used by default and does not need to be included on the TUFLOW command line.

===Copy or Test Model License Free===
For Build 2018-03-AA or later, it is possible to use the [[Run_TUFLOW_From_a_Batch-file#Copy_a_TUFLOW_model | copy model]] (-c option) or [[Run_TUFLOW_From_a_Batch-file#Testing_a_simulation | test model]] (-t option) without using a license. To utilise this licence free copy/test, the -nlc (no license check) input argument must be specified. If running without a TUFLOW licence, no diagnostic output is generated (e.g. messages layer). If these are required, the -nlc option must be removed.

===Simulation Log Path (Legacy)===
The -slp (simulation log path) switch is a legacy option for Solftlock (blue) dongles to set the path to a folder on the intranet to log all simulation initiated from the lock. Refer to the [https://www.tuflow.com/downloads/ TUFLOW Manual] (2018 or earlier) for details. 

==Advanced Batch Files==
The below section shows example batch files for maximizing run efficiency,
===Creating a delay===
====Windows 7 and newer====
For a Windows 7 and newer operating system a delay of a set duration can be created with the Timeout <seconds> command. For example: 
<pre>Timeout 10</pre>
Will create a 10 second delay, a countdown timer is given. Press any key to continue.

====Other Systems====
It is possible to create a delay of specified length in a batch file. The best way do this is actually to create a second batch file! To do this create a text file and call it '''wait.bat'''. Within that file enter the following text:
<pre>@ping 127.0.0.1 -n 2 -w 1000 > nul
@ping 127.0.0.1 -n %1% -w 1000> nul</pre>
To create the pause we ping an address for a set time and disregard the output. Once the wait.bat has been created, it can be called from another batchfile using the following syntax:
<pre>call wait <time in seconds.</pre>
In the example below, the first simulation is started and then 60 seconds later (using the wait.bat file) the second simulation is started. Note there is no /wait flag specified, if there was the batchfile would wait for 60 seconds after the first simulation had finished before starting the second simulation.
<pre>Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_5m_001.tcf
call wait 60
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" M01_2.5m_001.tcf</pre>
For this to work the wait.bat file needs to be in the same folder as the batchfile calling it. You can put the file in a specific location and add this path as an environment variable. If this is done "call wait <time in seconds> can be added to any batch file. 
To set the environment variable, you will need to have administrator access to the machine, and add a colon (;) and then the batchfile location (e.g. "C:\batch_files\" , without the quotes) in the '''path''' system variables. The separator character is a colon (;) this is added to specify a new path. For more details on modifying the environment please see here: [https://support.microsoft.com/kb/310519 https://support.microsoft.com/kb/310519].

===Variables===
Batch files can be easily setup so that they are more generic and easily customised when moving from one project to another. For example, in the below a variable, TUFLOWEXE, is used to define the path to the TUFLOW exe to be used, and a variable RUN is used to incorporate options such as the /wait so that the simulations run in series (one after the other).

<pre>set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
set RUN=start "TUFLOW" /wait %TUFLOWEXE% -b
%RUN% MR_H99_C25_Q100.tcf
%RUN% MR_H99_C25_Q050.tcf
%RUN% MR_H99_C25_Q020.tcf</pre>
The advantage of using variables is if the path to the TUFLOW exe changes, or to run a different version of TUFLOW, it is just a simple change in the .bat file. In the above, note the use of quotes around %TUFLOWEXE% in the definition for the RUN variable – quotes are needed around file pathnames whenever they contain a space.

===Looping in a batch file===
If you have a large number of events to run using the event files a for loop can be used in a batch file. In this example we have 5 event magnitudes (-e1 input) and 5 event durations (-e2 input). The following batch file can be used to run all 25 simulations one after the other:
<pre>
@echo off

REM This sets the variables as local, so you can use another batch file with A and B variables
SetLocal

REM set up variables
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min

REM Loop Through
FOR %%a in (%A%) do (
FOR %%b in (%B%) DO (
start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf
)
)
pause
</pre>
In order to test the syntax, you can test the batch file by replacing the following line: 
<tt>start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt> 
With the following line: 
<tt>echo start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt> 
By using the echo in the command line, rather than starting the simulations the command line will be displayed in the DOS output. In the example above the DOS output is shown in the image below.
[[File:DOS nested batch output.png|frame|none]]

Alternatively this can be achieved using the following syntax, which is essentially the same but has the for loops compressed to a single line:
<pre>
@echo off
setlocal
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min

FOR %%a in (%A%) do FOR %%b in (%B%) do start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename_~e1~_~e2~.tcf
pause
</pre>
This can be extended to more variables for example:
<pre>
@echo off
setlocal
set A=Q010 Q020 Q050 Q100 Q200
set B=10min 30min 60min 120min 270min
set C=Exg Dev Mit

FOR %%a in (%A%) do (
FOR %%b in (%B%) do (
FOR %%c in (%C%) do (
start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b -s1 %%c filename_~e1~_~e2~_~s1~.tcf
)
)
)
pause
</pre>

===Looping in a batch file up to a certain number of runs===
The below example shows a method for controlling the number of concurrent simulations. 

As a brief description of the below, the "do_while_loop_start" counts the number of processes in the task manager which have "TUFLOW" in the name. If this is greater than or equal to the variable "CPU_Cores" then the batch file waits for 60 seconds.

<pre>
@ echo off

Set A=Q001 Q002 Q005 Q010 Q020 Q050 Q100
Set B=Exg Dev
set /a CPU_Cores=3

FOR %%a in (%A%) DO (
FOR %%b in (%B%) DO (
call :do_while_loop_start
Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
)
)

Pause

:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
if %count% geq %CPU_Cores% (
PING 1.1.1.1 -n 1 -w 60000 >NUL
goto do_while_loop_start
)
</pre>

Another way to achieve the same result using IF logic is shown below. This batch file will loop through the series of 14 simulations in groups of three. The batch file will pause until the last of the three active model simulations are complete. When complete, the next series of three simulations will be started in parallel.

<pre>
@ echo off
setlocal enabledelayedexpansion

SET A=Q001 Q002 Q005 Q010 Q020 Q050 Q100
SET B=Exg Dev
SET P=3

SET /A Counter=0
FOR %%a in (%A%) DO (
FOR %%b in (%B%) DO (
SET /A Counter+=1
IF /i !Counter!==!P! (
Start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
SET /A Counter=0
) ELSE (
Start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -s1 %%b M01_5m_~e1~_~s1~_001.tcf
)
)
)
</pre>

===Looping in a batch file using scenario logic===
Sometimes when using different scenarios, it is useful to run a specific set of events for one scenario but other events for a different scenario. 
This can be automated within looped batch files using a bit of logic. 
In the the example below there is model with defended and undefended scenarios. The defended scenario needs to be run for the 20, 100 and 200 year events but the undefended scenario is only run for the 100 year event. All models are run for the hr and 3hr critical durations. 
The below batch file also uses the looping up to a certain number of runs, as seen in the point above. 
To customize this script, alter the location of the TUFLOW executable, the name of tcf and the scenarios that you would like to run (Refer to 'Set A==', 'Set C==' and 'Set B=='). 
<pre>
@ echo off
setlocal enabledelayedexpansion

REM ______________SET RUN VARIABLES_____________
set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
set RUN=start "TUFLOW" /low "%TUFLOWEXE%" -b
set /a CPU_Cores=5

set tcf=M01_5m_~s1~_~e1~_~e2~_001.tcf

Set A=UDEF DEF
REM set B in loop beow
Set C==01hr 03hr

REM ______________SET LOOPS____________________
FOR %%a in (%A%) do (

REM _____DEFINE RUN LOGIC______
IF "%%a"=="UDEF" (
set B=100yr
)
IF "%%a"=="DEF" (
set B=020yr 100yr 200yr
)

REM ______________RUN LOOPS____________________
FOR %%b in (!B!) do (
FOR %%c in (%C%) do (
call :do_while_loop_start
%RUN% -s1 %%a -e1 %%b -e2 %%c %tcf%
timeout 60

)
)
)

REM ___________COUNT RUN INSTANCES______________
:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
if %count% geq %CPU_Cores% (
PING 1.1.1.1 -n 1 -w 60000 >NUL
goto do_while_loop_start
)

endlocal
</pre>

===Copy model, checks and results in a looped batch file===
This batch file uses the copy model function to copy the model (inputs and check files), of both scenarios 5m and 2.5m, to a specified folder location. After copying, [https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/robocopy robocopy] is used to copy the results, based off the tcf filename and specified scenarios, to the destination result folder.
<pre>
@echo off

set TUFLOWEXE_iSP=C:\Releases\2023-03-AF\TUFLOW_iSP_w64.exe
set RUN_iSP=start "TUFLOW" /wait "%TUFLOWEXE_iSP%" -cp "D:\tuflow_models\copy"

set A=5m 2.5m
set source_results=..\results
set destination_results=C:\tuflow_models\copy\results

FOR %%a in (%A%) do (
:: Copy model
%RUN_iSP% -s1 %%a M01_~s1~_001.tcf

:: Copy results folder to copy model location
robocopy "%source_results%" "%destination_results%" "M01_%%a_001*" /S

)
pause
</pre>

===Coordinating Asynchronous Simulations===
This batch file will set off asynchronous runs on separate threads, and then wait for all runs to finish before moving to the next process. This example kicks off 8 tuflow.exe processes and then waits before collating (in fortran) and processing the results (in python). Both “combine_therad_outputs.exe” and “Post_process.py” are dummy programs only (with dummy arguments), and are included just to demonstrate how any sort of post processing might be called after the synchronisation of all TUFLOW simulations.

<pre>
@echo off

:: Set local
setlocal
:: User defined variables – will need to be changed
set "for_infile=inputs_fortran.inp"
set "run_exe="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe""
set "file_prefix=C:\temp\test"
set "sum_exe=combine_thread_outputs.exe"
set "n_threads=8"
set "pyt_code=Post_process.py"
set "pyt_infile=inputs_python.inp"

:: Random lock file
set "lock=%temp%\wait%random%.lock"

:: Launch processes asynchronously, with stream 9 redirected to a lock file.
:: The lock file will remain locked until the individual exe instance ends.
:: %%a is sent to %run_exe% as an argument to set the thread to use
for /L %%a in (0,1,7) do (
start "" 9>"%lock%%%a" %run_exe% %for_infile% %%a
)

:: Wait for the processes to finish
:Waitrun
1>nul 2>nul ping /n %n_threads% ::1
for /L %%N in (0,1,7) do (
(call ) 9>"%lock%%%N" || goto :Waitrun
) 2>nul

:: Delete the lock files
del "%lock%*"

:: Collate thread outputs
%sum_exe% %file_prefix% %n_threads%

:: Make image
python %pyt_code% %pyt_infile%

:: Finish up
echo Done.
</pre>

===Shutdown on Completion===
Often we may have a number of TUFLOW simulations going when we leave work on a Friday afternoon, if these are not going to take all weekend to run, using some of the batch file logic above you can create a batch file that will shutdown the computer when no TUFLOW simulations are running. An example batch file for this purpose is below: 
<pre>
echo off

:do_while_loop_start
set /a count=0
for /f %%x in ('tasklist ^| find /c "TUFLOW"') do set count=%%x
IF %count%==0 (
shutdown.exe /s /t 30
) ELSE (
timeout 60
goto do_while_loop_start
)
pause
</pre>
This batch file counts the number of processes with "TUFLOW" in the process name and if this is greater than 0, a delay of 60 seconds is created and the loop started again. If no "TUFLOW" simulations are running a shutdown command is issued. 
To test the batch file it is recommended that you add an "echo" in front of the <tt>shutdown.exe /s /t 30</tt> command to ensure it is working correctly (I use this on a Windows 7 machine, but have not tested it on either XP or Windows 8). 
In order to restart the machine rather than power it off the /s can be replaced with /r. This can be useful when a heavily utilised modelling computer needs a restart!
</ol>

TUFLOW Message 1181

2025-03-07T01:44:21Z

ElizaCollison:

{{TUFLOW_Message
|tuflow_message=ERROR 1181 - Exceeded number of allowable nodes
|alt_msg=NA
|type=[[ERROR]]
|message_desc=The model is attempting to create more nodes during the stage two initialising than were allocated during stage one (stage one counts the number of nodes and allocates memory, stage two creates the nodes).
|suggestions=????

|uplink=[[1xxx_TUFLOW_Messages|1xxx Messages]]
}}

1D Culverts

2025-02-24T12:05:10Z

ElizaCollison:

=Introduction=
A culvert is a structure that allows water to flow under a road, embankment, railway or other similar obstruction from one side to the other. Culverts or pipe channels can be either rectangular, circular (pipe) or irregular in shape and can vary in size depending on the flow and design requirements.
 

=1D-2D Connections=
Connection of a 1D drainage network to the 2D domain typical occurs using one of the following features: 
*1D inlet pits (more details can be found [[1D_Pits | here]]).
*Manually assigned 2D SX connections

Information on how to create a 1D-2D connection in a GIS package are explained within [[Tutorial_M03 | Tutorial 3]].

===SX Connection Hints===
To limit the doubling up of expansion and contraction losses on a culvert (as 1D nwke culverts will already contain height, width, entry and exit coefficients) the 2D flow into and out of a culvert should be as representative of the culvert dimensions. You can achieve this by selecting the number of 2D cells that best matches the width/diameter of your particular culvert. The example below shows a 4m culvert that has used an SX line to select 2 x 2m grid cells to discharge to. Remember that the selection of a particular cell, when using a polyline, requires the polyline intersect the cell cross-hair - refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. 
[[File:Culvert_SX_connection_1.JPG|border|500px]]
 
 
Standard SX connections on the 1D network to the 2D domain where the terrain surface (cell elevations) is greater than the 1D node level will result in an <tt>Error 2050</tt><tt>.</tt> Details about this error can be found [[TUFLOW_Message_2050 | here]]. 

<div><ul>
<li style="display: inline-block;"> [[File:SX_connection_1.JPG|thumb|none|800px|2D SX connection]] </li>
<li style="display: inline-block;"> [[File:SX_connection_1LS.JPG|thumb|none|700px|2D SX connection - Section view]] </li>
</ul></div>
 
Including a "Z" flag will only lower the selected 1D-2D cell. The level of water within the hole will need to increase above the surrounding surface before it will flow into the 2D domain. Using the "Z" can lead to instability issues so it is important to ensure the DTM modification is appropriate in your model. Details about this warning can be found [[TUFLOW_Message_2118 | here]]. 
<div><ul>
<li style="display: inline-block;"> [[File:SX_connection_2.JPG|thumb|none|800px|2D SX connection with "Z" flag]] </li>
<li style="display: inline-block;"> [[File:SX_connection_2LS.JPG|thumb|none|700px|2D SX connection with "Z" flag - Section view]] </li>
</ul></div>
 
Including a Zline or Zshape that modifies the surrounding topography removes any warning or error, in this particular case the Zline also creates a smooth transition for water to flow from the culvert. No need for a "Z" is required.
<div><ul>
<li style="display: inline-block;"> [[File:SX_connection_3.JPG|thumb|none|800px|2D SX connection with Zline]] </li>
<li style="display: inline-block;"> [[File:SX_connection_3LS.JPG|thumb|none|700px|2D SX connection with Zline - Section view]] </li>
</ul></div>

=Flow Regimes=
The flow regime through a culvert are divided into the following types. Checking this information for any 1D culvert can be inspected from the _TSF.mif/_TSF_P.shp that outputs the regime at each output interval. 
{| align="left" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Regime
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Description
|-
| A|| Unsubmerged entrance and exit. Critical flow at entrance. Upstream controlled with the flow control at the inlet.
|-
| B|| Submerged entrance and unsubmerged exit. Orifice flow at entrance. Upstream controlled with the flow control at the inlet.
|-
| C|| Unsubmerged entrance and exit. Critical flow at exit. Upstream controlled with the flow control at the culvert outlet.
|-
| D|| Unsubmerged entrance and exit. Sub-critical flow at exit. Downstream controlled.
|-
| E|| Submerged entrance and unsubmerged exit. Full pipe flow. Upstream controlled with the flow control at the culvert outlet.
|-
| F|| Submerged entrance and exit. Full pipe flow. Downstream controlled.
|-
| G|| No flow. Dry or flap-gate active.
|-
| H|| Submerged entrance and unsubmerged exit. Adverse slope. Downstream controlled.
|-
| J|| Unsubmerged entrance and exit. Adverse slope. Downstream controlled.
|-
| K|| Unsubmerged entrance and submerged exit. Critical flow at entrance. Upstream controlled with the flow control at the inlet. Hydraulic jump along culvert
|-
| L|| Submerged entrance and exit. Orifice flow at entrance. Upstream controlled with the flow control at the inlet. Hydraulic jump along culvert.
|}

 
'''Example of the _TSF results in GIS:''' 
[[File:TSF_result_file.JPG|border|600px]]
 
The GIS results for the _TSF layer show the flow regime that was recorded at each output interval.

=Modelling Bend Losses=

Where bends occur within one culverted length, additional losses can be applied using the form_loss attribute of the 1d_nwk layer. This applies the energy loss appropriately for a 'minor' loss using K*V2/2g. Bend loss coefficients (K) are found in many standard hydraulic references, e.g.:

:*[https://www.business.qld.gov.au/industries/mining-energy-water/water/industry-infrastructure/supply-planning/urban-stormwater-drainage Queensland Urban Drainage Manual]
:*[https://www.ciria.org/CIRIA/Item_Detail.aspx?WebsiteKey=3f18c87a-d62b-4eca-8ef4-9b09309c1c91&iProductCode=C689F&Category=FREEPUBS&OrderLineId=71a52fd5-34ac-4bd9-b219-e1c97a45e059 Culvert Design and Operation Guide (C689F)]
:*[https://www.fhwa.dot.gov/engineering/hydraulics/pubs/12026/hif12026.pdf Hydraulic Design of Highway Culverts]

=Typical Check Files=

The table below highlights some of the commonly used check files when reviewing 1D culverts. Although this list may not be all the check file you could use to review 1D culverts it is certainly a good starting point. The full list of TUFLOW check files can be found [[TUFLOW_Check_Files | here]]. 

{| align="left" class="wikitable" width="20%"

! style="background-color:#005581; font-weight:bold; color:white;"| Filename prefix / suffix
|-
| [[Check_Files_1d_inverts | _inverts_check.mif _inverts_check_P.shp]]
|-
| [[Check_Files_1d_IWL | _iwl_check.mif _iwl_check_P.shp]]
|-
| [[Check_Files_1d_nwk_C | _nwk_C_check.mif _nwk_C_check_L.shp]]
|-
| [[Check_Files_1d_nwk_N | _nwk_N_check.mif _nwk_N_check_P.shp]]
|}

 

 
 
Any further questions please email TUFLOW support: [mailto:support@tuflow.com?Subject=TUFLOW%201D%20culverts%20help support@tuflow.com]
 
{{Tips Navigation
|uplink=[[ TUFLOW 1D Channels and Hydraulic Structures | Back to 1D Channels and Hydraulic Structures]]
}}

QGIS ARR to TUFLOW

2025-02-12T09:36:19Z

ElizaCollison: /* Climate Change */

The ARR to TUFLOW utility has been developed to help users set up a TUFLOW model that uses Australian Rainfall and Runoff (ARR) input parameters and the Australian Bureau of Meteorology (BOM) rainfall by automating the collection and processing of the data. The inputs and outputs of the tool are explained in detail below. '''''Note:''''' this tool helps with data processing, however is not a substitute to reading ARR. Similarly this wiki page discusses the use of the tool and the options, however context should be derived from ARR directly. Please see the [https://arr.ga.gov.au/arr-guideline ARR Website] for more information. 

 
__TOC__
=Getting Started=
===Installation===
The ARR to TUFLOW tool is a free tool that comes as part of the TUFLOW plugin in QGIS. For instructions on how to install the plugin, please see: [[TUFLOW_QGIS_Plugin#Installation_of_Plugin | QGIS TUFLOW Plugin Installation]]

There are also instructions on installing plugins in the QGIS documentation - if you choose to follow the QGIS documentation, the plugin is called "TUFLOW" in the repository: [https://docs.qgis.org/3.16/en/docs/training_manual/qgis_plugins/fetching_plugins.html Link to QGIS Documentation - Installing and Managing Plugins] 

===QGIS Version===
The ARR to TUFLOW tool is, for the most part (see note below), a Python tool that runs independently of QGIS. Therefore the tool should not be sensitive to the installed QGIS version, however occasionally QGIS will update the Python version that is packaged with the installation which means there is a small risk that the tool will break between QGIS versions. If the tool does break, please see [[#The_Tool_Isn.27t_Working | The Tool Isn't Working]] for information (the solution is most likely to update the plugin rather than re-install an older version of QGIS).

''Note:'' The tool does use QGIS for pre-processing tasks, such as area and centroid calculation as well as reprojection or cartesian to long-lat.

===Opening The ARR to TUFLOW Tool===
Once the TUFLOW plugin is installed, the ARR to TUFLOW tool can be opened by clicking the following icon in the plugin toolbar: 
 
[[File: tuflow_plugin_toolbar_ARR_tool_01a.png]] 

=Quickstart=
<ol>
<li> Load a catchment GIS file (e.g. shp file) into QGIS - this can either be a polygon or point layer
<li> Open the '''ARR to TUFLOW''' tool
<li> Select the GIS catchment layer in '''Input Catchment File''' dropdown box. 
[[File: ARR_dialog_input_catchment_file_01a.png]] 
 
<li> Select the attribute field to use as the catchment name in the '''Unique Catchment Identifier Field''' dropdown. 
[[File: ARR_dialog_unique_catchment_identifier_01a.png]] 
 
<li> Select storm event combinations from the list of magnitudes and durations. 
[[File: ARR_dialog_storm_events_01a.png]] 
 
<li> Choose an output location. 
[[File: ARR_dialog_output_location_01a.png]] 
 
<li> Click '''OK''' and wait for the tool to finish. 
[[File: ARR_tool_complete_dialog_01a.png]]
</ol>
 

=Output=
===Log File===
A log file ('''<catchment_name>_log.txt''') will be written to the output folder. The log file will contain all WARNING and ERROR messages as well as logged inputs and processing steps. It's recommended to check the log file after running the tool for any warning or error messages. Most warning messages will be grouped together near the bottom of the log file to make it easier to review them.

===Data Output===
The following outputs are located in the folder '''<output_folder>\data'''
<ol>
<li> '''Raw BOM and ARR Datahub outputs'''
* ARR_Web_data_<catchment_name>.txt
* BOM_raw_web_<catchment_name>.html
* Areal_<TP_Zone>_Increments.csv (Areal temporal patterns)
<li> '''Rainfall depths'''
* BOM_Rainfall_Depths_<catchment_name>.csv - processed rainfall depths (after ARF factors)
<li> '''ARF Factors'''
* <catchment_name>_ARF_Factors.csv - calculated ARF factors
<li> '''Storm Burst Rainfall Losses'''
* <catchment_name>_Burst_Initial_Loss.csv - calculated Storm Burst Initial Rainfall Losses (Complete Storm Initial Loss - Preburst Rainfall Depth)
</ol>

===TUFLOW Output===
The following outputs are generated by the utility for input into TUFLOW. Please see the example below on how to use the output files for a model.
<ol>
<li> '''TUFLOW Rainfall Inflows'''
* The rainfall inflows are output in the following location '''<output_folder>\rf_inflows'''. This output folder is where all the direct rainfall inflows that would be used in the TUFLOW model are output. An inflow file is generated for each event magnitude - duration combination. All available temporal patterns are included in a single file (including climate change options).
<li> '''bc_dbase.csv'''
* TUFLOW boundary condition database. Setup to point to the '''RF''' folder with wildcards applied.
<li> '''event_file.tef'''
* TUFLOW Event File. Setup with wildcards applied. To keep the file names from becoming overly long and complicated, Climate Change scenarios are labelled as '''CC1''', '''CC2'''.. etc. These correspond to the combinations of climate change scenarios requested by the user e.g. 2090_8.5 (climate change year: 2090, RCP: 8.5)
<li> '''soil_infiltration.trd''' or '''rainfall_losses.trd''' - the name of the file will be dependent on the selected loss method, but they are essentially the same file
* This file is a TUFLOW Read File (.trd) that contains variable initialisation for initial and continuing loss values
<li> '''soils.tsoilf''' or '''materials.csv''' - which file is output will be dependent on the selected loss method
* soils.tsoilf - rainfall loss file for the infiltration loss method
* materials.csv - rainfall loss file for the rainfall excess method
</ol> 

===Example: Using the outputs in a TUFLOW model===
* [[QGIS_ARR_to_TUFLOW_Example | Example use of the ARR to TUFLOW tool]]
 

=Additional Options=
===Climate Change===
Climate change options can be added by clicking on '''Edit''' under the climate change section. This opens up a table widget that the user can then add/remove climate change scenarios based on the guidance in ARR v4.2. Once a user adds a scenario (green plus), they can double click on the values to change them. For example, double clicking on SSP2-4.5 under the 'SSP' heading will show the available Shared Socioeconomic Pathway (SSP) options. Scenarios added in the table will be displayed in the climate change section (underneath the edit button). Note: each scenario name must be unique and generally the table widget will force unique names. The scenario names will be used throughout the outputs and the user is free to customise the scenario names as they want. 

The table columns within the table widget are based on ARR guidelines v4.2 and the examples presented in Book 1, Chapter 6. Please note the following assumptions: 
* Near-term horizon = 2030
* Medium-term horizon = 2050
* Long-term horizon = 2090
* Temperature Change - Setting this to -1 will adopt the temperature changes output in the climate change part of the ARR datahub download. If a value or zero or greater is set by the user, this will be adopted instead of the datahub values and it will be assumed that these are changes relative to the pre-industrial period. Note: the temperature change will be stopped from going negative within the calculation.

By adding climate change scenarios, the following outputs will be turned on:
* An extra boundary database file: '''bc_dbase_CC.csv'''
* Climate change inflows will be appended to the end of each event's inflow file
* One additional event option will also be added to the event file for each combination of selected climate change scenarios labelled based on the scenario name. It is intended that the climate change scenarios would be treated as a separate event (e1 = magnitude, e2 = duration, e3 = temporal pattern, e4 = climate change scenario) however the output files can easily be manipulated by the user to configure the model differently.
* The following CSV files will be written to the '''data''' output folder:
** ''<scen_name>_rainfall_factors.csv''
** ''<scen_name>_rainfall_depths.csv''
** ''<scen_name>_losses.csv'' 
[[File: ARR_dialog_climate_change_01b.png]] 
[[File: ARR_example_climate_change_rf_inflow_01a.png|1200px]] 
[[File: ARR_example_climate_change_tef_01a.png]]
 

===Temporal Patterns===
Temporal pattern options can be found by expanding the '''Temporal Patterns''' section in the dialog.
* '''Manually Specify Point Temporal Patterns (csv)''' - lets the user specify the point temporal patterns which is expected to be in the ARR datahub format
* '''Manually Specify Areal Temporal Patterns (csv)''' - lets the user specify the arealtemporal patterns which is expected to be in the ARR datahub format
* '''Optional Additional Temporal Patterns''' - Lets the user add additional temporal patterns in a couple of different ways: 
** The user can choose to add temporal patterns from other temporal pattern regions. This is only if the user wishes to included ''additional'' temporal patterns. The temporal patterns from the catchment location (taken at the catchment centroid) will always be included. The additional temporal patterns will be included in the inflow files and added to the event file.
** The user can choose to add temporal patterns from other temporal pattern bins within the same region. For point temporal patterns, this would add temporal patterns from the 'frequent', 'intermediate', and 'rare' bins. For areal temporal patterns, this would add temporal patterns from other "Area" bins. The "correct" bin will always make up the first 10 temporal patterns (TP01 to TP10).
*** For Areal temporal patterns - The user has the additional option to choose how many additional areal temporal pattern sets to add. The default is 2 as this matches the number of additional point temporal patterns that would be added (but it doesn't necessarily have to be the same). The "Area" bins chosen will be the next closest in order.
[[File: ARR_Dialog_temporal_patterns_01a.png]] 
[[File: ARR_example_additional_temporal_patterns_rf_inflow_01a.png]] 
[[File: ARR_example_additional_temporal_patterns_tef_01a.png]] 

===Rainfall===
[https://data.arr-software.org/limb_specific LIMB Rainfall Data] 
Since v3.8.2.16 ([[Installing_the_Latest_Development_Version_of_the_TUFLOW_Plugin | development version]]), LIMB data will be used for rainfall depths where available (SEQ specific). The user has the option of selecting the IFD curve from the available sets:
* Enveloped (Default)
* High Resolution
* BOM Resolution
The user also has the option of turning off LIMB data and using BOM 2016 rainfall data instead. If LIMB data is not available, the tool will default to BOM data. 
 
If the user has selected AEP or durations outside of the provided LIMB data range, the tool will use BOM 2016 rainfall data. If the user has selected AEP or durations within the LIMB data range, but the value is not part of the provided IFD, the tool will interpolate the rainfall depth from the provided LIMB data. 
[[File: arr2016_limb_selector_01a.png]] 

===Rainfall Losses===
The following sections summarise the available loss options. Please note, as recommended in ARR2019, [https://data.arr-software.org/ ARR datahub] losses are only intended for rural use. They are not for direct use in urban areas. Furthermore, applications in New South Wales and Victoria should consider the following jurisdiction specific guidance:
* [https://data.arr-software.org/nsw_specific NSW Specific Guidance]
* [https://data.arr-software.org/vic_specific VIC Specific Guidance]

''Note: Since version v3.5 initial loss for durations greater than 72 hrs is assumed to be the same as the initial loss for 72 hrs. Previous to this version, these losses were output as zeros.'' 

=====Probability Neutral Losses=====
Probability neutral losses can be toggled on / off in the dialog (default is on). If 'on', this option will use probability neutral losses for the design burst initial loss rather than using the storm initial loss and pre-burst depths. If probability neutral losses are not available in the catchment area, then the method will automatically revert to using the storm initial loss). Currently this option cannot be used in conjunction with the '''complete storm''' option. 
[[File: ARR_dialog_probability_neutral_losses_01a.png]]
 

=====NSW Continuing Loss=====
Continuing loss values for NSW will be automatically multiplied by 0.4. This will be reported in the log file as:
* "Catchment is in NSW, multiplying Datahub continuing loss by 0.4"
 

=====Pre-burst Percentile=====
The pre-burst percentile used to calculate design burst initial loss, or for pre-burst rainfall depth for the complete storm option, can be changed using the dropdown box in the dialog. 
[[File: ARR_dialog_preburst_01a.png]]
 

=====User Defined Losses=====
Users can use their own rainfall loss values. The initial loss value will be treated as a complete storm value and not just for the design burst. For most regions, the design burst loss will be calculated my removing the pre-burst depth from the input loss value. If probability neutral losses are available, the burst initial loss will be calculated using the following equation: 
: <tt>IL burst = User IL x IL ARR Prob Neutral / IL ARR Complete Storm</tt> 
[[File: ARR_dialog_user_losses_01a.png]]
 

=====Event Independent Continuing Loss=====
The event independent continuing loss only affects how the TUFLOW output files are written. This option will remove the continuing loss variable and will instead input the value directly. Ths option was added since the continuing loss value is (currently) event independent and therefore simplifies the output and also makes editing this value easier.
 

=====Impervious Losses=====
The impervious loss value adds the impervious loss values to the materials.csv output. This option only affects the rainfall excess loss approach. 
[[File: ARR_example_impervious_losses_01a.png]]
 

=====TUFLOW Loss Method=====
The loss method used by TUFLOW can be changed using the '''TUFLOW Loss Method''' dropdown box:
* '''Infiltration (soil file)''' - will output files for the infiltration approach in TUFLOW. This approach in TUFLOW applies the total rainfall to the 2D grid and ponded water in the 2D domain can then infiltrate based on the underlying soil type and impervious fraction. See [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] for more information.
* '''Rainfall Excess (material file)''' - will output files for the rainfall excess approach in TUFLOW. This approach removes the losses from the rainfall inflow prior to application so only excess rainfall is added to the model.
 
[[File: ARR_dialog_tuflow_loss_method_01a.png]]
 

=====Initial Losses For Durations Less Than 1 Hour=====
This selects the method for determining intial loss values for events less than 1 hr in duration:
* '''Interpolate to zero''' - will linearly interpolate loss values (assuming a loss value of 0 mm for 0 min)
* '''Log-Interpolate to zero''' - will use a log-linear interpolation (duration will use a log scale) (assuming a loss value of 0 mm for 0 min)
* '''Static Value''' - uses a user defined value for all event magnitudes
* '''Use 60 min Losses''' - uses the 60 min loss values
* '''Rahmen et al 2002''' - uses an equation determined by a study conducted by Rahmen et all in 2002
* '''Hill et al 1996:1998''' - uses an equation determined by a study conducted by Hill et all 1996:1998. This requires the user to provide a mean annual rainfall value.
* '''Interpolate pre-burst''' - will linearly interpolate pre-burst depths (rather than losses) (assuming a depth of 0 mm for 0 min)
* '''Log-Interpolate pre-burst''' - will use a log-linear interpolation on the pre-burst depths (duration will use a log scale) (assuming a depth of 0 mm for 0 min)
 
[[File: ARR_dialog_losses_less_than_1h_01a.png]]
 
An example of the differences in initial losses from a few of the methods: 
[[File: arr_to_tuflow_loss_interpolation.png]]
 

====Output Complete Storm====
The user can choose to output the complete storm (preburst + design burst) rather than just the design burst by checking on the following option (please see ARR Book 2 Chapter 5 [Section 5.9.9] for more information): 
[[File: ARR_complete_storm_checkbox_01a.png]] 
The complete storm generated by the tool will be the preburst depth (from the '''Preburst percentile''' extracted from the datahub) plus the design burst. The user will be required to select a preburst temporal pattern from the options listed below. The options below have been included at the request of users and are not a direct reference to any specific methodology outline in ARR. If you would like to see another method included, please email [mailto:support@tuflow.com support@tuflow.com]. 
Currently the ARR to TUFLOW tool supports the following preburst temporal pattern methods:
* '''Constant Rate''' - This will apply the preburst depth equally over a given time period. The time period can be specified as an absolute time (either as minutes or hours) or proprotional to the design storm e.g. a proportional value of 0.5 will apply a 30 min preburst to a 1 hr storm and a 15 min preburst to a 30 min storm.
* '''Temporal Pattern''' - This will apply the preburst depth using a temporal pattern obtained from the datahub for a given duration. The preburst duration can either be an absolute time or be proportional to the design storm. The user will need to select which temporal pattern to use (e.g. TP01, TP02,... TP10). Note: there is a minimum preburst duration of 10 min for this method.
** If "design burst" is selected, this will cause the pre-burst temporal pattern to use the same temporal pattern number as the design burst (e.g. TP01 design burst will use TP01 pre-burst, TP02 design burst will use TP02 pre-burst, etc.)
The initial loss value output in this method will be the raw storm initial loss value from the datahub with no post processing. Note, the complete storm option and using probability neutral losses are mutually exclusive and aren't able to be used together. 

Preburst temporal pattern and duration details are ignored if the "Use Complete Storm" checkbox is not selected.
 

====Why Is the Tool Outputting Negative Loss Values?====
The tool will output negative loss values when the preburst depth is greater than the storm initial loss. The tool will not floor loss values at zero since the value may be useful in helping the user determine the appropriate course of action. E.g. if IL = -1mm, this may be considered negligible and can be simply set to zero. An IL = -50mm may be considered significant enough that it simply can't be set to zero and alternate, or sensitivity runs, may need to be carried out, like using a [[#Output_Complete_Storm | Complete Storm]].

===Areal Reduction Factors===
Areal reduction factor options can be changed in the '''ARF''' section:
* '''Calculate Area''' - will calculate the catchment area using the GIS feature in QGIS. For point objects, this will be set to zero and no ARF will be applied (i.e. a value of 1.0)
* '''User Area''' - will let the user define the area. This can either be done by selecting an attribute field that contains the catchment area, or by entering a value. All user inputs will be assumed to be in square km.
* '''Minimum ARF''' - this value sets a floor for the calculated ARF values
* '''ARF for events < 50% AEP''' - this will calculate ARF values using the same equations used for larger events
 
[[File: ARR_dialog_ARF_01a.png]]
 

===Additional Output Options===
Additional output options include:
* '''Output Format''' - can choose to output in either csv or ts1 format. Ts1 files will be quicker to read in by TUFLOW, however the difference may not be substantial depending on how many are being read in. TUFLOW will also use .xf files by default which means that the raw data is only processed if there is a change, and subsequent runs will not suffer from any slow down from having to read csv files.
* '''Output Notation''' - users can toggle between '% AEP' and 'yr ARI' output notation.
 
[[File: ARR_dialog_output_options_01a.png]]
 

===Offline Mode===
Offline can be used to pass in data that has already been pulled from the ARR datahub and BOM. This can be useful if the user would like to make use of new features in the tool, however would like to ensure they are getting consistent results with previous data that was pulled from the BOM and the ARR datahub. The files required to process offline are saved as part of the tool's process when pulling from the web. Currently offline mode doesn't support areal temporal patterns directly, however this can easily be added by using the '''manually specify areal temporal pattern''' option:
* ARR_Web_data_<catchment_name>.txt
* BOM_raw_web_<catchment_name>.html
 
[[File: ARR_dialog_offline_inputs_01a.png]]
 

=The Tool Isn't Working=
The first step in identifying the problem is to check the log file. The issue may be something simple like:
* one of the files the tool is trying to write to is locked by a process or user (e.g. one of the outputs is open in Excel)
* the tool can't access a network location
* there is no internet connection
* the ARR Datahub or BOM is down (see [[#Can.27t_access_the_websites | Can't Access the Websites]] section below)
A useful check if you're unsure if the issue is with the tool or with something else (like the Datahub), is to check if you can manually access and pull data from the Datahub for your catchment site.
 
The second step is to ensure you're using the latest version of the QGIS plugin. Occasionally updates to the ARR Datahub will break the tool and this may have already been caught and fixed in the latest update. 
===Issue With The Tool===
If there's an issue with the tool, or you are unsure, please contact [mailto:support@tuflow.com support@tuflow.com] for help. Please include a description of the problem, the log file, and the GIS catchment layer with your email. 
===Can't access the websites===
Sometimes the BOM or ARR Datahub websites are down or unable to be accessed by the tool (e.g. sometimes to manage traffic, the Datahub server will limit, or disallow scraping). The below are a set of instructions that can be used as a workaround should this occur:
*[[ARR_DATAHUB_CANNOT_BE_ACCESSED | ARR Datahub website cannot be accessed by the tool]]
 
{{Tips Navigation
|uplink=[[TUFLOW_QGIS_Plugin#Usage| Back to TUFLOW QGIS Plugin Main Page]]
}}

QGIS ARR to TUFLOW

2025-02-12T09:29:52Z

ElizaCollison: /* Climate Change */

The ARR to TUFLOW utility has been developed to help users set up a TUFLOW model that uses Australian Rainfall and Runoff (ARR) input parameters and the Australian Bureau of Meteorology (BOM) rainfall by automating the collection and processing of the data. The inputs and outputs of the tool are explained in detail below. '''''Note:''''' this tool helps with data processing, however is not a substitute to reading ARR. Similarly this wiki page discusses the use of the tool and the options, however context should be derived from ARR directly. Please see the [https://arr.ga.gov.au/arr-guideline ARR Website] for more information. 

 
__TOC__
=Getting Started=
===Installation===
The ARR to TUFLOW tool is a free tool that comes as part of the TUFLOW plugin in QGIS. For instructions on how to install the plugin, please see: [[TUFLOW_QGIS_Plugin#Installation_of_Plugin | QGIS TUFLOW Plugin Installation]]

There are also instructions on installing plugins in the QGIS documentation - if you choose to follow the QGIS documentation, the plugin is called "TUFLOW" in the repository: [https://docs.qgis.org/3.16/en/docs/training_manual/qgis_plugins/fetching_plugins.html Link to QGIS Documentation - Installing and Managing Plugins] 

===QGIS Version===
The ARR to TUFLOW tool is, for the most part (see note below), a Python tool that runs independently of QGIS. Therefore the tool should not be sensitive to the installed QGIS version, however occasionally QGIS will update the Python version that is packaged with the installation which means there is a small risk that the tool will break between QGIS versions. If the tool does break, please see [[#The_Tool_Isn.27t_Working | The Tool Isn't Working]] for information (the solution is most likely to update the plugin rather than re-install an older version of QGIS).

''Note:'' The tool does use QGIS for pre-processing tasks, such as area and centroid calculation as well as reprojection or cartesian to long-lat.

===Opening The ARR to TUFLOW Tool===
Once the TUFLOW plugin is installed, the ARR to TUFLOW tool can be opened by clicking the following icon in the plugin toolbar: 
 
[[File: tuflow_plugin_toolbar_ARR_tool_01a.png]] 

=Quickstart=
<ol>
<li> Load a catchment GIS file (e.g. shp file) into QGIS - this can either be a polygon or point layer
<li> Open the '''ARR to TUFLOW''' tool
<li> Select the GIS catchment layer in '''Input Catchment File''' dropdown box. 
[[File: ARR_dialog_input_catchment_file_01a.png]] 
 
<li> Select the attribute field to use as the catchment name in the '''Unique Catchment Identifier Field''' dropdown. 
[[File: ARR_dialog_unique_catchment_identifier_01a.png]] 
 
<li> Select storm event combinations from the list of magnitudes and durations. 
[[File: ARR_dialog_storm_events_01a.png]] 
 
<li> Choose an output location. 
[[File: ARR_dialog_output_location_01a.png]] 
 
<li> Click '''OK''' and wait for the tool to finish. 
[[File: ARR_tool_complete_dialog_01a.png]]
</ol>
 

=Output=
===Log File===
A log file ('''<catchment_name>_log.txt''') will be written to the output folder. The log file will contain all WARNING and ERROR messages as well as logged inputs and processing steps. It's recommended to check the log file after running the tool for any warning or error messages. Most warning messages will be grouped together near the bottom of the log file to make it easier to review them.

===Data Output===
The following outputs are located in the folder '''<output_folder>\data'''
<ol>
<li> '''Raw BOM and ARR Datahub outputs'''
* ARR_Web_data_<catchment_name>.txt
* BOM_raw_web_<catchment_name>.html
* Areal_<TP_Zone>_Increments.csv (Areal temporal patterns)
<li> '''Rainfall depths'''
* BOM_Rainfall_Depths_<catchment_name>.csv - processed rainfall depths (after ARF factors)
<li> '''ARF Factors'''
* <catchment_name>_ARF_Factors.csv - calculated ARF factors
<li> '''Storm Burst Rainfall Losses'''
* <catchment_name>_Burst_Initial_Loss.csv - calculated Storm Burst Initial Rainfall Losses (Complete Storm Initial Loss - Preburst Rainfall Depth)
</ol>

===TUFLOW Output===
The following outputs are generated by the utility for input into TUFLOW. Please see the example below on how to use the output files for a model.
<ol>
<li> '''TUFLOW Rainfall Inflows'''
* The rainfall inflows are output in the following location '''<output_folder>\rf_inflows'''. This output folder is where all the direct rainfall inflows that would be used in the TUFLOW model are output. An inflow file is generated for each event magnitude - duration combination. All available temporal patterns are included in a single file (including climate change options).
<li> '''bc_dbase.csv'''
* TUFLOW boundary condition database. Setup to point to the '''RF''' folder with wildcards applied.
<li> '''event_file.tef'''
* TUFLOW Event File. Setup with wildcards applied. To keep the file names from becoming overly long and complicated, Climate Change scenarios are labelled as '''CC1''', '''CC2'''.. etc. These correspond to the combinations of climate change scenarios requested by the user e.g. 2090_8.5 (climate change year: 2090, RCP: 8.5)
<li> '''soil_infiltration.trd''' or '''rainfall_losses.trd''' - the name of the file will be dependent on the selected loss method, but they are essentially the same file
* This file is a TUFLOW Read File (.trd) that contains variable initialisation for initial and continuing loss values
<li> '''soils.tsoilf''' or '''materials.csv''' - which file is output will be dependent on the selected loss method
* soils.tsoilf - rainfall loss file for the infiltration loss method
* materials.csv - rainfall loss file for the rainfall excess method
</ol> 

===Example: Using the outputs in a TUFLOW model===
* [[QGIS_ARR_to_TUFLOW_Example | Example use of the ARR to TUFLOW tool]]
 

=Additional Options=
===Climate Change===
Climate change options can be added by clicking on '''Edit''' under the climate change section. This opens up a table widget that the user can then add/remove climate change scenarios based on the guidance in ARR v4.2. Scenarios added in the table will be displayed in the climate change section (underneath the edit button). Note: each scenario name must be unique and generally the table widget will force unique names. The scenario names will be used throughout the outputs and the user is free to customise the scenario names as they want. 

The table columns within the table widget are based on ARR guidelines v4.2 and the examples presented in Book 1, Chapter 6. Please note the following assumptions: 
* Near-term horizon = 2030
* Medium-term horizon = 2050
* Long-term horizon = 2090
* Temperature Change - Setting this to -1 will adopt the temperature changes output in the climate change part of the ARR datahub download. If a value or zero or greater is set by the user, this will be adopted instead of the datahub values and it will be assumed that these are changes relative to the pre-industrial period. Note: the temperature change will be stopped from going negative within the calculation.

By adding climate change scenarios, the following outputs will be turned on:
* An extra boundary database file: '''bc_dbase_CC.csv'''
* Climate change inflows will be appended to the end of each event's inflow file
* One additional event option will also be added to the event file for each combination of selected climate change scenarios labelled based on the scenario name. It is intended that the climate change scenarios would be treated as a separate event (e1 = magnitude, e2 = duration, e3 = temporal pattern, e4 = climate change scenario) however the output files can easily be manipulated by the user to configure the model differently.
* The following CSV files will be written to the '''data''' output folder:
** ''<scen_name>_rainfall_factors.csv''
** ''<scen_name>_rainfall_depths.csv''
** ''<scen_name>_losses.csv'' 
[[File: ARR_dialog_climate_change_01b.png]] 
[[File: ARR_example_climate_change_rf_inflow_01a.png|1200px]] 
[[File: ARR_example_climate_change_tef_01a.png]]
 

===Temporal Patterns===
Temporal pattern options can be found by expanding the '''Temporal Patterns''' section in the dialog.
* '''Manually Specify Point Temporal Patterns (csv)''' - lets the user specify the point temporal patterns which is expected to be in the ARR datahub format
* '''Manually Specify Areal Temporal Patterns (csv)''' - lets the user specify the arealtemporal patterns which is expected to be in the ARR datahub format
* '''Optional Additional Temporal Patterns''' - Lets the user add additional temporal patterns in a couple of different ways: 
** The user can choose to add temporal patterns from other temporal pattern regions. This is only if the user wishes to included ''additional'' temporal patterns. The temporal patterns from the catchment location (taken at the catchment centroid) will always be included. The additional temporal patterns will be included in the inflow files and added to the event file.
** The user can choose to add temporal patterns from other temporal pattern bins within the same region. For point temporal patterns, this would add temporal patterns from the 'frequent', 'intermediate', and 'rare' bins. For areal temporal patterns, this would add temporal patterns from other "Area" bins. The "correct" bin will always make up the first 10 temporal patterns (TP01 to TP10).
*** For Areal temporal patterns - The user has the additional option to choose how many additional areal temporal pattern sets to add. The default is 2 as this matches the number of additional point temporal patterns that would be added (but it doesn't necessarily have to be the same). The "Area" bins chosen will be the next closest in order.
[[File: ARR_Dialog_temporal_patterns_01a.png]] 
[[File: ARR_example_additional_temporal_patterns_rf_inflow_01a.png]] 
[[File: ARR_example_additional_temporal_patterns_tef_01a.png]] 

===Rainfall===
[https://data.arr-software.org/limb_specific LIMB Rainfall Data] 
Since v3.8.2.16 ([[Installing_the_Latest_Development_Version_of_the_TUFLOW_Plugin | development version]]), LIMB data will be used for rainfall depths where available (SEQ specific). The user has the option of selecting the IFD curve from the available sets:
* Enveloped (Default)
* High Resolution
* BOM Resolution
The user also has the option of turning off LIMB data and using BOM 2016 rainfall data instead. If LIMB data is not available, the tool will default to BOM data. 
 
If the user has selected AEP or durations outside of the provided LIMB data range, the tool will use BOM 2016 rainfall data. If the user has selected AEP or durations within the LIMB data range, but the value is not part of the provided IFD, the tool will interpolate the rainfall depth from the provided LIMB data. 
[[File: arr2016_limb_selector_01a.png]] 

===Rainfall Losses===
The following sections summarise the available loss options. Please note, as recommended in ARR2019, [https://data.arr-software.org/ ARR datahub] losses are only intended for rural use. They are not for direct use in urban areas. Furthermore, applications in New South Wales and Victoria should consider the following jurisdiction specific guidance:
* [https://data.arr-software.org/nsw_specific NSW Specific Guidance]
* [https://data.arr-software.org/vic_specific VIC Specific Guidance]

''Note: Since version v3.5 initial loss for durations greater than 72 hrs is assumed to be the same as the initial loss for 72 hrs. Previous to this version, these losses were output as zeros.'' 

=====Probability Neutral Losses=====
Probability neutral losses can be toggled on / off in the dialog (default is on). If 'on', this option will use probability neutral losses for the design burst initial loss rather than using the storm initial loss and pre-burst depths. If probability neutral losses are not available in the catchment area, then the method will automatically revert to using the storm initial loss). Currently this option cannot be used in conjunction with the '''complete storm''' option. 
[[File: ARR_dialog_probability_neutral_losses_01a.png]]
 

=====NSW Continuing Loss=====
Continuing loss values for NSW will be automatically multiplied by 0.4. This will be reported in the log file as:
* "Catchment is in NSW, multiplying Datahub continuing loss by 0.4"
 

=====Pre-burst Percentile=====
The pre-burst percentile used to calculate design burst initial loss, or for pre-burst rainfall depth for the complete storm option, can be changed using the dropdown box in the dialog. 
[[File: ARR_dialog_preburst_01a.png]]
 

=====User Defined Losses=====
Users can use their own rainfall loss values. The initial loss value will be treated as a complete storm value and not just for the design burst. For most regions, the design burst loss will be calculated my removing the pre-burst depth from the input loss value. If probability neutral losses are available, the burst initial loss will be calculated using the following equation: 
: <tt>IL burst = User IL x IL ARR Prob Neutral / IL ARR Complete Storm</tt> 
[[File: ARR_dialog_user_losses_01a.png]]
 

=====Event Independent Continuing Loss=====
The event independent continuing loss only affects how the TUFLOW output files are written. This option will remove the continuing loss variable and will instead input the value directly. Ths option was added since the continuing loss value is (currently) event independent and therefore simplifies the output and also makes editing this value easier.
 

=====Impervious Losses=====
The impervious loss value adds the impervious loss values to the materials.csv output. This option only affects the rainfall excess loss approach. 
[[File: ARR_example_impervious_losses_01a.png]]
 

=====TUFLOW Loss Method=====
The loss method used by TUFLOW can be changed using the '''TUFLOW Loss Method''' dropdown box:
* '''Infiltration (soil file)''' - will output files for the infiltration approach in TUFLOW. This approach in TUFLOW applies the total rainfall to the 2D grid and ponded water in the 2D domain can then infiltrate based on the underlying soil type and impervious fraction. See [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] for more information.
* '''Rainfall Excess (material file)''' - will output files for the rainfall excess approach in TUFLOW. This approach removes the losses from the rainfall inflow prior to application so only excess rainfall is added to the model.
 
[[File: ARR_dialog_tuflow_loss_method_01a.png]]
 

=====Initial Losses For Durations Less Than 1 Hour=====
This selects the method for determining intial loss values for events less than 1 hr in duration:
* '''Interpolate to zero''' - will linearly interpolate loss values (assuming a loss value of 0 mm for 0 min)
* '''Log-Interpolate to zero''' - will use a log-linear interpolation (duration will use a log scale) (assuming a loss value of 0 mm for 0 min)
* '''Static Value''' - uses a user defined value for all event magnitudes
* '''Use 60 min Losses''' - uses the 60 min loss values
* '''Rahmen et al 2002''' - uses an equation determined by a study conducted by Rahmen et all in 2002
* '''Hill et al 1996:1998''' - uses an equation determined by a study conducted by Hill et all 1996:1998. This requires the user to provide a mean annual rainfall value.
* '''Interpolate pre-burst''' - will linearly interpolate pre-burst depths (rather than losses) (assuming a depth of 0 mm for 0 min)
* '''Log-Interpolate pre-burst''' - will use a log-linear interpolation on the pre-burst depths (duration will use a log scale) (assuming a depth of 0 mm for 0 min)
 
[[File: ARR_dialog_losses_less_than_1h_01a.png]]
 
An example of the differences in initial losses from a few of the methods: 
[[File: arr_to_tuflow_loss_interpolation.png]]
 

====Output Complete Storm====
The user can choose to output the complete storm (preburst + design burst) rather than just the design burst by checking on the following option (please see ARR Book 2 Chapter 5 [Section 5.9.9] for more information): 
[[File: ARR_complete_storm_checkbox_01a.png]] 
The complete storm generated by the tool will be the preburst depth (from the '''Preburst percentile''' extracted from the datahub) plus the design burst. The user will be required to select a preburst temporal pattern from the options listed below. The options below have been included at the request of users and are not a direct reference to any specific methodology outline in ARR. If you would like to see another method included, please email [mailto:support@tuflow.com support@tuflow.com]. 
Currently the ARR to TUFLOW tool supports the following preburst temporal pattern methods:
* '''Constant Rate''' - This will apply the preburst depth equally over a given time period. The time period can be specified as an absolute time (either as minutes or hours) or proprotional to the design storm e.g. a proportional value of 0.5 will apply a 30 min preburst to a 1 hr storm and a 15 min preburst to a 30 min storm.
* '''Temporal Pattern''' - This will apply the preburst depth using a temporal pattern obtained from the datahub for a given duration. The preburst duration can either be an absolute time or be proportional to the design storm. The user will need to select which temporal pattern to use (e.g. TP01, TP02,... TP10). Note: there is a minimum preburst duration of 10 min for this method.
** If "design burst" is selected, this will cause the pre-burst temporal pattern to use the same temporal pattern number as the design burst (e.g. TP01 design burst will use TP01 pre-burst, TP02 design burst will use TP02 pre-burst, etc.)
The initial loss value output in this method will be the raw storm initial loss value from the datahub with no post processing. Note, the complete storm option and using probability neutral losses are mutually exclusive and aren't able to be used together. 

Preburst temporal pattern and duration details are ignored if the "Use Complete Storm" checkbox is not selected.
 

====Why Is the Tool Outputting Negative Loss Values?====
The tool will output negative loss values when the preburst depth is greater than the storm initial loss. The tool will not floor loss values at zero since the value may be useful in helping the user determine the appropriate course of action. E.g. if IL = -1mm, this may be considered negligible and can be simply set to zero. An IL = -50mm may be considered significant enough that it simply can't be set to zero and alternate, or sensitivity runs, may need to be carried out, like using a [[#Output_Complete_Storm | Complete Storm]].

===Areal Reduction Factors===
Areal reduction factor options can be changed in the '''ARF''' section:
* '''Calculate Area''' - will calculate the catchment area using the GIS feature in QGIS. For point objects, this will be set to zero and no ARF will be applied (i.e. a value of 1.0)
* '''User Area''' - will let the user define the area. This can either be done by selecting an attribute field that contains the catchment area, or by entering a value. All user inputs will be assumed to be in square km.
* '''Minimum ARF''' - this value sets a floor for the calculated ARF values
* '''ARF for events < 50% AEP''' - this will calculate ARF values using the same equations used for larger events
 
[[File: ARR_dialog_ARF_01a.png]]
 

===Additional Output Options===
Additional output options include:
* '''Output Format''' - can choose to output in either csv or ts1 format. Ts1 files will be quicker to read in by TUFLOW, however the difference may not be substantial depending on how many are being read in. TUFLOW will also use .xf files by default which means that the raw data is only processed if there is a change, and subsequent runs will not suffer from any slow down from having to read csv files.
* '''Output Notation''' - users can toggle between '% AEP' and 'yr ARI' output notation.
 
[[File: ARR_dialog_output_options_01a.png]]
 

===Offline Mode===
Offline can be used to pass in data that has already been pulled from the ARR datahub and BOM. This can be useful if the user would like to make use of new features in the tool, however would like to ensure they are getting consistent results with previous data that was pulled from the BOM and the ARR datahub. The files required to process offline are saved as part of the tool's process when pulling from the web. Currently offline mode doesn't support areal temporal patterns directly, however this can easily be added by using the '''manually specify areal temporal pattern''' option:
* ARR_Web_data_<catchment_name>.txt
* BOM_raw_web_<catchment_name>.html
 
[[File: ARR_dialog_offline_inputs_01a.png]]
 

=The Tool Isn't Working=
The first step in identifying the problem is to check the log file. The issue may be something simple like:
* one of the files the tool is trying to write to is locked by a process or user (e.g. one of the outputs is open in Excel)
* the tool can't access a network location
* there is no internet connection
* the ARR Datahub or BOM is down (see [[#Can.27t_access_the_websites | Can't Access the Websites]] section below)
A useful check if you're unsure if the issue is with the tool or with something else (like the Datahub), is to check if you can manually access and pull data from the Datahub for your catchment site.
 
The second step is to ensure you're using the latest version of the QGIS plugin. Occasionally updates to the ARR Datahub will break the tool and this may have already been caught and fixed in the latest update. 
===Issue With The Tool===
If there's an issue with the tool, or you are unsure, please contact [mailto:support@tuflow.com support@tuflow.com] for help. Please include a description of the problem, the log file, and the GIS catchment layer with your email. 
===Can't access the websites===
Sometimes the BOM or ARR Datahub websites are down or unable to be accessed by the tool (e.g. sometimes to manage traffic, the Datahub server will limit, or disallow scraping). The below are a set of instructions that can be used as a workaround should this occur:
*[[ARR_DATAHUB_CANNOT_BE_ACCESSED | ARR Datahub website cannot be accessed by the tool]]
 
{{Tips Navigation
|uplink=[[TUFLOW_QGIS_Plugin#Usage| Back to TUFLOW QGIS Plugin Main Page]]
}}

File:ARR dialog climate change 01b.png

2025-02-12T09:28:43Z

ElizaCollison:

1D Pits

2025-02-11T16:36:02Z

ElizaCollison:

=Introduction=
There are predominantly two types of stormwater pits (drains/gullies) used as inlets to collect overland runoff and transfer that water to the underlying drainage/culvert/pipe network;
* Grated inlets
* Kerb Inlets (side entry pits / lintel inlets).
This page of the Wiki describes how pit inlet data is incorporated into a TUFLOW model.

= Pit Inlet Types =
{|class="wikitable"
|-
! Inlet Type !! Example !! Description !! Dimensioned Example
|-
! Q
| [[File:Q pit inlet.jpg|thumb|none|300px|Depth-Discharge Pit or Channel]] || Depth-Discharge Pit or Channel, pit inlet inflow information is defined within TUFLOW via a user-defined Pit Inlet Database and associated pit inlet curves. This approach allows for unlimited flexibility. Any pit design or configuration can be incorporated into a TUFLOW model if the inlet depth-discharge relationship is known. || [[1D_Pits#TUFLOW_Model_Inputs | See TUFLOW Model Inputs]]
|-
! R
| [[File:Side_Entry_pit.jpg|thumb|none|300px|Kerb Inlet]]
|| Kerb inlets, also known as side entry pits or lintels, are common in Australia. The pit chamber can vary depending on overall depth, length, and the addition of any haunched riser units. 
Width_or_Dia: Sets the width of the pit inlet section in the vertical plane. 
Height_or_WF: Sets the height of the pit inlet channel in the vertical plane.
|| [[File:Side entry pit dimensions.jpg|300px|thumb|none|Kerb Inlet with dimensions]]
|-
! C
| [[File:Circular pit inlet.jpg|thumb|none|300px|Circular Pit Inlet]]
|| Circular pit inlet. 
Width_or_Dia: Sets the diameter of the pit inlet cross-section in the vertical plane. 
Height_or_WF: Not used.
|| [[File:Circular pit inlet dimensions.jpg|300px|thumb|none|Circular Pit Inlet with dimensions]]
|-
! W
| [[File:Gully pit.jpg|thumb|none|300px|Grate (London, UK)]]
|| Grates, also known as Gully Pits, are common in the United Kingdom and are generally a square grate on top of a circular chamber and a riser outlet. The outlet will then feed into a larger culvert that forms part of the larger urban drainage network. 
Width_or_Dia: Sets the width of the pit inlet section in the vertical plane. The width is the total width in the direction of flow to the pit. For example, a gully pit may include all sides of the pit whereas an on grade pit may only include one. 
Height_or_WF: Not used. 
|| [[File:Gully pit dimensions.jpg|300px|thumb|none|Grate with dimensions]]
|}

= Pit Inlet Data Sources =
Pit inlet depth-discharge data can be obtained from a variety of sources. The most common typically being from suppliers or local agencies who enforce consistent design standards within their jurisdiction. For demonstration purposes, examples from Sutherland Shire Council and Brisbane City Council are provided below.

== Sutherland Shire Council ==
The Sutherland Shire Council Urban Drainage Manual (1992) includes summary tables and graphs documenting pit grate and lintel capacity information (derived from Department of Main Roads testing). The guidelines are compatible with the standard pit grate and lintel design shown below: 
[[File: Pit_Inlet_Curves_SSC000.JPG|700px]] 
The capacity of a pit depends on three factors:
* The clear opening area of the grate
* The depth of water ponding over the grate
* The length of kerb inlet (lintel) opening
The following graphs summarise grate and lintel discharge estimates for a range of water depths and blockage factors, derived from the Sutherland Shire Council design standards. 
[[File: Pit_Inlet_Curves_SSC001.JPG|700px]]
[[File: Pit_Inlet_Curves_SSC002.JPG|700px]] 

The above graphs estimate unit length and area flow estimates. These unit values can be multiplied by real pit dimensions to define at site depth-discharge characteristics.

TUFLOW modelling requires the derivation of a unique depth-discharge curve for each pit type within the modelled area. An example is provided below for a single pit location. 

[[File: Pit_Inlet_Curves_SSC003.JPG|700px]]

== Brisbane City Council==
The pit inlet curve examples below originate from Brisbane City Council 8000 series standard drawings: https://www.brisbane.qld.gov.au/planning-building/planning-guidelines-tools/planning-guidelines/standard-drawings 
[[File: BCC_BSD-8077.JPG|border|700px]]
[[File: BCC_BSD-8051.JPG|border|700px]] 
[[File: BCC_BSD-8082.JPG|border|700px]]
[[File: BCC_BSD-8052.JPG|border|700px]] 

== South Australian Road Stormwater Drainage Inlets: Hydraulic Study (University of South Australia)==
The Urban Water Resources Centre (UWRC) at the University of South Australia conducted a comprehensive set of hydraulic studies, examining performance of the most common roads’ stormwater drainage inlets in use in South Australia. The study was carried out using the Centre's unique full-scale road surface drainage test rig. Links to the pipe inlets curves are provided in the following link and sections below: [https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/ Hydraulic Study (University of South Australia)]
=== Transport South Australia ===
[https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/transport-sa/ Transport South Australia Pit Inlet Curves]
=== City of Adelaide ===
[https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/city-of-adelaide/ City of Adelaide Pit Inlet Curves]
=== City of Campbelltown ===
[https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/city-of-campbeltown/ City of Campbelltown Pit Inlet Curves]
=== City of Charles Sturt ===
[https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/city-of-charles-sturt/ City of Charles Sturt Pit Inlet Curves]
=== City of Onkaparinga ===
[https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/city-of-onkaparinga/ City of Onkaparinga Pit Inlet Curves]
=== City of Playford ===
[https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/city-of-playford/ City of Playford Pit Inlet Curves]
=== City of Port Adelaide / Enfield ===
[https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/city-of-port-adelaideenfield/ City of Port Adelaide / Enfield Pit Inlet Curves]
=== City of Marion ===
[https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/city-of-marion/ City of Marion Pit Inlet Curves]
=== City of Mitcham ===
[https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/city-of-mitcham/ City of Mitcham Pit Inlet Curves]
=== City of Salisbury ===
[https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/city-of-salisbury/ City of Salisbury Pit Inlet Curves]
=== City of Tea Tree Gully ===
[https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/city-of-tea-tree-gully/ City of Tea Tree Gully Pit Inlet Curves]
=== City of West Torrens ===
[https://www.unisa.edu.au/research/sustainable-infrastructure-and-resource-management/australian-flow-management-group/stormwater-drainage-hydraulic-study/city-of-west-torrens/ City of West Torrens Pit Inlet Curves]

== Spacing of Road Gullies (UK standards: BS EN 124 and BS7903) ==
The following section describes the [https://www.standardsforhighways.co.uk/tses/attachments/a869ed8e-4470-4286-aef4-7d11af24a597 Spacing of Road Gullies] guidance (UK standards: '''BS EN 124''' and '''BS 7903''') which provides a method for determining road gulley capture rates.

The method depends on the following '''Hydraulic parameters:'''
* Longitudinal gradient, ''SL'', along the length of the scheme (expressed as fraction).

* Cross-fall, ''Sc'' (also expressed as a fraction).

* Manning’s roughness coefficient, ''n''. Usually ''n'' = 0.017 for a conventional road surface. Other values are given in the following '''Table 1'''. (For more details, please see Section: 5, Table 5.3N of the [https://www.standardsforhighways.co.uk/tses/attachments/a869ed8e-4470-4286-aef4-7d11af24a597 guidance]).

'''Table 1:''' Values of Manning's ''n''
 [[File:Table1N.jpg|750px|]] 

* The grating type (P, Q, R, S or T), or the size and angle of kerb inlet.

* The maximum allowable flow width (as shown below by ''B'' in m) against the kerb.
 [[File:Figures 1 2.jpg|850px|]] 

'''Calculation of Gully Flow Capture Rates based on Equations'''
 The equations given in Appendix C (p.g: 25) of the [https://www.standardsforhighways.co.uk/tses/attachments/a869ed8e-4470-4286-aef4-7d11af24a597 guidance] can be used to determine flow capture rates at different depths, to determine the depth-discharge curve for use within TUFLOW. The method requires the calculations of the flow capacity of the kerb channel and flow collection efficiency of the gully grate.
*As a first step, a gully grate type: P, Q, R, S or T should be selected. The selection of the grating type will determine the design value ''Gd'' (grating parameter) from '''Table 2'''. (For more details, please see Table A.2, Appendix A of the [https://www.standardsforhighways.co.uk/tses/attachments/a869ed8e-4470-4286-aef4-7d11af24a597 guidance]).

'''Table 2:''' Determination of grating type ''Gd''
 [[File:Determination of grating type.jpg|650px|]] 

*Road (longitudinal) gradient (''SL''), Crossfall (''Sc'') and Manning's (''n'') should then be determined. Parameter values can be obtained from '''Table 3'''.

'''Table 3:''' Determination of ''SL'', ''Sc'' and Manning's ''n''
 [[File:Table SL SC N Range.jpg|750px|]] 

*Further, a Water Depth against the kerb ''H'' (m) range should be provided. (Please note: The depth range can be changed, but the following equations that are used to calculate the flow capacity are only valid up to the kerb height).

*With the above parameters, the calculations of the i) Flow width (''B'' in m), ii) Cross-sectional area (''Af'' in m2), iii) Hydraulic radius (''R'' in m), iv) Flow rate (''Q'' in m3/s) and v) Flow collection efficiency (''ŋ'' (%)) based on the Equations C.1-C.5 which are presented in Appendix C of the [https://www.standardsforhighways.co.uk/tses/attachments/a869ed8e-4470-4286-aef4-7d11af24a597 guidance] can be completed.

*Finally, the resulting depth-discharge data can be used in the TUFLOW pit inlet curves. 

The Gully Flow Capture Rates template [https://downloads.tuflow.com/Other/Inlet_Spreadsheets/Gully%20Flow%20Capture%20Rates_v3.xlsx here], includes a calculation tab which can be used for the completion of the above calculation processes. Based on calculations and Equations C.6 and C.7 of the [https://www.standardsforhighways.co.uk/tses/attachments/a869ed8e-4470-4286-aef4-7d11af24a597 guidance] the maximum allowable spacings upstream of the gully can be further calculated (For more details, please see Appendix C, p.g: 25).

'''Key assumption''' '''Note:''' This method assumes that the route the flow takes around the trap limits the discharge from the gully pot to 10 l/s. This limit is effective in both directions, so any negative head on the gully would create -10 l/s flow back up through the gully and flood onto the road. 

== UK Water Industry Research (UKWIR) Inlet Capture Tool ==
In 2023, the UK Water Industry Research (UKWIR) Limited released the Modelling Sewer Inlet Capacity Restrictions Report [https://ukwir.org/modelling-sewer-inlet-capacity-restrictions Modelling Sewer Inlet Capacity Restrictions Report]. The main aim was to develop a sewer modelling methodology to enable the representation of inlet inflow restrictions, focusing on the development of a new 1D model approach to provide more accurate model sewer flooding predictions. The new modelling approach has been devised by combining the findings from a literature review and the development of semi-empirical relationships from academic studies which investigated factors affecting inlet capacity. The new approach allows for 2 types of gully response reflecting 2 flow conditions: Subcritical flow on a shallow road gradient and Supercritical flow on a steep road gradients. A threshold of 0.02 is used to distinguish between shallow and steep road gradients. The reported equations can be used for the production of input inlet curves for TUFLOW 1D pit inlet modelling.

A template for the generation of the UKWIR Inlet Curve can be downloaded from [https://downloads.tuflow.com/Other/Inlet_Spreadsheets/Inlet%20Curve%20Capture%20tool%20v4.xlsx here]. The template determines both Subcritical Head-Discharge and Supercritical Head-Discharge relationships obtained from the Modelling Sewer Inlet Capacity Restrictions Report based on user input values of water depth (in metres). Two sets of curves can be generated, curves based on default parameters, and those based on user-defined parameters. Note, the report is not clear what inlet capacity cap should be applied, so these are not applied within the spreadsheet currently. However, the user can edit the resulting Head-Discharge relationship to apply a required cap on the inlet capacity.

=TUFLOW Model Inputs=
The steps required to represent pit inlet information within a TUFLOW model is summarised below:
<ol>
<li> Import an empty 1d_nwk GIS file from the TUFLOW file template folder (model\gis\empty).
<li> Digitise points to represent pit locations. The points should be snapped to the start or end of 1d_nwk line features that define the underground pipe network.
<li> Update the field attributes for each Pit point. Refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. The most commonly used attributes are:
* Type = Q (C, R and W are also options if pit inlets based on structure dimension is required instead of using a Pit Inlet Database approach).
* US_Invert = Used to specify the ground elevation of the pit. If Conn_1D_2D is set to “SXL”, US_Invert is used as the amount by which to lower the 2D cell and the pit channel invert is set to this level.
* DS_Invert = The bottom elevation of the pit. This input can also be used to set the upstream and downstream inverts of connected pipes/channels.
* Inlet_Type = For Q pit channels, the name of a pit inlet type in the Pit Inlet Database. Multiple Pits can use the same Inlet_Type ID if they have the same design dimensions.
* Conn_1D_2D = SXL can be specified to connect the 1D pit or node to the 2D domain and lower the 2D cell by the amount of the US_Invert attribute. The invert of the pit channel is set to the lowered 2D cell level. This is useful to help trap the water into the pit as it flows overland in the 2D domain. This feature works well in combination with the new Read GIS SA PITS option.
<li> Update the Estry Control File (*.ecf) to include reference to the new 1d_nwk GIS file. 
<tt>Read GIS Network</tt> <tt>==</tt><tt>..\model\mi\Estry\1d_nwk_****.MIF</tt> 
<li> Create a Pit Inlet Database csv file. This file lists each type of pit (matching the names listed in the 1d_nwk "Inlet_Type" field). It also provides reference to the depth-discharge curve information. 
[[File:M05 pit inlet dbase 01.png]]
<li> Create the Source file referenced in the Pit Inlet Database. The source file defines the depth-discharge information for each pit (determined from the relevant design standards). The column headers must match the entries in the Pit Inlet Database. 
[[File:M05 pit inlet v2.png]]
<li> Update the Estry Control File (*.ecf) to include reference to the Pit Inlet Database. 
<tt>Pit Inlet Database</tt> <tt>==</tt><tt>..\pit_dbase\EG_pit_dbase.csv</tt> 
</ol>

An example model including Pits is available for download: https://wiki.tuflow.com/index.php?title=TUFLOW_Example_Models

==Pit Search Distance==
Some agency pit datasets may not have all pit point features snapped to the associated pipe line features. The *.ecf command "Pit Search Distance" can be useful in this instance. It automatically connects floating nodes to the 1D pipe network where connectors are not snapped to channel ends: 

<tt>Pit Search Distance</tt> <tt>==</tt><tt>xxx</tt> 
<tt>Read GIS Network</tt> <tt>==</tt><tt>..\model\mi\1d_nwke_*****.MIF</tt> 
 
The order of the "Pit Search Distance" command is important as it can be repeated multiple times with different values that are assigned to the 1d_nwke(s) below the ''Pit Search Distance'' command. The pit search command should be included above the the GIS layer containing the pits.

To check if the ''Pit Search Distance'' is working as expected, import the [[Check_Files_1d_nwk_C | *_nwk_C_check]] file to visually see if the pits are automatically connecting to a culvert. The image below is an example of the *_nwk_C_check file and the connections TUFLOW has made to each pit. 

 
[[File:Pit_search_distance_check.JPG|border|500px]]

 
Any further questions please email TUFLOW support: [mailto:support@tuflow.com?Subject=TUFLOW%201D%20pits%20help support@tuflow.com]
 
{{Tips Navigation
|uplink=[[ TUFLOW 1D Channels and Hydraulic Structures | Back to 1D Channels and Hydraulic Structures]]
}}

TUFLOW Message 2835

2025-02-07T07:15:07Z

ElizaCollison:

{{TUFLOW_Message
|tuflow_message=ERROR 2835 - Not expecting point for bc type: "<>".
|alt_msg=ERROR 2835 - Not expecting line for bc type: "<>". 
ERROR 2835 - Not expecting region for bc type: "<>". 

|type=[[ERROR]]
|message_desc=Not expecting point / line / region for BC type: "<>". A point / line / region is not valid for the boundary condition (BC) type "<>".
 
From the 2023-03 release, a point-type QT boundary is not supported when using TUFLOW Classic / HPC (bringing the behaviour in line with Quadtree).
|suggestions=*Refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] for information on the BC type "<>" and its specifications.
*If a QT point was intended to be used as an internal inflow boundary, transitioning to a 2d_sa setup is recommended. For an external boundary, the preferred approach is to use a 2d_bc QT line snapped to the code polygon.

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
}}

TUFLOW Message 2835

2025-02-07T07:12:51Z

ElizaCollison:

{{TUFLOW_Message
|tuflow_message=ERROR 2835 - Not expecting point for bc type: "<>".
|alt_msg=ERROR 2835 - Not expecting line for bc type: "<>". 
ERROR 2835 - Not expecting region for bc type: "<>". 

|type=[[ERROR]]
|message_desc=Not expecting point / line / region for BC type: "<>". A point / line / region is not valid for the boundary condition (BC) type "<>".
 
From the 2023-03 release, a point-type QT boundary is not supported when using TUFLOW Classic / HPC (bringing the behaviour in line with Quadtree).
|suggestions=*Refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] for information on the BC type "<>" and its specifications.
*If a QT point was used as an internal inflow boundary before the 2023-03 release, transitioning to a 2d_sa setup is recommended. For an external boundary, the preferred approach is to use a 2d_bc QT line snapped to the code polygon.

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
}}

Check Files 2d zsh zpt

2025-02-04T06:58:04Z

ElizaCollison:

The '''_2d_zsh_zpt''' or '''_2d_zsh_zpt_P''' is only created if a "<tt>Read GIS Z Shape ==</tt>" command has been specified in the model. This file contains information on all the elevations points (zpts) that have been altered by the <tt>Read GIS Z Shape </tt> commands. 
 
'''Attributes of _zsh_zpt check file''' 
{| align="center" class="wikitable" width="75%"

! style="background-color:#005581; font-weight:bold; color:white;"| Attribute Name
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Attribute Description
|-
| dZ || The amount by which the elevation has been changed by the Z Shape. A positive value indicates that the elevation has been increased by the GIS layer and a negative value indicates that the elevation has been lowered. For example a value of 0.3 would indicate that elevation point has been raised by 0.3 (metres or feet if running in US Customary units.)
|-
| Elevation (ZExact if SGS is used) || The elevation within the cell. If SGS is used, the elevation at the exact location of the cell centre, face mid-point, or cell corner.
|-
| dZMin (only if SGS is used) || The change in minimum elevation inside cells, along faces or at corners.
|-
| ZMin (only if SGS is used) || Minimum elevation within the cell.
|-
| Source || The path to the GIS layer which has caused the elevation point to be modified.
|}

'''Note: ''' More than one Z shape layer can modify the same elevation point. For example, if two separate breaklines layers are applied which intersect, then the later occurrence in the TUFLOW Geometry control file (.tgc) is given preference. Multiple objects within a single GIS layer may also modify the same elevation point (zpt), for example overlapping polygons. In the _zsh_zpt check file, a separate reporting point is created for each modification to a zpt's elevation from all objects, in all Z Shape layers. If there are multiple modifications to an elevation point, the dz value is the most recent change from the last assigned elevation. For example, if an elevation point starts with an elevation of 10.0, which is raised to 12.0 (dz = 2.0), before being raised to 12.5 by a second Z Shape layer, the dz reported for the second layer will be 0.5 and not 2.5 (i.e. compared to the base elevation). Where a zpt has been modified multiple times, the _zsh_zpt check file will include multiple objects at the same zpt location that details each change from the previous elevation. The final elevations are reported in the [[Check_Files_2d_zpt | 2d_zpt check file]].

In QGIS, with default [[QGIS_TUFLOW_Styles | TUFLOW styles]] symbology applied, this layer has five styles:
* A red triangle pointing up indicates that the zpt has been raised my more than 1.00
* A orange triangle pointing up indicates that the zpt has been raised my 0.01 - 1.00
* A grey circle indicates that no change has occurred (for example, a Z Shape with the shape option "Max", which is below the existing elevation)
* A light blue triangle pointing down indicates that the zpt has been lowered by 0.01 - 1.00
* A blue triangle pointing down indicates that the zpt has been lowered by more than 1.00

These can be seen in the image below: 
 
[[File: 2d_zsh_zpt_symbology_01.png]] 
 

{{Tips Navigation
|uplink=[[TUFLOW_Check_Files | TUFLOW Check Files]]
}}

TUFLOW Message 2445

2025-02-03T11:56:10Z

ElizaCollison:

{{TUFLOW_Message
|tuflow_message=ERROR 2445 - Invalid (NaN) ZU value
|alt_msg=ERROR 2445 - Invalid (NaN) ZV value 
ERROR 2445 - Invalid (NaN) ZH value 
ERROR 2445 - Invalid (NaN) ZC value 
WARNING 2445 - Invalid (NaN) ZU value 
WARNING 2445 - Invalid (NaN) ZV value 
WARNING 2445 - Invalid (NaN) ZH value 
WARNING 2445 - Invalid (NaN) ZC value 
|type=[[ERROR]] [[WARNING]]
|message_desc=An ERROR (2012-05 TUFLOW release) or a WARNING (if Defaults==pre-2012) is issued if a final zpt elevation is found to be invalid or NaN.
|suggestions=The _messages.mif or _messages_P.shp contains the location of the issue. Review the inputs in the location and check the elevation data is valid. If this error is triggered by 'NaN' being set for no data values, it is possible to update no data values using the [[ASC_to_ASC#Convert | asc_to_asc utility]] (from the asc_to_asc.2024-06-AE version and onwards).

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]

}}

TUFLOW Message 2445

2025-02-03T11:40:04Z

ElizaCollison:

{{TUFLOW_Message
|tuflow_message=ERROR 2445 - Invalid (NaN) ZU value
|alt_msg=ERROR 2445 - Invalid (NaN) ZV value 
ERROR 2445 - Invalid (NaN) ZH value 
ERROR 2445 - Invalid (NaN) ZC value 
WARNING 2445 - Invalid (NaN) ZU value 
WARNING 2445 - Invalid (NaN) ZV value 
WARNING 2445 - Invalid (NaN) ZH value 
WARNING 2445 - Invalid (NaN) ZC value 
|type=[[ERROR]] [[WARNING]]
|message_desc=An ERROR (2012-05 TUFLOW release) or a WARNING (if Defaults==pre-2012) is issued if a final zpt elevation is found to be invalid or NaN.
|suggestions=The _messages.mif or _messages_P.shp contains the location of the issue. Review the inputs in the location and check the elevation data is valid. If this error is triggered by 'NaN' being set for no data values, it is possible to update no data values using the asc_to_asc utility (from the asc_to_asc.2024-06-AE version and onwards).

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]

}}

QGIS Installation with OSGeo4W

2025-01-30T14:43:40Z

ElizaCollison:

=Installation Steps=
<ol>
<li> Download OSGeo4W setup installer
:[https://qgis.org/en/site/forusers/download.html https://qgis.org/en/site/forusers/download.html] 
: [[File:Osgeo4w download network installer.png|alt=|873x873px]]
<li> Run the downloaded EXE
<li> Select '''Advanced Install'''
: [[File: osgeo4w_installation_1.PNG]]
<li> Select '''Install from Internet'''
: [[File: osgeo4w_installation_2.PNG]]
<li> Select a directory and other installation options (Note some options may require admininstrator rights)
: [[File: osgeo4w_installation_3.PNG]]
<li> Click '''Next'''
: [[File: osgeo4w_installation_4.PNG]]
<li> Select '''Direct Connection''' (Note some firewall systems will require proxy settings)
: [[File: osgeo4w_installation_5.PNG]]
<li> Select a download site. It is recommended to use with one with an SSL certificate (i.e. starts with https://)
: [[File: osgeo4w_installation_6.PNG]]
<li> Use the search bar to search for "QGIS". Expand the '''Desktop''' dropdown and find "qgis: QGIS Desktop" under the '''package''' column. Left-click the "skip" text and the text will change to the latest version number. Once the version number is showing, this will be the version installed when you proceed. If you left-click again, the version number may change again to the previous version. If you keep left-clicking it will cycle back to "skip". (Note: you could also choose the "qgis-ltr: QGIS Desktop (long term release)" instead, and this would install the long term release version).
: [[File: osgeo4w_installation_7.PNG]]
<li> The installation also requires manually choosing several Python libraries. Use the search bar again and search for "scipy". Expand the '''Libs''' dropdown and find "python3-scipy". Left-click the "skip" text once to choose the latest scipy library version.
: [[File: osgeo4w_installation_8.PNG]]
<li> The following python libraries should be added:
* scipy
* matplotlib
* netcdf4
* pandas
* pyarrow
* fiona
* geopandas
* rtree
* shapely
<li> Click '''Next'''
<li> Continue to work through the steps of the installation process - the installer will ask you to also install a number of dependencies (make sure to click yes to these) and prompt for license agreements
<li> Once installed, QGIS should be installed in the location specified in an earlier step
</ol>
 
 
=Upgrading Steps=
<ol>
<li> As part of the installation, OSGeo4W should install a program called "setup" which you can search in the Windows start bar. You can also run the downloaded OSGeo4W installer again (they are the same).
<li> Once running the setup, simply continue clicking '''Next'''. The setup should remember all your previous settings and automatically choose the latest version of the installed libraries at the '''Packages Selection''' stage of the installation
</ol>
 
==Upgrading Silently==
It's possible to upgrade silently from the Windows CMD prompt or from a batch file. 
 
===From CMD===
<ol>
<li> Search "osgeo4w" in the Windows start bar and choose '''OSGeo4W Shell'''
<li> Type the following command and press enter
<pre>setup -q -g</pre>
: <tt>"-q"</tt> : quiet installation flag
: <tt>"-g"</tt> : upgrade installed packages flag
</ol>
 
===From BAT===
<ol>
<li> In the OSGeo4W installation folder under the "bin" folder find the following batch file "o4w_env.bat" (e.g. "C:\OSGeo4W\bin\o4w_env.bat").
<li> In your batch file call the "o4w_env.bat" file
<li> On the next line, type "setup -q -g"
: <tt>"-q"</tt> : quiet installation flag
: <tt>"-g"</tt> : upgrade installed packages flag
<li> Your final batch file should look like the below with the path to "o4w_env.bat" customised to match your installation
<pre>
call C:\OSGeo4W\bin\o4w_env.bat
setup -q -g
</pre>
<li> Run the batch file
</ol>
 
 
{{Tips Navigation
|uplink=[[QGIS_Tips| Back to QGIS Tips page]]
}}

Main Page

2025-01-23T15:11:02Z

ElizaCollison:

__NOTOC__
[[File:TUFLOWNewLogo.jpg|250px|link=https://tuflow.com/|left|top|target="_blank"]][[File:BMT logo (PowerPoint) Logo Only.png|200px|link=https://www.bmt.org//|right]]
<center style=font-size:290%;color:#005581;background: white>TUFLOW Wiki Homepage</center> 
This Wiki contains information relating to the flood and coastal simulation software TUFLOW Classic and TUFLOW HPC (Heavily Parallelised Compute). It is designed to be used in conjunction with the TUFLOW [https://docs.tuflow.com/classic-hpc/manual/latest/ Manual] and [https://www.tuflow.com/ Website] 

{|style="width:100%; border-spacing:8px; margin:0px 0px;"


|style="width:35%; border:1px solid #005581; vertical-align:top; color:#000; background:#B5CBDF;"|
{|width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; background:#B5CBDF;"
! <h2 style="margin:0; background:#005581; font-size:120%; font-weight:bold; border:1px solid #005581; text-align:left; color:white; padding:0.2em 0.4em;">TUFLOW Set-up and use</h2>
|-
||
[[File:Wiki Homepage Start Here v2.PNG||150px|right]]
'''TUFLOW'''
* [[New_User_Installation_Guide| How to install TUFLOW]]
* [[TUFLOW_Licensing | How to configure a licence]]
* [[Running_TUFLOW | How to run a TUFLOW model]]
* [[TUFLOW_Utilities | Free processing utilities]]
* [[TUFLOW_Viewer | Result Viewing - TUFLOW Viewer]]

'''TUFLOW Benchmarks''' 
* [[TUFLOW_Benchmarking | TUFLOW Solution Accuracy Benchmarks]]
* [[Hardware_Benchmarking_(2018-03-AA) | Computer Hardware Speed Benchmarks]]

'''Best Practice Guidance''' 
* [[TUFLOW_Modelling_Guidance | TUFLOW Modelling Guidance]]
* [https://tuflow.com/library/videos Modelling Videos]
* [https://tuflow.com/library/webinars Expert Webinars]

|}


|style="width:65%; border:1px solid #005581; vertical-align:top; color:white; background:#B5CBDF;"| 
{|width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; background:#B5CBDF;"
! <h2 style="margin:0; background:#005581; font-size:120%; font-weight:bold; border:1px solid #005581; text-align:left; color:white; padding:0.2em 0.4em;">Tutorial Models</h2>
|-
||
{|
|style="width:40% vertical-align:top; color:#000; background:#B5CBDF; padding:0em 1em;"|
'''TUFLOW / ESTRY''' 
* [[Tutorial_Introduction| TUFLOW Tutorials Introduction]]
* [[Tutorial_M01|Module 1]] - 2D Base Model
* [[Tutorial_M02|Module 2]] - Topography Update
* [[Tutorial_M03|Module 3]] - 1D Culverts
* [[Tutorial_M04|Module 4]] - 2D Bridges
* [[Tutorial_M05|Module 5]] - Pipe Network
* [[Tutorial_M06|Module 6]] - Direct Rainfall
* [[Tutorial_M07|Module 7]] - Quadtree
* [[Tutorial_M08|Module 8]] - Scenario Management
* [[Tutorial_M09|Module 9]] - Event Management
* [[Tutorial_M10|Module 10]] - Dam Break
* [[Tutorial_M11|Module 11]] - 1D Open Channel
 
|style="width:60%; vertical-align:top; horizontal-align:right; color:#000; background:#B5CBDF; padding:0em 1em;"|
'''TUFLOW / EPA SWMM''' 
* [[TUFLOW_SWMM_Tutorial_Introduction| TUFLOW SWMM Tutorials Introduction]]
*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D Culverts
*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - Pipe Network / Direct Rainfall
*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - Pipe Network / Urban Hydrology
*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - Event Management
*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW]] - Model Conversion
 
'''TUFLOW / Flood Modeller''' 
* [[Flood_Modeller_Tutorial_Model| TUFLOW Flood Modeller Tutorials Introduction]]
* [[Flood_Modeller_Tutorial_Module01|FM Module 1]] - Linking Flood Modeller to TUFLOW
* [[Flood_Modeller_Tutorial_Module02|FM Module 2]] - Linking Flood Modeller to ESTRY
|}
|}


|}

{|style="width:100%; border-spacing:8px; margin:0px 0px;" 

|style="width:50%; border:1px solid #005581; vertical-align:top; color:#000; background:#B5CBDF;"|
{|width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; background:#B5CBDF;"
! <h2 style="margin:0; background:#005581; font-size:120%; font-weight:bold; border:1px solid #005581; text-align:center; color:white; padding:0.2em 0.4em;">Downloads</h2>
|-
||
<gallery mode="packed-overlay" widths=130px heights=90px color:red>
Image:Wiki_Homepage_TUFLOW_icon_001.PNG|[https://www.tuflow.com/downloads/ TUFLOW DOWNLOAD]
Image:Wiki Homepage TUFLOW Changelog 001.png|[https://docs.tuflow.com/classic-hpc/changelog/ TUFLOW CHANGELOG]
Image:Wiki Homepage TUFLOW Manual 2025 001.png|[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW MANUAL]
</gallery>
|-
||
<gallery mode="packed-overlay" widths=130px heights=90px color:red>
Image:Wiki_Homepage_CATCH_icon_001.PNG|[https://www.tuflow.com/downloads/#tuflow_catch CATCH DOWNLOAD]
Image:Wiki_Homepage_CATCH_Manual_001.PNG|[https://docs.tuflow.com/catch/latest/ CATCH MANUAL]
</gallery>
|-
|}


|style="width:50%; border:1px solid #005581; vertical-align:top; color:white; background:#B5CBDF;"| 
{|width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; background:#B5CBDF;"
! <h2 style="margin:0; background:#005581; font-size:120%; font-weight:bold; border:1px solid #005581; text-align:left; color:white; padding:0.2em 0.4em;">TUFLOW Troubleshooting</h2>
|-
||
{|
|style="width:50% vertical-align:top; color:#000; background:#B5CBDF; padding:0em 1em;"|
'''Error/Warning Message Database'''
* [[TUFLOW_Messages|About This Database]]
* [[0xxx TUFLOW Messages]]
* [[1xxx TUFLOW Messages]]
* [[2xxx TUFLOW Messages]]
* [[3xxx TUFLOW Messages]]
* [[4xxx TUFLOW Messages]]
* [[5xxx TUFLOW Messages]]
* [[6xxx TUFLOW Messages]]
* [[TUFLOW_Check_Files|TUFLOW Check Files]]
* [mailto:support@tuflow.com support@tuflow.com]
|style="width:50%; vertical-align:top; horizontal-align:right; color:#000; background:#B5CBDF; padding:0em 1em;"|
[[File:Wiki Homepage Health.PNG|150px]]
[[File:Wiki_Homepage_Blackboard_v2.PNG||200px]]
|}
|}

|}

{|style="width:100%; border-spacing:8px; margin:0px 0px;" 

|style="width:50%; border:1px solid #005581; vertical-align:top; color:#000; background:#B5CBDF;"|
{|width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; background:#B5CBDF;"
! <h2 style="margin:0; background:#005581; font-size:120%; font-weight:bold; border:1px solid #005581; text-align:left; color:white; padding:0.2em 0.4em;"> Tips and Tricks</h2>
|-
||
{|
|style="width:50%; vertical-align:top; color:#000; background:#B5CBDF; padding:0.2em 0.4em;"|
'''Text Editor/Spreadsheet Software''' 
* [[Excel_Tips | Excel]]
* [[NotepadPlusPlus_Tips | Notepad ++]]
* [[TextPad_Tips | TextPad]]
* [[UltraEdit_Tips | UltraEdit]]
* [[VS_Code_Tips | Visual Studio Code]]
'''GIS Software''' 
* [[12D_Model | 12D Model]]
* [[ArcGis_Tips | ArcGIS]]
* [[Ensight_Tips | Ensight]]
* [[GeoRiver_Tips|GeoRiver]]
* [[Google_Earth_Tips | Google Earth]]
* [[MapInfo_Tips | MapInfo]]
* [[QGIS_Tips | QGIS]]
* [[SCALGO_Live_Tips | SCALGO Live]]
* [[SMS_Tips | SMS]]
* [[SAGA_Tips | SAGA]]
|style="width:50%; vertical-align:top; color:#000; background:#B5CBDF; padding:0.2em 0.4em;"|
'''Model Conversions''' 
* [[EPA_SWMM_to_TUFLOW | EPA SWMM to TUFLOW]]
* [[FLO2D_to_TUFLOW | FLO2D to TUFLOW]]
* [[Flood_Modeller_to_TUFLOW | Flood Modeller to TUFLOW]]
* [[HEC-RAS_to_TUFLOW | HEC-RAS to TUFLOW]]
* [[InfoWorks_ICM_to_TUFLOW | InfoWorks ICM to TUFLOW]]
* [[MIKE_Flood_to_TUFLOW | MIKE Flood to TUFLOW]]
* [[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW]]

'''Other''' 
* [[DOS_Window_Tips | DOS Window]]
* [[Windows_Tips|Windows]]
* [[TUFLOW_Utilities | TUFLOW Utilities]]
* [[Hardware_Selection_Advice | Hardware Selection Advice]]
* [[Flood Modeller-TUFLOW Linking| Flood Modeller-TUFLOW Linking]]
* [[TUFLOW_QGIS_Plugin | QGIS TUFLOW Plugin]]
* [[TUFLOW_Viewer | TUFLOW Viewer]]
* [[PyTuflow|PyTuflow]]
* [[GDAL_Tips_and_Tricks|GDAL]]
|-
|}

|}

|style="width:50%; border:1px solid #005581; vertical-align:top; color:white; background:#B5CBDF;"| 
{|width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; background:#B5CBDF;"
! <h2 style="margin:0; background:#005581; font-size:120%; font-weight:bold; border:1px solid #005581; text-align:left; color:white; padding:0.2em 0.4em;">Demo/Example Models</h2>
|-
||
{|
|style="width:40% vertical-align:top; color:#000; background:#B5CBDF; padding:0em 1em;"|
'''TUFLOW HPC Example Models''' 
The [[TUFLOW_Example_Models| Example Models]] are a set of 157 standalone models that demonstrate some of the most widely used features of TUFLOW. They are separated into the following categories: 
* [[TUFLOW_Example_Models#Project Initiation| Project Initiation]]
* [[TUFLOW_Example_Models#Model Units| Model Units]]
* [[TUFLOW_Example_Models#Solver Options| Solver Options]]
* [[TUFLOW_Example_Models#Output Options| Output Options]]
* [[TUFLOW_Example_Models#Boundary Condition Options| Boundary Condition Options]] (Inflows, Outflows, Losses)
* [[TUFLOW_Example_Models#Topography Features| Topography Features]] (Static and Dynamic, Sub-Grid Sampling)
* [[TUFLOW_Example_Models#Structures| Structures]] (Bridges, Weirs, Culverts, Operational Controls)
* [[TUFLOW_Example_Models#Multiple Domain Model Design| Multiple Domain Model Design]] (2D/2D, 1D open channel and pipe network / 2D)
* [[TUFLOW_Example_Models#Bulk Simulation Management| Bulk Simulation Management]]
* [[TUFLOW_Example_Models#Advection Dispersion| Advection Dispersion]]
* [[TUFLOW_Example_Models#Advection Dispersion| Non-Newtonian]]

|style="width:60%; vertical-align:top; horizontal-align:right; color:#000; background:#B5CBDF; padding:0em 1em;"|
'''Floodplain Management Association Challenge Models''' 
The following models were created as part of the Floodplain Management Association 2012 Annual Conference 2-D Modelling Challenge:
* [[FMA_Challenge_Models_Introduction | FMA Challenge Models Introduction]]
* [[FMA Challenge 1 (1D-2D linked)|FMA Challenge 1]] (FMA Challenge 1D-2D linked)
* [[FMA Challenge 2|FMA Challenge 2]] (2D only)
* [[FMA Challenge 3|FMA Challenge 3]] (1D-2D, including infiltration)

'''TUFLOW CATCH Models''' 
TUFLOW CATCH enables simulation of whole-of-catchment hydrologic, hydraulic, pollutant export and receiving waterway processes. It supports 1D, 2D and 3D simulation of these processes from the top of catchment to the receiving waterway outlet using a dynamically linked TUFLOW HPC / FV modelling framework:
* [[TUFLOW_CATCH_Demo_Models | Hydrology configuration]]
* [[TUFLOW_CATCH_Demo_Models | Pollutant export configuration]]
* [[TUFLOW_CATCH_Demo_Models | Integrated configuration]]
|}
|}

|}
{{NUMBEROFARTICLES}} pages have been created

File:Wiki Homepage TUFLOW Manual 2025 001.png

2025-01-23T15:10:02Z

ElizaCollison:

File:Wiki Homepage TUFLOW Changelog 001.png

2025-01-23T15:09:12Z

ElizaCollison:

TUFLOW Message 3999

2025-01-15T15:12:26Z

ElizaCollison:

{{TUFLOW_Message
|tuflow_message=ERROR 3999 - ptx file version mismatch
 
|alt_msg=ERROR 3999 - nDevices requested less than 1. 
ERROR 3999 - unknown hardware option = 'a'. 
ERROR 3999 - Unknown units option 'a'. 
ERROR 3999 - HPC has reported an error - see .hpc.tlf

|type=[[ERROR]]
|message_desc=This error usually indicates an invalid model option has been passed to HPC solver unnoticed during the model pre-processing. This can also happen when the TUFLOW executable wasn't downloaded completely or some files were accidentally deleted.
|suggestions=Check you have NVIDIA GPU card and updated driver. Check error written in the .hpc.tlf file. For ptx file version mismatch re-download TUFLOW executable from the website. 
If running a linked TUFLOW-Flood Modeller model, ensure the relevant kernels are in the Flood Modeller Bin folder, for more information see [[ Running_linked_Flood_Modeller_-_TUFLOW_Models#Flood_Modeller-TUFLOW_HPC.2FQuadtree | here]].

|uplink=[[3xxx_TUFLOW_Messages|3xxx Messages]]
}}

TUFLOW Message 2565

2025-01-13T17:24:52Z

ElizaCollison:

{{TUFLOW_Message
|tuflow_message=ERROR 2565 - HPC Non-Newtonian Mixing Exponent <= than 0, must be in the range 0.0 - 10.0.
|alt_msg=ERROR 2565 - HPC Non-Newtonian Mixing Exponent > than 10, must be in the range 0.0 - 10.0. 

|type=[[ERROR]]
|message_desc=HPC Non-Newtonian mixing exponent is outside the valid range.
|suggestions=Ensure the HPC non-Newtonian mixing exponent is within the valid range of 0.0 - 10.0. For example: <tt>HPC Non-Newtonian Mixing Exponent == 1 </tt>. 
Refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] for further information on the non-Newtonian mixing exponent.

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
}}

TUFLOW Message 2934

2025-01-13T16:11:40Z

ElizaCollison:

{{TUFLOW_Message
|tuflow_message=WARNING 2934 - At least one merge polygon vertex is outside quadtree sub-domain. Current nesting level = n
|alt_msg=CHECK 2934 - At least one merge polygon vertex is located inside quadtree cell(s) from different nesting level. Processing nesting level = n 

|type=[[WARNING]] [[CHECK]]
|message_desc=Issues can occur in the TIN process when 2d_zsh polygons intersect with multiple quadtree levels.
|suggestions= Check by reviewing the [[Check_Files_2d_zsh_zpt | _zsh_zpt]] and [[Check_Files_2d_DEM_Z | DEM_Z]] check files that the appropriate topography modifications have been applied. If they haven't options include:
* extend the 2d_qnl to cover the entire 2d_zsh,
* create a TIN using QGIS or SMS and read the TIN into TUFLOW directly (using the 'Read TIN Zpts ==' command),
* snap 2d_zsh elevation points to every 2d_zsh polygon vertex, or
* use the "NO MERGE" option and supply elevations as needed.

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
}}

Check Files 1d xsl

2025-01-10T15:55:48Z

ElizaCollison: /* Top_Storage_Width calculation when portion of cross-section is deactivated */

The XSL check file contains information on the input cross-sections where specified as tabular data (as opposed to say a box culvert section which is defined by a height and a width). At each input cross-section a GIS line is output containing the information in the table below. 
The .csv [[Check_Files_1d_ta_tables | 1d_ta_tables check file]] contains the height varying properties for the section. 
The [[Check_Files_1d_hydroprop | 1d_hydroprop check files]] which contains information on each of the channels (including interpolated and structures).
 
 
'''Attributes of xsl_check''' 
{| align="center" class="wikitable" width="75%"
! style="background-color:#005581; font-weight:bold; color:white;"| Attribute Name
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Attribute Description
|-
| ID||The cross-section ID, this is the input cross-section number and is unique. It is also output in the [[Check_Files_1d_ta_tables | 1d_ta_tables check file]].
|-
| Manning_n||The Manning's n at the lowest point (bed) in the cross-section. If no roughness value is specified on the cross-section (the Manning's value is specified on the channel), then a value of -1 is output.
|-
| Elev_at_Bed||The elevation at the lowest point in the cross-section.
|-
| Elev_at_Top||The elevation at the highest point in the cross-section.
|-
| Depth||The depth at the top of section. i.e. the elevation at the top - the elevation at the bed.
|-
| Top_Flow_Width||The effective flow width at the top of the cross section. See the [[Check_Files_1d_ta_tables | _ta_tables]] check file for the effective flow width at each elevation. Note, the effective width is calculated based on the Manning’s n value, if the Manning’s n values differ throughout the channel, the width is proportionally adjusted so the whole cross-section uses a single Manning’s n.
|-
| Top_Storage_Width||The storage width at the top of the cross-section. See [[Check_Files_1d_xsl#Top_Storage_Width_calculation_when_portion_of_cross-section_is_deactivated | note below]] for how this is calculated when using negative Manning's n or M values to deactivate parts of cross-sections.
|-
| Top_Flow_Area||The flow area at the top of the cross-section.
|-
| Top_Wet_Perimeter||The wetted perimeter at the top of the cross-section.
|-
| Source_File||The source file (.csv) file which the data was read from.
|-
| Attributes||The remaining attributes (the source file is excluded, see the above) in the GIS layer.
|-
| Source_Layer||The GIS file that the cross-section was specified in.
|}

==Top_Storage_Width calculation when portion of cross-section is deactivated==
Every cross section is being divided into vertical parallel channels, where the bounds are midway in between the XZ points. Where outer parts of the channel are being made inactive (e.g. with Manning’s n -1, for more information see [[TUFLOW_1D_Channels_and_Hydraulic_Structures#How_do_negative_.22M.22.2C_.22N.22_and_.22R.22_values_deactivate_1D_cross-sections.3F | here]]) TUFLOW will place vertical walls at the midway point between the XZ points where the cross-section is inactive. The height limit is the highest active XZ point.

The below example shows the calculated top storage width in red. In blue is the full cross section, orange is the active part of the channel, green is highest elevation of the active part of the channel and grey are the vertical bounds.

[[File:Top storage width 1.png | 700px]] 

This can become more complicated if the highest point in the active part of the channel has a lower adjacent inactive point. In this case, the width calculation considers half of the distance between these two XZ points as well, as shown below.

[[File:Top storage width 2.png | 700px]] 

{{Tips Navigation
|uplink=[[TUFLOW_Check_Files | TUFLOW Check Files]]
}}

Check Files 1d xsl

2025-01-10T15:53:17Z

ElizaCollison:

The XSL check file contains information on the input cross-sections where specified as tabular data (as opposed to say a box culvert section which is defined by a height and a width). At each input cross-section a GIS line is output containing the information in the table below. 
The .csv [[Check_Files_1d_ta_tables | 1d_ta_tables check file]] contains the height varying properties for the section. 
The [[Check_Files_1d_hydroprop | 1d_hydroprop check files]] which contains information on each of the channels (including interpolated and structures).
 
 
'''Attributes of xsl_check''' 
{| align="center" class="wikitable" width="75%"
! style="background-color:#005581; font-weight:bold; color:white;"| Attribute Name
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Attribute Description
|-
| ID||The cross-section ID, this is the input cross-section number and is unique. It is also output in the [[Check_Files_1d_ta_tables | 1d_ta_tables check file]].
|-
| Manning_n||The Manning's n at the lowest point (bed) in the cross-section. If no roughness value is specified on the cross-section (the Manning's value is specified on the channel), then a value of -1 is output.
|-
| Elev_at_Bed||The elevation at the lowest point in the cross-section.
|-
| Elev_at_Top||The elevation at the highest point in the cross-section.
|-
| Depth||The depth at the top of section. i.e. the elevation at the top - the elevation at the bed.
|-
| Top_Flow_Width||The effective flow width at the top of the cross section. See the [[Check_Files_1d_ta_tables | _ta_tables]] check file for the effective flow width at each elevation. Note, the effective width is calculated based on the Manning’s n value, if the Manning’s n values differ throughout the channel, the width is proportionally adjusted so the whole cross-section uses a single Manning’s n.
|-
| Top_Storage_Width||The storage width at the top of the cross-section. See [[Check_Files_1d_xsl#Top_Storage_Width_calculation_when_portion_of_cross-section_is_deactivated | note below]] for how this is calculated when using negative Manning's n or M values to deactivate parts of cross-sections.
|-
| Top_Flow_Area||The flow area at the top of the cross-section.
|-
| Top_Wet_Perimeter||The wetted perimeter at the top of the cross-section.
|-
| Source_File||The source file (.csv) file which the data was read from.
|-
| Attributes||The remaining attributes (the source file is excluded, see the above) in the GIS layer.
|-
| Source_Layer||The GIS file that the cross-section was specified in.
|}

==Top_Storage_Width calculation when portion of cross-section is deactivated==
Every cross section is being divided into vertical parallel channels, where the bounds are midway in between the XZ points. Where outer parts of the channel are being made inactive (e.g. with Manning’s n -1, for more information see [[TUFLOW_1D_Channels_and_Hydraulic_Structures#How_do_negative_.22M.22.2C_.22N.22_and_.22R.22_values_deactivate_1D_cross-sections.3F | here]]) TUFLOW will place vertical walls at the midway point between the XZ points where the cross-section is inactive. The height limit is the highest active XZ point.

The below example shows the calculated top storage width in red. In blue is the full cross section, orange is the active part of the channel, green is highest elevation of the not ignored part of the channel and grey are the vertical bounds.

[[File:Top storage width 1.png | 700px]] 

This can become more complicated if the highest point in the active part of the channel has a lower adjacent inactive point. In this case, the width calculation considers half of the distance between these two XZ points as well, as shown below.

[[File:Top storage width 2.png | 700px]] 

{{Tips Navigation
|uplink=[[TUFLOW_Check_Files | TUFLOW Check Files]]
}}

Check Files 1d xsl

2025-01-10T15:49:27Z

ElizaCollison:

The XSL check file contains information on the input cross-sections where specified as tabular data (as opposed to say a box culvert section which is defined by a height and a width). At each input cross-section a GIS line is output containing the information in the table below. 
The .csv [[Check_Files_1d_ta_tables | 1d_ta_tables check file]] contains the height varying properties for the section. 
The [[Check_Files_1d_hydroprop | 1d_hydroprop check files]] which contains information on each of the channels (including interpolated and structures).
 
 
'''Attributes of xsl_check''' 
{| align="center" class="wikitable" width="75%"
! style="background-color:#005581; font-weight:bold; color:white;"| Attribute Name
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Attribute Description
|-
| ID||The cross-section ID, this is the input cross-section number and is unique. It is also output in the [[Check_Files_1d_ta_tables | 1d_ta_tables check file]].
|-
| Manning_n||The Manning's n at the lowest point (bed) in the cross-section. If no roughness value is specified on the cross-section (the Manning's value is specified on the channel), then a value of -1 is output.
|-
| Elev_at_Bed||The elevation at the lowest point in the cross-section.
|-
| Elev_at_Top||The elevation at the highest point in the cross-section.
|-
| Depth||The depth at the top of section. i.e. the elevation at the top - the elevation at the bed.
|-
| Top_Flow_Width||The effective flow width at the top of the cross section. See the [[Check_Files_1d_ta_tables | _ta_tables]] check file for the effective flow width at each elevation. Note, the effective width is calculated based on the Manning’s n value, if the Manning’s n values differ throughout the channel, the width is proportionally adjusted so the whole cross-section uses a single Manning’s n.
|-
| Top_Storage_Width||The storage width at the top of the cross-section. See note below for how this is calculated when using negative Manning's n or M values to deactivate parts of cross-sections.
|-
| Top_Flow_Area||The flow area at the top of the cross-section.
|-
| Top_Wet_Perimeter||The wetted perimeter at the top of the cross-section.
|-
| Source_File||The source file (.csv) file which the data was read from.
|-
| Attributes||The remaining attributes (the source file is excluded, see the above) in the GIS layer.
|-
| Source_Layer||The GIS file that the cross-section was specified in.
|}

==Top_Storage_Width calculation when portion of cross-section is deactivated==
Every cross section is being divided into vertical parallel channels, where the bounds are midway in between the XZ points. Where outer parts of the channel are being made inactive (e.g. with Manning’s n -1, for more information see [[TUFLOW_1D_Channels_and_Hydraulic_Structures#How_do_negative_.22M.22.2C_.22N.22_and_.22R.22_values_deactivate_1D_cross-sections.3F | here]]) TUFLOW will place vertical walls at the midway point between the XZ points where the cross-section is inactive. The height limit is the highest active XZ point.

The below example shows the calculated top storage width in red. In blue is the full cross section, orange is the active part of the channel, green is highest elevation of the not ignored part of the channel and grey are the vertical bounds.

[[File:Top storage width 1.png | 700px]] 

This can become more complicated if the highest point in the active part of the channel has a lower adjacent inactive point. In this case, the width calculation considers half of the distance between these two XZ points as well, as shown below.

[[File:Top storage width 2.png | 700px]] 

{{Tips Navigation
|uplink=[[TUFLOW_Check_Files | TUFLOW Check Files]]
}}

File:Top storage width 2.png

2025-01-10T15:47:39Z

ElizaCollison:

File:Top storage width 1.png

2025-01-10T15:47:14Z

ElizaCollison:

Check Files 1d xsl

2025-01-10T15:35:52Z

ElizaCollison:

Flood Modeller to TUFLOW

2025-01-07T08:37:54Z

ElizaCollison: /* Examples */

=Introduction=
Often, there is a requirement to convert aspects of a Flood Modeller model to a TUFLOW ESTRY model. It is possible to convert a Flood Modeller 1D model to a TUFLOW ESTRY format using either the fm_to_estry.exe or fm_to_estry.py utilities. The utilities are available for download from the [https://gitlab.com/tuflow-user-group/tuflow/model-conversions/fm-to-estry TUFLOW Gitlab User Group]. This Wiki page lists useful examples for using the fm_to_estry.exe and fm_to_estry.py utilities. If you have any suggestions to be included in these pages, please email support@tuflow.com.

=Flood Modeller to ESTRY conversion utility using the fm_to_estry.exe=
The fm_to_estry.exe utility creates the relevant TUFLOW ESTRY network layers from a Flood Modeller .dat file. The utility converts:
* Flood Modeller units to ESTRY node/link inputs (1d_nwk)
* Flood Modeller section data to ESTRY cross-section GIS (1d_xs) and csv inputs
* Flood Modeller structures to ESTRY GIS and csv inputs
A number of structure units are supported but not all. A list of currently supported structures is shown below:
*River
*Bridge
*Conduit
*Interpolates/Replicates
*Culverts
*Orifice
**Flood Relief
**Inverted Syphon
**Outfall
*Weirs
**Weir
**SCWeir
**RNWeir
**Spill
**NotWeir
**Labyrinth Weir
**Crump Weir
**Gated Weir
*Sluices
*Junction
*QH Control

If using the fm_to_estry.py Python script, it is possible to add support for additional structures. See below for more details.

 ''Note :The utility does not currently support the conversion of either boundary condition data or logical control rules. ''

=Utility Execution (.exe)=
In order to convert a Flood Modeller network to ESTRY using the fm_to_estry executable follow the instructions below.
<ol>
<li>Download the compiled executable from the [https://gitlab.com/tuflow-user-group/tuflow/model-conversions/fm-to-estry TUFLOW Gitlab User Group] by visiting the Compiled Library section and unzip it to your preferred destination.
<li>Open the file. Then, bring in the relevant files from the Flood Modeller model that requires conversion, in this example the .dat, .gxy and projection files. The projection.shp file will help you to assign your model to the correct projection and can come from an existing TUFLOW model or shapefile in the correct projection. See figure below for the required files: [[File:Fm2estry_1.png|300px|]]
<li>Create a new .bat file (To do that right click in an empty area in the file. A dialogue will open. Choose New and then Text document. Rename your new Text document by including the .bat extension at the end. For Example: fm_to_estry_example.bat).
<li>Open your batch file and insert the text to convert the Flood Modeller model network to an ESTRY one. Some examples are shown in the following lines, note that if the batch file is held in a different directory to the Flood Modeller files, you will need to the full file path or relative path to reference the files.
===Examples===
<ol>
<li><pre>fm_to_estry.exe flood_modeller.gxy flood_modeller.dat -crs projection.shp</pre>
Converts a Flood Modeller model
<li><pre>fm_to_estry.exe flood_modeller.gxy flood_modeller.dat -crs "EPSG:32760"</pre>
Uses an EPSG number (32760) for the projection
<li><pre>fm_to_estry.exe flood_modeller.gxy flood_modeller.dat -crs projection.shp -out .\output</pre>
Custom Output Directory
<li><pre>fm_to_estry.exe flood_modeller.gxy flood_modeller.dat -crs projection.shp -logfile</pre>
Writes a Log File
<li><pre>fm_to_estry.exe flood_modeller.gxy flood_modeller.dat -crs projection.shp -raw</pre>
Writes GXY to GIS Prior to Conversion
<li><pre>fm_to_estry.exe flood_modeller.gxy flood_modeller.dat -crs projection.shp -mif</pre>
Writes to MIF Format
</ol>
<li>Save your preferences and close your batch file.
<li>Double click the batch file.
<li>The above steps will return structures from the supported structures list in .shp and .csv file formats to use them to further set up a 1D TUFLOW/ESTRY model. It is recommended that the connectivity is reviewed upstream to downstream to ensure full connectivity of the ESTRY network and generate a network which pass TUFLOW's pre-processing procedure prior to simulation.
The figure below illustrates Flood Modeler 1D model conversion to TUFLOW ESTRY.
 [[File:Fm2estry_2.jpg|700px|]]
 [[File:Fm2estry_3.jpg|700px|]]
</ol>

=Python Script Execution (.py)=
Alternatively, rather than run the executable, it is possible to run as a Python script. To run the Python script, replace the fm_to_estry.exe above with python fm_to_estry.py and follow the 2-6 steps which are described in Utility Execution (.exe). To download the Python script file please visit: [https://gitlab.com/tuflow-user-group/tuflow/model-conversions/fm-to-estry TUFLOW Gitlab User Group] and click on the following icon: [[File:Fm2estry_4.jpg|50px|]]

The benefit of this approach is that you can add your own support for structures not currently supported. More details are described in the Section: How to Add New Supported Units, which can be found in the following page: [https://gitlab.com/tuflow-user-group/tuflow/model-conversions/fm-to-estry#:~:text=How%20to%20Add%20New%20Supported%20Units TUFLOW Gitlab user group].

=Other Information=
It is also possible to use the cross-sections from the Flood Modeller .dat file directly within a TUFLOW/ESTRY simulation. This means that for some simpler models, particularly those without structures, that conversion of the Flood Modeller model to an ESTRY format is not required with the cross-section data being used in a TUFLOW 1D /ESTRY model directly from the .dat file. Please, see the [https://docs.tuflow.com/classic-hpc/manual/2023-03/ECFCommands-1.html#ecfXSDatabase <tt>XS Database</tt> <tt>==</tt> command] in the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW user manual] for more information.

=Summary=
When there is a requirement to convert a Flood Modeller 1D network, or part of a network, to TUFLOW ESTRY format this can be time consuming. A set of tools have been provided for you to assist this process. Currently, the tools are restricted to network geometry but if there is user-demand, this can be extended to boundary conditions, logical rules and the production of TUFLOW control files. There are two approaches, using either an executable or a Python tool, both of which undertake the same conversion. The advantage of the Python tool is that it is possible to add user-specified support for additional structures which are not supported currently. Once the Flood Modeller network has been converted to a set of ESTRY layers, these should be checked for connectivity and brought together in the ESTRY Control File to read into a TUFLOW-ESTRY simulation.
 
{{Tips Navigation
|uplink=[[Main_Page| Back to Main Page]]
}}

TUFLOW Example Models

2025-01-06T11:30:04Z

ElizaCollison:

=Introduction=
These example models have been developed to demonstrate the most common TUFLOW model design features and applications. This dataset is useful for experienced modellers wishing to further develop their skills via demonstration examples. Although the models are based on the TUFLOW tutorial model dataset, new users are encouraged to familiarise themselves with TUFLOW through the [[Tutorial_Introduction |Tutorial Model Introduction]] before using this dataset. Unlike the tutorials, this dataset does not include step-by-step instructions / documentation. Users of this dataset are expected to have a basic knowledge TUFLOW, and have suitable skills to open the model files by referencing the TUFLOW Control File (TCF) referenced in the feature catalogue list below. 

=Example Model Data=
The model data is available for download from https://downloads.tuflow.com/TUFLOW/Wiki_Example_Models/TUFLOW_Example_Model_Dataset.zip 
The dataset only includes model input files. The models can be run to create simulation check and result files. Batch files (*.bat) for each of the example feature categories has been provided within the "runs" folder of the TUFLOW project. 

If you are unfamiliar with using batch files, additional information explaining how to use them to execute multiple simulations is available here: [[Run_TUFLOW_From_a_Batch-file| Run TUFLOW From a Batch-file]].

=Example Model Catalogue=
Below is a complete list of the example models. This dataset uses TUFLOW HPC as the computational engine. If you are searching for TUFLOW Classic example models, please refer to the [[TUFLOW_Classic_Example_Model_Archive| TUFLOW Classic Example Model Archive]].

Click on the following shortcuts to skip directly to the targeted major feature category in the table below: 
*[[TUFLOW_Example_Models#Project Initiation| Project Initiation]]
*[[TUFLOW_Example_Models#Model Units| Model Units]]
*[[TUFLOW_Example_Models#Solver Options| Solver Options]]
*[[TUFLOW_Example_Models#Output Options| Output Options]]
*[[TUFLOW_Example_Models#Boundary Condition Options| Boundary Condition Options]] (Inflows, Outflows, Losses)
*[[TUFLOW_Example_Models#Topography Features| Topography Features]] (Static Updates, Dynamic Updates, Sub-Grid Sampling)
*[[TUFLOW_Example_Models#Structures| Structures]] (Bridges, Weirs, Culverts, Operational Controls)
*[[TUFLOW_Example_Models#Multiple Domain Model Design| Multiple Domain Model Design]] (2D/2D, 1D open channel / 2D floodplain, 1D pipe network / 2D floodplain)
*[[TUFLOW_Example_Models#Bulk Simulation Management| Bulk Simulation Management]]
*[[TUFLOW_Example_Models#Advection Dispersion| Advection Dispersion]]
*[[TUFLOW_Example_Models#Non-Newtonian | Non-Newtonian]]

{| class="wikitable" style="text-align: center;"
! colspan="4" style="background-color:#005581; font-weight:bold; color:white;" |Example Model Catalogue
|-
| colspan="2" |Model Category||Description||Model Name

|-
| colspan="2" id="Project Initiation" |Project Initiation
|Write empty files
|Create_Empties.tcf
|-

|-
| colspan="2" rowspan="2" id="Model Units" |Model Units
|Basic 2D model (SI units - m)
|EG00_001.tcf
|-
|Basic 2D model (US units - ft)
|EG00_002.tcf
|-

|-
| colspan="2" rowspan="8" id="Solver Options" |Solver Options
|TUFLOW Classic
|Refer to [[TUFLOW_Classic_Example_Model_Archive| TUFLOW Classic Example Model Archive]]
|-
|TUFLOW HPC - Sub-Grid Sampled (SGS) topography enabled
|EG01_002.tcf
|-
|TUFLOW HPC - Sub-Grid Sampled (SGS) topography disabled
|EG01_003.tcf
|-
|TUFLOW HPC - Multiple GPU cards
|EG01_004.tcf
|-
|TUFLOW HPC - Newtonian Viscosity (Wu Turbulence)
|EG01_006.tcf
|-
|TUFLOW HPC - Newtonian Viscosity (Smagorinsky)
|EG01_007.tcf
|-
|TUFLOW HPC - Quadtree
|See Section [[TUFLOW_Example_Models#Multiple Domain Model Design| EG13]]
|-
|ESTRY
|See Section [[TUFLOW_Example_Models#1D Culverts, Bridges, Weirs| EG11]], [[TUFLOW_Example_Models#1D Operating Structures| EG12]], [[TUFLOW_Example_Models#1D Pipe Network / 2D Floodplain Modelling| EG15]]
|-

| colspan="2" rowspan="19" id="Output Options" |Output Options
|2D xmdf (binary time series) and grid (maximums) output
|EG02_001.tcf
|-
|Time and duration of inundation (Time Output Cut-off = Depth)
|EG02_002.tcf
|-
|Time and duration of inundation (Time Output Cut-off = VxD)
|EG02_003.tcf
|-
|Time and duration of inundation (Time Output Cut-off = Hazard)
|EG02_004.tcf
|-
|Gauge level map output interval control (2d_glo)
|EG02_005.tcf
|-
|2D SGS high resolution grid output
|EG02_006.tcf
|-
|2D SGS high resolution grid output with manual specification of output resolution
|EG02_007.tcf
|-
|Output Zone (2d_oz)
|EG02_008.tcf
|-
|Write Restart File(See EG06_004.tcf for Read Restart File)
|EG02_009.tcf
|-
|2D plot output (2d_po point, line and region)
|EG02_010.tcf
|-
|2D structure outputs
|EG02_011.tcf
|-
|2D Long Profile
|EG02_012.tcf
|-
|1D/2D Reporting locations - 1D river (1d_nwk), 2D floodplain
|EG02_013.tcf
|-
|1D/2D Reporting locations - 1D pipe network (1d_nwk), 2D floodplain
|EG02_014.tcf
|-
|Evacuation route inundation reporting (2d_zshr) (Route Cut Off Type = Depth)
|EG02_015.tcf
|-
|Evacuation route inundation reporting (2d_zshr) (Route Cut Off Type = Velocity)
|EG02_016.tcf
|-
|Evacuation route inundation reporting (2d_zshr) (Route Cut Off Type = VxD)
|EG02_017.tcf
|-
|Evacuation route inundation reporting (2d_zshr) (Route Cut Off Type = Hazard)
|EG02_018.tcf
|-
|Translating gauge data information to catchment receptors (Read GIS Objects)
|EG02_019.tcf

|-
| rowspan="50" id="Boundary Condition Options" |Boundary Condition Options
| rowspan="18" id="Inflows" |Inflows
|2D flow (m^3/s) vs time upstream inflow (2d_bc, QT)
|EG03_001.tcf
|-
|2D head (m) vs time upstream inflow (2d_bc, HT)
|EG03_002.tcf
|-
|Internal catchment inflow (m^3/s)(2d_sa)
|EG03_003.tcf
|-
|Internal catchment inflow (m^3/s) with streamlines (2d_sa)
|EG03_004.tcf
|-
|Internal catchment rainfall (mm) (2d_sa_rf)
|EG03_005.tcf
|-
|Direct rainfall (mm) (2D Global Rainfall)
|EG03_006.tcf
|-
|Direct rainfall (mm) (2d_rf)
|EG03_007.tcf
|-
|Direct rainfall (mm) (Rainfall Control File - IDW)
|EG03_008.tcf
|-
|Direct rainfall (mm) (Rainfall Control File - TIN)
|EG03_009.tcf
|-
|Direct rainfall (mm) (Rainfall Control File - Poly)
|EG03_010.tcf
|-
|Direct rainfall (mm) (time varying gridded rainfall) - netcdf format
|EG03_011.tcf
|-
|Direct rainfall (mm) (time varying gridded rainfall) - flt format
|EG03_012.tcf
|-
|Direct rainfall (mm) (2d_rf) - negative rainfall
|EG03_013.tcf
|-
|Direct rainfall (2d_rf) and internal catchment rainfall (2d_sa_rf) for buildings
|EG03_014.tcf
|-
|HEC-DSS flow (m^3/s) vs time upstream inflow (2d_bc, QT)
|EG03_015.tcf
|-
|1D flow (m^3/s) vs time upstream inflow (1d_bc, QT)
|EG14_001.tcf
|-
|1D flow (m^3/s) vs time internal inflow (1d_bc, QT)
|EG14_002.tcf
|-
|1D flow (m^3/s) vs time internal inflow to 1D pits (1d_bc, QT)
|EG14_003.tcf
|-

| rowspan="6" id="Outflows" |Outflows
|2D Automatic stage discharge downstream boundary (2d_bc, HQ)
|EG04_001.tcf
|-
|2D User-specified stage discharge downstream boundary (2d_bc, HQ)
|EG04_002.tcf
|-
|2D Stage time downstream boundary (2d_bc, HT)
|EG04_003.tcf
|-
|1D Automatic stage discharge downstream boundary (1d_bc, HQ)
|EG04_004.tcf
|-
|1D User-specified stage discharge downstream boundary (1d_bc, HQ)
|EG04_005.tcf
|-
|1D Stage time downstream boundary (1d_bc, HT)
|EG04_006.tcf
|-

| rowspan="18" id="Soil Options" |Soil Options
|Rainfall excess loss approach - IL/CL (Global loss applied via the TBC file)
|EG05_001.tcf
|-
|Rainfall excess loss approach - IL/CL (applied via the materials file)
|EG05_002.tcf
|-
|Infiltration loss approach - IL/CL
|EG05_003.tcf
|-
|Infiltration loss approach - IL/CL, porosity
|EG05_004.tcf
|-
|Infiltration loss approach - IL/CL, porosity, initial moisture
|EG05_005.tcf
|-
|Infiltration loss approach - Green Ampt (USDA soil type)
|EG05_006.tcf
|-
|Infiltration loss approach - Green Ampt (USDA soil type), initial moisture
|EG05_007.tcf
|-
|Infiltration loss approach - Green Ampt (USDA soil type), initial moisture, ponding
|EG05_008.tcf
|-
|Infiltration loss approach - Green Ampt (User specified soil properties)
|EG05_009.tcf
|-
|Infiltration loss approach - Green Ampt (User specified soil properties), initial moisture
|EG05_010.tcf
|-
|Infiltration loss approach - Green Ampt (User specified soil properties), initial moisture, ponding
|EG05_011.tcf
|-
|Infiltration loss approach - Horton
|EG05_012.tcf
|-
|Infiltration loss approach - Horton, porosity
|EG05_013.tcf
|-
|Infiltration loss approach - Horton, porosity, initial moisture
|EG05_014.tcf
|-
|Groundwater - no horizontal infiltration
|EG05_015.tcf
|-
|Groundwater - 1 soil layer, horizontal hydraulic conductivity
|EG05_016.tcf
|-
|Groundwater - 2 soil layers, horizontal hydraulic conductivity
|EG05_017.tcf
|-
|Groundwater level versus time downstream boundary (2d_bc, GT)
|EG05_018.tcf
|-

| rowspan="8" id="Other" |Other
|Spatially varied initial water level commands (2d_iwl)
|EG06_001.tcf
|-
|Spatially varied initial water level commands (Grid 2d_iwl)
|EG06_002.tcf
|-
|2D pump (2d_bc, SH)
|EG06_003.tcf
|-
|Read Restart File (See EG02_009.tcf for Write Restart File)
|EG06_004.tcf
|-
|Storage Reduction Factor (global specification)
|EG06_005.tcf
|-
|Storage Reduction Factor (2d_srf) (location specific update)
|EG06_006.tcf
|-
|External Stress - Wind (global specification)
|EG06_007.tcf
|-
|Dynamic Topography Options (Dam / Levee Failure)
|See Section [[TUFLOW_Example_Models#Dynamic Topography Updates| EG08]]

|-
| rowspan="28" id="Topography Features" |Topography Features
| rowspan="12" id="Static Topography Updates" |Static Topography Updates
|Cell resolution change
|EG07_001.tcf
|-
|Thin breakline topography update (2d_zsh_L, 2d_zsh_P)
|EG07_002.tcf
|-
|Thick breakline topography update (2d_zsh_L, 2d_zsh_P)
|EG07_003.tcf
|-
|Gully (Min) breakline topography update (2d_zsh_L, 2d_zsh_P)
|EG07_004.tcf
|-
|Ridge (Max) breakline topography update (2d_zsh_L, 2d_zsh_P)
|EG07_005.tcf
|-
|Region update - Absolute value change, No merge (2d_zsh_R)
|EG07_006.tcf
|-
|Region update - Relative value change, No merge (2d_zsh_R)
|EG07_007.tcf
|-
|Region update - Absolute value change, Partial merge (2d_zsh_R, 2d_zsh_P)
|EG07_008.tcf
|-
|Region update - Feature removal (2d_zsh_R)
|EG07_009.tcf
|-
|Advanced topography update - TIN (2d_ztin_R, 2d_ztin_P)
|EG07_010.tcf
|-
|Advanced topography update - TIN (2d_ztin_R, 2d_ztin_L, 2d_ztin_P)
|EG07_011.tcf
|-
|Depth varying Manning's n
|EG07_012.tcf
|-
| rowspan="13" id="Dynamic Topography Updates" |Dynamic Topography Options (Dam / Levee Failure)
|2D embankment failure - Time trigger, linear evolution
|EG08_001.tcf
|-
|2D embankment failure - Time trigger, non-linear evolution
|EG08_002.tcf
|-
|2D embankment failure - Water level trigger, linear evolution
|EG08_003.tcf
|-
|2D embankment failure - Water level trigger, non-linear evolution
|EG08_004.tcf
|-
|2D embankment failure - Water level difference trigger, linear evolution
|EG08_005.tcf
|-
|2D embankment failure - Water level difference trigger, non-linear evolution
|EG08_006.tcf
|-
|2D flood barrier reinstatement - Time trigger
|EG08_007.tcf
|-
|2D flood barrier reinstatement - Water level trigger
|EG08_008.tcf
|-
|2D flood barrier reinstatement - Water level difference trigger
|EG08_009.tcf
|-
|1D piping failure transitioning to 1D dam failure - Time trigger
|EG08_010.tcf
|-
|1D dam failure - Time trigger
|EG08_011.tcf
|-
|1D piping failure transitioning to 1D dam failure - Water level trigger
|EG08_012.tcf
|-
|1D dam failure - Water level trigger
|EG08_013.tcf
|-
| rowspan="3" id="Sub Grid Sampling" |Sub Grid Sampling
|Breakline detection delta tool
|EG09_001.tcf
|-
|2D SGS high resolution grid output
|EG09_002.tcf
|-
|2D SGS high resolution grid output with manual specification of output resolution
|EG09_003.tcf
|-
| rowspan="34" id="Structures" |Structures
| rowspan="9" id="2D Structures" |2D Structures
|Bridge (2d_fc)
|Refer to [[TUFLOW_Classic_Example_Model_Archive| TUFLOW Classic Example Model Archive]]
|-
|Bridge (2d_fcsh)
|Refer to [[TUFLOW_Classic_Example_Model_Archive| TUFLOW Classic Example Model Archive]]
|-
|Bridge - horizontal deck (2d_lfcsh)
|EG10_003.tcf
|-
|Bridge - variable deck form geometry (2d_lfcsh)
|EG10_004.tcf
|-
|Bridge - horizontal deck (2d_bg)
|EG10_005.tcf
|-
|2D weir coefficient change (global specification)
|EG10_006.tcf
|-
|2D weir coefficient change (location specific update)
|EG10_007.tcf
|-
|Bridge (2d_bg) - horizontal deck, auto superstructure FLC
|EG10_008.tcf
|-
|Fences (2d_lfcsh)
|EG10_009.tcf
|-

| rowspan="12" id="1D Structures" |1D Structures
|1D culverts - Circular and Box type. SX point, line and region 1D/2D examples
|EG11_001.tcf
|-
|1D culverts - Irregular shape (e.g. Arch)
|EG11_002.tcf
|-
|1D culverts - Unidirectional structures (flapgate) (1d_nwk)
|EG11_003.tcf
|-
|1D culverts - ARR2019 blockage matrix (1d_nwk)
|EG11_~e1~_~e2~_004.tcf
|-
|1D M channel - User defined flow matrix (1d_nwk)
|EG11_005.tcf
|-
|1D Q channel - Upstream Depth-Discharge Relationship (1d_nwk)
|EG11_006.tcf
|-
|Bridge (1d_nwk)
|EG11_007.tcf
|-
|Weir (1d_nwk)
|EG11_008.tcf
|-
|Pump (1d_nwk) - pump curve
|EG11_009.tcf
|-
|Sluice gate (1d_nwk)
|EG11_010.tcf
|-
|Gated spillway (1d_nwk)
|EG11_011.tcf
|-
|Arch bridge (1d_nwk)
|EG11_012.tcf
|-

| rowspan="13" id="1D Operating Structures" |1D Operating Structures
|Pump operational (1d_nwk) - time trigger
|EG12_001.tcf
|-
|Pump operational - 1D water level trigger (1d_nwk)
|EG12_002.tcf
|-
|Pump operational - 2D water level trigger (1d_nwk)
|EG12_003.tcf
|-
|Pump operational - Depth above structure invert trigger (1d_nwk)
|EG12_004.tcf
|-
|Q flow matrix - Operation based on water level trigger (1d_nwk)
|EG12_005.tcf
|-
|Q flow matrix - Operation based on water level trigger and time delay (1d_nwk)
|EG12_006.tcf
|-
|Sluice gate operational - Time trigger (simulation time) (1d_nwk)
|EG12_007.tcf
|-
|Sluice gate operational - Water level trigger(1d_nwk)
|EG12_008.tcf
|-
|Gated spillway operational - Time trigger (Day) (1d_nwk)
|EG12_009.tcf
|-
|Gated spillway operational - Water level trigger (1d_nwk)
|EG12_010.tcf
|-
|Coordinated operation (multiple interacting structures) - Pump and Gated Spillway
|EG12_011.tcf
|-
|Coordinated operation controlled by status of another structure
|EG12_012.tcf
|-
|Pump operational (1d_nwk) - pump curve
|EG12_013.tcf
|-

| rowspan="17" id="Multiple Domain Model Design" |Multiple Domain Model Design
| rowspan="5" id="2D/2D Modelling" |2D/2D Modelling
|TUFLOW HPC - Quadtree: Sample target distance
|EG13_001.tcf
|-
|TUFLOW HPC - Quadtree: Sample target distance nesting
|EG13_002.tcf
|-
|TUFLOW HPC - Quadtree: Memory efficient pre-processing
|EG13_003.tcf
|-
|TUFLOW HPC - Quadtree: Sample frequency
|EG13_004.tcf
|-
|TUFLOW Classic - M2D
|Refer to [[TUFLOW_Classic_Example_Model_Archive| TUFLOW Classic Example Model Archive]]
|-
| rowspan="1" id="1D Open Channel / 2D Floodplain Modelling" |1D Open Channel / 2D Floodplain Modelling
|1D river (1d_nwk), 2D floodplain
|EG14_001.tcf
|-

| rowspan="11" id="1D Pipe Network / 2D Floodplain Modelling" |1D Pipe Network / 2D Floodplain Modelling
|1D pipe network (1d_nwk), 2D floodplain, 2d_sa_rf inflow (mm) to 1D pits
|EG15_000.tcf
|-
|1D pipe network (1d_nwk), 2D floodplain, 2d_sa inflow (m^3/s) to 1D pits
|EG15_001.tcf
|-
|1D pipe network (1d_nwk), 2D floodplain, 2d_rf direct rainfall
|EG15_002.tcf
|-
|1D pipe network (1d_nwk), 2D / 2D floodplain quadtree
|EG15_003.tcf
|-
|1D pipe network (1d_nwk), manually specified manholes (1d_mh), 2D floodplain
|EG15_004.tcf
|-
|1D pipe network (1d_nwk), non-default (fixed) manhole loss method, 2D floodplain
|EG15_005.tcf
|-
|1D pipe network (1d_nwk), localised manually specified manhole losses, 2D floodplain
|EG15_006.tcf
|-
|1D virtual pipes, 2D floodplain
|EG15_007.tcf
|-
|1D virtual pipes connected to 1D pipe network (trunk drainage line), 2D floodplain
|EG15_008.tcf
|-
|1D storage tank (1d_na)
|EG15_009.tcf
|-
|1D storage tank (1d_nwk)
|EG15_010.tcf
|-

| rowspan="6" id="Bulk Simulation Management" |Bulk Simulation Management
| rowspan="6" id="Scenario / Event Management" |Scenario / Event Management
|Scenario (single)
|EG16_~s1~_001.tcf
|-
|Scenario (multiple)
|EG16_~s1~_~s2~_002.tcf
|-
|Set Variable
|EG16_~s1~_~s2~_003.tcf
|-
|Event (single)
|EG16_~e1~_004.tcf
|-
|Event (multiple)
|EG16_~e1~_~e2~_005.tcf
|-
|Scenario (multiple), Event (multiple), Set Variable
|EG16_~s1~_~s2~_~e1~_~e2~_006.tcf
|-

| rowspan="5" id="Other" |Other
| rowspan="3" id="Advection Dispersion" |Advection Dispersion
|Advection Dispersion
|EG17_001.tcf
|-
|Advection Dispersion with settling
|EG17_002.tcf
|-
|Advection Dispersion with decay
|EG17_003.tcf
|-
| rowspan="3" id="Non-Newtonian" |Non-Newtonian
|Non-newtonian viscosity
|EG18_001.tcf
|-
|Non-newtonian mixing (dam failure scenario)
|EG18_002.tcf
|}

=Archive Dataset=
Historic example model datasets can be accessed via the following link: [[TUFLOW_Classic_Example_Model_Archive| TUFLOW Classic Example Model Archive]].

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