TUFLOW Runner - Revision history

Robert.Graham at 01:05, 11 June 2025

2025-06-11T01:05:18Z

← Older revision		Revision as of 11:05, 11 June 2025
Line 39:		Line 39:
	The resources tab at the top of the dialog is to specify the machine limits for the number of GPU cards and CPU threads. These will generally only be limiting if you are running both TUFLOW and TUFLOW FV at the same time. Otherwise, model specific limitations will prevent exceeding these limits.		The resources tab at the top of the dialog is to specify the machine limits for the number of GPU cards and CPU threads. These will generally only be limiting if you are running both TUFLOW and TUFLOW FV at the same time. Otherwise, model specific limitations will prevent exceeding these limits.

	To discover ~~your~~ computer's NVIDIA GPU hardware, see <u>[[Console_Window_GPU_Usage \| NVIDIA GPU Hardware and Usage]]</u>.		To discover a computer's NVIDIA GPU hardware, see <u>[[Console_Window_GPU_Usage \| NVIDIA GPU Hardware and Usage]]</u>.

	TUFLOW and TUFLOW FV each have their own tab to specify executable locations and configuration parameters. For each configuration, you can choose whether to run with one or more GPUs and how many CPU threads to make available. These settings will override settings specified in the input files (for TUFLOW this requires that the "write hardware flags" is specified and you are using 2023-03-AB release or later). Because TUFLOW may use multiple threads during the initial setup phase but a GPU card during the hydraulic calculations when doing GPU simulations, it is recommended to set the number of CPU threads to the number of cores available on the machine and the reserve value to 0. CPU simulations will generally use the same number of threads for reserved and the primary CPU thread setting. Set the configurations to not exceed available licenses.		TUFLOW and TUFLOW FV each have their own tab to specify executable locations and configuration parameters. For each configuration, you can choose whether to run with one or more GPUs and how many CPU threads to make available. These settings will override settings specified in the input files (for TUFLOW this requires that the "write hardware flags" is specified and you are using 2023-03-AB release or later). Because TUFLOW may use multiple threads during the initial setup phase but a GPU card during the hydraulic calculations when doing GPU simulations, it is recommended to set the number of CPU threads to the number of cores available on the machine and the reserve value to 0. CPU simulations will generally use the same number of threads for reserved and the primary CPU thread setting. Set the configurations to not exceed available licenses.

Robert.Graham: Link to NVIDIA SMI added

2025-06-11T00:22:13Z

Link to NVIDIA SMI added

← Older revision		Revision as of 10:22, 11 June 2025
Line 38:		Line 38:

	The resources tab at the top of the dialog is to specify the machine limits for the number of GPU cards and CPU threads. These will generally only be limiting if you are running both TUFLOW and TUFLOW FV at the same time. Otherwise, model specific limitations will prevent exceeding these limits.		The resources tab at the top of the dialog is to specify the machine limits for the number of GPU cards and CPU threads. These will generally only be limiting if you are running both TUFLOW and TUFLOW FV at the same time. Otherwise, model specific limitations will prevent exceeding these limits.

			To discover your computer's NVIDIA GPU hardware, see <u>[[Console_Window_GPU_Usage \| NVIDIA GPU Hardware and Usage]]</u>.

	TUFLOW and TUFLOW FV each have their own tab to specify executable locations and configuration parameters. For each configuration, you can choose whether to run with one or more GPUs and how many CPU threads to make available. These settings will override settings specified in the input files (for TUFLOW this requires that the "write hardware flags" is specified and you are using 2023-03-AB release or later). Because TUFLOW may use multiple threads during the initial setup phase but a GPU card during the hydraulic calculations when doing GPU simulations, it is recommended to set the number of CPU threads to the number of cores available on the machine and the reserve value to 0. CPU simulations will generally use the same number of threads for reserved and the primary CPU thread setting. Set the configurations to not exceed available licenses.		TUFLOW and TUFLOW FV each have their own tab to specify executable locations and configuration parameters. For each configuration, you can choose whether to run with one or more GPUs and how many CPU threads to make available. These settings will override settings specified in the input files (for TUFLOW this requires that the "write hardware flags" is specified and you are using 2023-03-AB release or later). Because TUFLOW may use multiple threads during the initial setup phase but a GPU card during the hydraulic calculations when doing GPU simulations, it is recommended to set the number of CPU threads to the number of cores available on the machine and the reserve value to 0. CPU simulations will generally use the same number of threads for reserved and the primary CPU thread setting. Set the configurations to not exceed available licenses.

	If you have 2 GPUs and 24 threads available with licenses to support them, the configurations could be setup multiple ways to maximum the complete resources:		If you have 2 GPUs and 24 threads available with licenses to support them, the configurations could be setup multiple ways to maximum the complete resources:
	* Option 1 - Three configurations where two have a GPU, 12 threads, and 0 threads reserved and a configuration with 0 GPUs with 24 threads and 24 threads reserved.		*Option 1 - Three configurations where two have a GPU, 12 threads, and 0 threads reserved and a configuration with 0 GPUs with 24 threads and 24 threads reserved.
	* Option 2 - Two configurations where one has 2 GPUs, 12 threads, and 0 threads reserved and a configuration with 0 GPUs with 24 threads and 24 threads reserved.		*Option 2 - Two configurations where one has 2 GPUs, 12 threads, and 0 threads reserved and a configuration with 0 GPUs with 24 threads and 24 threads reserved.

	For either of these options, simulations would try to run on the first specified configuration first so you would want the GPU configurations listed first to take advantage of these resources first.		For either of these options, simulations would try to run on the first specified configuration first so you would want the GPU configurations listed first to take advantage of these resources first.
