Run TUFLOW From a Batch-file - Revision history

Anne.Kolega: /* Automatically Create Folders in a TUFLOW model */ i.e.

2026-04-02T01:46:43Z

Automatically Create Folders in a TUFLOW model: i.e.

← Older revision		Revision as of 11:46, 2 April 2026
Line 84:		Line 84:

	===Automatically Create Folders in a TUFLOW model===		===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).<br>		The use of the -acf (automatically create folders) switch prevents the dialog prompt from appearing when encountering non-existent folders (i.e. 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).<br>
	An example is:<br>		An example is:<br>
	<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>		<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>
Line 100:		Line 100:
	Additional optional flags can be added to the base '''-c''' switch, in any combination, including:<br>		Additional optional flags can be added to the base '''-c''' switch, in any combination, including:<br>
	;* “a” (all);<br>		;* “a” (all);<br>
	: 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.<br>		: The addition of the “a” flag (e.g. -ca) copies all files of the same name for all input files (i.e. 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.<br>
	;*“L” (list);<br>		;*“L” (list);<br>
	: 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.		: 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.
Line 125:		Line 125:
	<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>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>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 -c switch automatically invokes the -t (i.e. 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.		<li>The -b option still applies if several models wish to be copied using a batch (.bat) file.
	</ol><br>		</ol><br>

Ellis Symons at 09:14, 10 December 2025

2025-12-10T09:14:49Z

← Older revision		Revision as of 19:14, 10 December 2025
Line 168:		Line 168:
	<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>		<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>

	====INI files====		====INI files with Events and Scenarios====
	An example of .ini file to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames.<br>		An example of .ini file to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames.<br>
	The model scenario and event options are required only if there are files that use the event or scenario variables in file names. This option does not limit the files that TUFLOW will package by scenario or event.		The model scenario and event options are required only if there are files that use the event or scenario variables in file names. This option does not limit the files that TUFLOW will package by scenario or event.

Ellis Symons: /* Package a TUFLOW model */

2025-12-02T08:31:30Z

Package a TUFLOW model

← Older revision		Revision as of 18:31, 2 December 2025
Line 148:		Line 148:
	: The addition of the “L” flag (e.g. -pmL) list the files to be copied into an output file, but don’t copy.<br>		: The addition of the “L” flag (e.g. -pmL) list the files to be copied into an output file, but don’t copy.<br>
	;* “ini” (file.ini)<br>		;* “ini” (file.ini)<br>
	: 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~~.<br>		: 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. Note, scenarios and events are specified to help the package model utility find files that use scenario or event variable names in file names and does not limit the package to specific event and scenarios. To limit the scenarios and events, please use the [[#Copy_a_TUFLOW_model \| copy model functionality]]. See the example below for more information.<br>

	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).<br>		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).<br>
Line 167:		Line 167:
	An example of package model that copies all files with specified .ini file (-pmAllini) is:<br>		An example of package model that copies all files with specified .ini file (-pmAllini) is:<br>
	<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>		<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:<br>
			====INI files====
		⚫	An example of .ini file to overwrite the default base and destination folders, and specify events/scenarios for models with events/scenarios in filenames.<br>
			The model scenario and event options are required only if there are files that use the event or scenario variables in file names. This option does not limit the files that TUFLOW will package by scenario or event.
			E.g. you may have the following command to read in either a base or development TIF grid:
			<pre>
			Read GRID Zpts == ..\model\grid\DEM_<<~s1~>>.tif
			</pre>
			In this example, we can assume that the <tt><<~s1~>></tt> variable could be replaced with either <tt>"Base"</tt> or <tt>"Dev"</tt>. The example ini file below shows how to ensure that TUFLOW will package both the "Base" and "Dev" files correctly. The same concept applies for event variables, noting that events defined in the event file (TEF) and their associated boundary files are not required to use this. It is only required if the event variable is used i.e. <tt><<~e1~>></tt>.
	<pre>		<pre>
	Base Folder == ~~<folder>~~		Base Folder == C:\TUFLOW\Model_to_Package
	Copy Destination == ~~<folder>~~		Copy Destination == C:\TUFLOW\Packaged_Model
	Model Scenario ~~~s<number>~~~ == ~~<scenario A> \| <scenario B>~~ \| …		Model Scenario ~s1~ == Base \| Dev
	Model Event ~~~e<number>~~~ == ~~<event A> \| <event B>~~ \| …		Model Event ~e1~ == 60m \| 90m
	</pre>		</pre>

Chris Huxley: /* Copy a TUFLOW model */

2025-06-25T01:29:23Z

Copy a TUFLOW model

← Older revision		Revision as of 11:29, 25 June 2025
Line 105:		Line 105:
	;* “p” (path); and<br>		;* “p” (path); and<br>
	: 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:<br>		: 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:<br>
	~~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><br>		<pre> start "TUFLOW" "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -cp "C:\put_model_here" "C:\TUFLOW\runs\M01_5m_001.tcf" </pre><br>
	;* “ncf” (no check files)<br>		;* “ncf” (no check files)<br>
	: The addition of the “ncf” flag (e.g. -cncf) copies the essential input files and excludes all check files.<br>		: The addition of the “ncf” flag (e.g. -cncf) copies the essential input files and excludes all check files.<br>

Pavlina Monhartova at 04:45, 17 April 2025

2025-04-17T04:45:55Z

← Older revision		Revision as of 14:45, 17 April 2025
Line 23:		Line 23:

	===Pause===		===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.		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 console 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"		<pre>"C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"
	pause</pre>		pause</pre>
Line 62:		Line 62:

	==No Console Option==		==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.		Using the -nc switch will run a simulation without opening a 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		<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_5m_001.tcf
Line 313:		Line 313:
	With the following line:<br>		With the following line:<br>
	<tt><u>echo</u> start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt><br>		<tt><u>echo</u> start "TUFLOW" /wait "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -b -e1 %%a -e2 %%b filename.tcf</tt><br>
	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.		By using the echo in the command line, rather than starting the simulations the command line will be displayed in the console window output. In the example above the console window output is shown in the image below.
	[[File:DOS nested batch output.png\|frame\|none]]		[[File:DOS nested batch output.png\|frame\|none]]

ElizaCollison: /* No Console Option */

2025-03-26T03:18:38Z

No Console Option

← Older revision		Revision as of 13:18, 26 March 2025
Line 66:		Line 66:
	<pre>Start "TUFLOW" /wait /min "C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe" -nc M01_5m_001.tcf		<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>		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==		== TUFLOW switches in a batch file==

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

2025-03-07T05:13:59Z

Copy model, checks and results in a looped batch file

← Older revision		Revision as of 15:13, 7 March 2025
Line 458:		Line 458:
	@echo off		@echo off

	set TUFLOWEXE_iSP=C:\Releases\2023-03-AF\TUFLOW_iSP_w64.exe		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 RUN_iSP=start "TUFLOW" /wait %TUFLOWEXE_iSP% -cp "D:\tuflow_models\copy"

	set A=5m 2.5m		set A=5m 2.5m

ElizaCollison: /* Variables */

2025-03-07T05:13:17Z

Variables

← Older revision		Revision as of 15:13, 7 March 2025
Line 283:		Line 283:
	%RUN% MR_H99_C25_Q050.tcf		%RUN% MR_H99_C25_Q050.tcf
	%RUN% MR_H99_C25_Q020.tcf</pre>		%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.		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===		===Looping in a batch file===

ElizaCollison: /* Variables */

2025-03-07T05:12:55Z

Variables

← Older revision		Revision as of 15:12, 7 March 2025
Line 283:		Line 283:
	%RUN% MR_H99_C25_Q050.tcf		%RUN% MR_H99_C25_Q050.tcf
	%RUN% MR_H99_C25_Q020.tcf</pre>		%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.		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===		===Looping in a batch file===

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

2025-03-07T05:12:00Z

Looping in a batch file using scenario logic

← Older revision		Revision as of 15:12, 7 March 2025
Line 408:		Line 408:
	REM ______________SET RUN VARIABLES_____________		REM ______________SET RUN VARIABLES_____________
	set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"		set TUFLOWEXE="C:\TUFLOW\Releases\2020-10-AE\TUFLOW_iSP_w64.exe"
	set RUN=start "TUFLOW" /low "%TUFLOWEXE%" -b		set RUN=start "TUFLOW" /low %TUFLOWEXE% -b
	set /a CPU_Cores=5		set /a CPU_Cores=5