Line 61:		Line 63:

	'''Please note:''' For TUFLOW model which includes Scenario and/Events, the (~s~) and/or (~e~) must be included in the simulation filename.		'''Please note:''' For TUFLOW model which includes Scenario and/Events, the (~s~) and/or (~e~) must be included in the simulation filename.
	*Then, toggle on '''Run''' to run the simulation.		* Then, toggle on '''Run''' to run the simulation.
	[[File:Running the tool 3.jpg\|750px]]		[[File:Running the tool 3.jpg\|750px]]

RustyJonesTUFLOW: /* Running Multiple Simulation */

2024-04-25T22:00:28Z

Running Multiple Simulation

← Older revision		Revision as of 08:00, 26 April 2024
Line 65:		Line 65:

	==Running Multiple Simulation==		==Running Multiple Simulation==
	If ~~the resources and configurations (do not create more configurations than you have licenses for), allow for it, the Runner~~ will launch ~~multiple~~ simulations ~~at the same time~~ as ~~long~~ as ~~there~~ ~~are~~ ~~simulations~~ in ~~the~~ ~~queue~~ ~~able~~ to ~~be run~~. As simulations finish, ~~the~~ ~~next~~ ~~available~~ ~~simulation~~ ~~that~~ ~~does~~ ~~not~~ ~~exceed~~ available ~~resources and configurations will be run~~.		The runner will launch as many simulations as available in the queue depending on computer resources and model configurations. As model simulations finish, new simulations will be launched as resources become available.

	==Troubleshooting==		==Troubleshooting==

RustyJonesTUFLOW: /* Setting up the TUFLOW Runner */

2024-04-25T21:47:36Z

Setting up the TUFLOW Runner

← Older revision		Revision as of 07:47, 26 April 2024
Line 39:		Line 39:
	The resources tab at the top of the dialog is to specify the machine limits for the number of GPU cards and CPU threads. These will generally only be limiting if you are running both TUFLOW and TUFLOW FV at the same time. Otherwise, model specific limitations will prevent exceeding these limits.		The resources tab at the top of the dialog is to specify the machine limits for the number of GPU cards and CPU threads. These will generally only be limiting if you are running both TUFLOW and TUFLOW FV at the same time. Otherwise, model specific limitations will prevent exceeding these limits.

	TUFLOW and TUFLOW FV each have their own tab to specify executable locations and configuration parameters. For each configuration, you can choose whether to run with one or more GPUs and how many CPU threads to make available. These settings will override settings specified in the input files (for TUFLOW this requires that the "write hardware flags" is specified and you are using 2023-03-AB release or later). Because TUFLOW may use multiple threads during the initial setup phase but a GPU card during the hydraulic calculations, it is recommended to set the number of CPU threads to the number of cores available on the machine ~~when doing GPU simulations~~ and ~~setting~~ the reserve value to 0. CPU simulations will generally use the same number of threads for reserved and the primary CPU thread setting. Set the configurations to not exceed available licenses.		TUFLOW and TUFLOW FV each have their own tab to specify executable locations and configuration parameters. For each configuration, you can choose whether to run with one or more GPUs and how many CPU threads to make available. These settings will override settings specified in the input files (for TUFLOW this requires that the "write hardware flags" is specified and you are using 2023-03-AB release or later). Because TUFLOW may use multiple threads during the initial setup phase but a GPU card during the hydraulic calculations when doing GPU simulations, it is recommended to set the number of CPU threads to the number of cores available on the machine and the reserve value to 0. CPU simulations will generally use the same number of threads for reserved and the primary CPU thread setting. Set the configurations to not exceed available licenses.

	If you have 2 GPUs and 24 threads available with licenses to support them, the configurations could be setup multiple ways to maximum the complete resources:		If you have 2 GPUs and 24 threads available with licenses to support them, the configurations could be setup multiple ways to maximum the complete resources:

RustyJonesTUFLOW: /* Setting up the TUFLOW Runner */

2024-04-25T21:46:04Z

Setting up the TUFLOW Runner

← Older revision		Revision as of 07:46, 26 April 2024
Line 34:		Line 34:

	Before using the runner, the computer settings need to be specified. You can do this by Choosing '''Settings''' option from the Menu.		Before using the runner, the computer settings need to be specified. You can do this by Choosing '''Settings''' option from the Menu.

	[[File:Setting Runner 1.jpg\|550px\|]]<br>		[[File:Setting Runner 1.jpg\|550px\|]]<br>

RustyJonesTUFLOW: /* Setting up the TUFLOW Runner */

2024-04-25T21:45:35Z

Setting up the TUFLOW Runner

@@ Line 33: / Line 33: @@
 * If running through the QGIS Plugin, in the QGIS menu select '''Plugins >> TUFLOW >> RUN >> Launch TUFLOW Runner'''.
 [[File:Setting Runner 1.jpg|550px|]]<br>
 [[File:Setting Runner 2.jpg|550px|]]<br>
 ==Running the tool==

Angelos Livogiannis at 12:43, 19 April 2024

2024-04-19T12:43:41Z

← Older revision		Revision as of 22:43, 19 April 2024
Line 1:		Line 1:
	===Page Under Construction===
	==Introduction==		==Introduction==
	The TUFLOW Runner provides a simple GUI for creating a queue of TUFLOW and TUFLOW FV simulations which will be run depending on available licenses and resources. The runner is available from the [https://gitlab.com/tuflow-user-group/tuflow/simulation-management/tuflow-runner TUFLOW GitLAB User Group] and is also bundled with the TUFLOW QGIS plugin. The TUFLOW Runner can replace the need for batch files.		The TUFLOW Runner provides a simple GUI for creating a queue of TUFLOW and TUFLOW FV simulations which will be run depending on available licenses and resources. The runner is available from the [https://gitlab.com/tuflow-user-group/tuflow/simulation-management/tuflow-runner TUFLOW GitLAB User Group] and is also bundled with the TUFLOW QGIS plugin. The TUFLOW Runner can replace the need for batch files.

RustyJonesTUFLOW: /* Running Multiple Simulation */

2024-04-19T12:40:42Z

Running Multiple Simulation

← Older revision		Revision as of 22:40, 19 April 2024
Line 54:		Line 54:

	==Running Multiple Simulation==		==Running Multiple Simulation==
			If the resources and configurations (do not create more configurations than you have licenses for), allow for it, the Runner will launch multiple simulations at the same time as long as there are simulations in the queue able to be run. As simulations finish, the next available simulation that does not exceed available resources and configurations will be run.
	Multiple simulations can be run with the TUFLOW Runner. To do so, follow the steps which are described in '''Running the tool''' section and before running, '''Add''' to the queue more than one simulation files. If a simulation runs and you need to queue a new simulation, choose your new simulation file, and just click on '''Add''' button. The new simulation will be queued, automatically showing waiting status. Also, while running other simulations, you can re-launch the TUFLOW Runner for creating new queues and start new simulations.


	==Troubleshooting==		==Troubleshooting==

RustyJonesTUFLOW: /* Running the tool */

2024-04-19T12:36:37Z

Running the tool

← Older revision		Revision as of 22:36, 19 April 2024
Line 46:		Line 46:
	*Identify the folder that contains the simulation files ('''Base folder''') and select the simulation file. This must be .tcf for TUFLOW Classic/HPC or .fvc for TUFLOW FV.		*Identify the folder that contains the simulation files ('''Base folder''') and select the simulation file. This must be .tcf for TUFLOW Classic/HPC or .fvc for TUFLOW FV.
	[[File:Running the tool 1.jpg\|550px\|]]<br>		[[File:Running the tool 1.jpg\|550px\|]]<br>
	*Click on the '''Add''' button to add a simulation to the queue. If a TUFLOW model includes Events (~e~) and/or Scenarios (~s~) by clicking on the '''Add''' button a '''dialog''' (please see image below) will come up to add model’s Scenarios and/or Events.''' If ~~default~~ ~~Scenarios~~ ~~are~~ ~~included,~~ ~~please~~ use '_'.''' ~~For~~ ~~each~~ combination of ~~Events~~ and ~~Scenarios~~ a ~~bunch~~ of ~~runs~~ are ~~shown~~ up at ~~the~~ ~~bottom~~ of the ~~window.~~		*Click on the '''Add''' button to add a simulation to the queue. If a TUFLOW model includes Events (~e~) and/or Scenarios (~s~) by clicking on the '''Add''' button a '''dialog''' (please see image below) will come up to add model’s Scenarios and/or Events. ''' To add simulations, there must be selected scenarios and events in every category. You can use '_' or another placeholder as needed for default scenarios.''' The bottom of the window shows the combination of selected events and scenarios. To get the sub-list you are interested in, you may need to use the add command several times.
	[[File:Running the tool 2.jpg\|550px\|]]<br>		[[File:Running the tool 2.jpg\|550px\|]]<br>

Line 53:		Line 53:
	[[File:Running the tool 3.jpg\|750px]]		[[File:Running the tool 3.jpg\|750px]]


	==Running Multiple Simulation==		==Running Multiple Simulation==
	Multiple simulations can be run with the TUFLOW Runner. To do so, follow the steps which are described in '''Running the tool''' section and before running, '''Add''' to the queue more than one simulation files. If a simulation runs and you need to queue a new simulation, choose your new simulation file, and just click on '''Add''' button. The new simulation will be queued, automatically showing waiting status. Also, while running other simulations, you can re-launch the TUFLOW Runner for creating new queues and start new simulations.		Multiple simulations can be run with the TUFLOW Runner. To do so, follow the steps which are described in '''Running the tool''' section and before running, '''Add''' to the queue more than one simulation files. If a simulation runs and you need to queue a new simulation, choose your new simulation file, and just click on '''Add''' button. The new simulation will be queued, automatically showing waiting status. Also, while running other simulations, you can re-launch the TUFLOW Runner for creating new queues and start new simulations.

RustyJonesTUFLOW: /* Setting up the TUFLOW Runner */

2024-04-19T12:33:55Z

Setting up the TUFLOW Runner

← Older revision		Revision as of 22:33, 19 April 2024
Line 30:		Line 30:

	==Setting up the TUFLOW Runner==		==Setting up the TUFLOW Runner==
			Launch the runner.
⚫	~~The~~ ~~tool~~ ~~can~~ be ~~found~~ ~~via~~ the QGIS menu '''Plugins >> TUFLOW >> RUN >> Launch TUFLOW Runner'''. ~~To set up:~~
			* If running from python, launch the "main.py" script.
		⚫	* If running through the QGIS Plugin, in the QGIS menu select '''Plugins >> TUFLOW >> RUN >> Launch TUFLOW Runner'''.

			To set up:
	*Choose '''Settings''' option from the Menu.		*Choose '''Settings''' option from the Menu.
	[[File:Setting Runner 1.jpg\|550px\|]]<br>		[[File:Setting Runner 1.jpg\|550px\|]]<br>
Line 36:		Line 40:
	[[File:Setting Runner 2.jpg\|550px\|]]<br>		[[File:Setting Runner 2.jpg\|550px\|]]<br>
	*Then, click '''OK'''.		*Then, click '''OK'''.



	==Running the tool==		==Running the tool==