Difference between revisions of "Running TUFLOW"
Jump to navigation
Jump to search
Chris Huxley (talk | contribs) |
|||
| (61 intermediate revisions by 10 users not shown) | |||
| Line 2: | Line 2: | ||
TUFLOW is a standalone console application. As such, it doesn't require installation to run. The standard TUFLOW setup steps are listed below. | TUFLOW is a standalone console application. As such, it doesn't require installation to run. The standard TUFLOW setup steps are listed below. | ||
| − | * Free DEMO and | + | * '''Free DEMO and Tutorial Version''' of TUFLOW: |
| − | # Download the latest TUFLOW executable from the | + | # Download the latest TUFLOW executable from the TUFLOW website: [https://www.tuflow.com/downloads/#tuflow TUFLOW Release Download] |
| − | # Download the TUFLOW Tutorial and Demo models: [ | + | # Download the TUFLOW Tutorial and Demo models: [https://www.tuflow.com/products/free-models/#tuflow_classic_hpc_models Tutorial Model Download] |
| − | # Run TUFLOW using any of the options listed below. User documentation for the tutorial models is available from the [[ | + | # Run TUFLOW using any of the options listed below. User documentation for the tutorial models is available from the [[Tutorial_Introduction | Tutorial Model Introduction]] section of the Wiki. |
| − | * Licensed | + | * '''Licensed Version''' of TUFLOW: |
| − | # Download the latest TUFLOW executable from the | + | # Download the latest TUFLOW executable from the TUFLOW website: [https://www.tuflow.com/downloads/#tuflow TUFLOW Release Download] |
# Download and install the Licensing Dongle Drivers: [[TUFLOW_Licensing|Installing Licensing Software]] | # Download and install the Licensing Dongle Drivers: [[TUFLOW_Licensing|Installing Licensing Software]] | ||
# Run TUFLOW using any of the options listed below. | # Run TUFLOW using any of the options listed below. | ||
| − | + | = Executable Management Advice = | |
Save a copy of the downloaded TUFLOW executable files to a dedicated location (eg. C:\TUFLOW\Releases\)<br><br> | Save a copy of the downloaded TUFLOW executable files to a dedicated location (eg. C:\TUFLOW\Releases\)<br><br> | ||
| − | A TUFLOW release consists of | + | A TUFLOW release consists of two different versions of the executable as follows: |
| − | |||
# TUFLOW_iSP_w64.exe - Single Precision Windows 64-bit | # TUFLOW_iSP_w64.exe - Single Precision Windows 64-bit | ||
| − | |||
# TUFLOW_iDP_w64.exe - Double Precision Windows 64-bit | # TUFLOW_iDP_w64.exe - Double Precision Windows 64-bit | ||
| − | |||
| − | When replacing TUFLOW with a new build, we recommend archiving the past .exe and .dll files by creating a folder of the same name as the Build ID (e.g. 2013-12-AA-iSP- | + | Refer to the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for advice when best to use the different TUFLOW versions. Do not delete or relocate any files in the TUFLOW release folder. All files must be placed in the same folder and kept together at all times. <br> |
| + | |||
| + | When replacing TUFLOW with a new build, we recommend archiving the past .exe and .dll files by creating a folder of the same name as the Build ID (e.g. 2013-12-AA-iSP-w64), and placing all files in this folder. Build ID information is appears in the top bar of the Console window when TUFLOW is executed, and is reported in the header of the .tlf file. | ||
<br>[[File:Executable_File_Management_001.png|600px]] | <br>[[File:Executable_File_Management_001.png|600px]] | ||
| − | + | = Run Options= | |
| − | There are a number of ways TUFLOW can be started, in each case the TUFLOW executable is started with the TUFLOW control file (.tcf) as the input. There are a number of optional switches that can be used to control advanced features as outlined in the TUFLOW | + | ==Single Simulation Execution== |
| + | There are a number of ways TUFLOW can be started, in each case the TUFLOW executable is started with the TUFLOW control file (.tcf) as the input. There are a number of optional switches that can be used to control advanced features as outlined in the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>.<br> | ||
Common ways of initialising a TUFLOW simulation are: | Common ways of initialising a TUFLOW simulation are: | ||
* [[Run TUFLOW From a Batch-file|Using a Batch-file]] | * [[Run TUFLOW From a Batch-file|Using a Batch-file]] | ||
| + | * [[TUFLOW Runner|Using the TUFLOW Runner]] | ||
* [[Run TUFLOW From UltraEdit|Running TUFLOW from UltraEdit]] | * [[Run TUFLOW From UltraEdit|Running TUFLOW from UltraEdit]] | ||
| + | * [[Run TUFLOW through the command window|Run TUFLOW through the command window]] | ||
* [[NotepadPlusPlus_Run_TUFLOW | Running TUFLOW from Notepad++]] | * [[NotepadPlusPlus_Run_TUFLOW | Running TUFLOW from Notepad++]] | ||
| − | * [ | + | * [[TextPad_Tips |Textpad Instructions Including Running TUFLOW (Provided by Jacobs)]] |
* [[Running_TUFLOW_from_Explorer | Running TUFLOW from Windows Explorer (Pre-Windows 7)]] | * [[Running_TUFLOW_from_Explorer | Running TUFLOW from Windows Explorer (Pre-Windows 7)]] | ||
* [[QGIS_TUFLOW_Run_TUFLOW | From QGIS with the TUFLOW QGIS Plugin]] | * [[QGIS_TUFLOW_Run_TUFLOW | From QGIS with the TUFLOW QGIS Plugin]] | ||
| Line 40: | Line 42: | ||
==Multiple Simulation Management== | ==Multiple Simulation Management== | ||
* [[Run TUFLOW From a Batch-file|Using a Batch-file]] | * [[Run TUFLOW From a Batch-file|Using a Batch-file]] | ||
| + | * [[TUFLOW Runner|Using the TUFLOW Runner]] | ||
* [[TRIM_Tips| TUFLOW Run Interface Manager (TRIM)]] | * [[TRIM_Tips| TUFLOW Run Interface Manager (TRIM)]] | ||
* For miTools users, please see the miTools manual for instructions. | * For miTools users, please see the miTools manual for instructions. | ||
| + | |||
| + | |||
| + | ==Scheduling Simulations== | ||
| + | * [[Using_Task_Scheduler_to_Run_Batch_Files|Using Task Scheduler]] | ||
| + | = Cloud Computing = | ||
| + | The "Cloud" is an excellent project execution environment option in situations where large simulation volumes require completion within a short timeframe (e.g. Monte Carlo runs). Three options are available. Click the links below for more information: | ||
| + | == Execution On Your Own Cloud Environment == | ||
| + | Organisations with access to Cloud hardware may host Network Licences within their own cloud domain (private or public).<br> | ||
| + | Click For Details: [[Organisation_Cloud_Software_Execution| Organisation Cloud Software Execution]]. <br> | ||
| + | |||
| + | == TUFLOW Cloud Simulation Service == | ||
| + | Let BMT help you manage your TUFLOW simulation execution on the cloud. This service is designed for bulk simulation of any TUFLOW product (Classic, HPC or FV).<br> | ||
| + | * Software licences are scaled to meet your project demand (i.e. this is independent of any in-house licences you may own). | ||
| + | * The BMT service offers flexibility regarding the Microsoft Azure Cloud hardware available for your project. We tailor the hardware and storage resource specification to suit your project requirements (based on project size, model size and also the simulation type). | ||
| + | * This service has no limitations in terms of hardware type. We offer simulation on a range of CPU and GPU virtual machines.<br> | ||
| + | This service is well suited to mass production runs of an established model (often required for design event modelling or a Monte Carlo assessment). It is less suited to model build activities that require regular modeller/model interaction and iterations. We recommend model build activities be completed using a standard client licence as it is typically the most cost effective and time efficient option.<br> | ||
| + | Click For Details: [[TUFLOW_Cloud_Simulation_Service| TUFLOW Cloud Simulation Service]].<br> | ||
Latest revision as of 19:19, 26 September 2024
Introduction
TUFLOW is a standalone console application. As such, it doesn't require installation to run. The standard TUFLOW setup steps are listed below.
- Free DEMO and Tutorial Version of TUFLOW:
- Download the latest TUFLOW executable from the TUFLOW website: TUFLOW Release Download
- Download the TUFLOW Tutorial and Demo models: Tutorial Model Download
- Run TUFLOW using any of the options listed below. User documentation for the tutorial models is available from the Tutorial Model Introduction section of the Wiki.
- Licensed Version of TUFLOW:
- Download the latest TUFLOW executable from the TUFLOW website: TUFLOW Release Download
- Download and install the Licensing Dongle Drivers: Installing Licensing Software
- Run TUFLOW using any of the options listed below.
Executable Management Advice
Save a copy of the downloaded TUFLOW executable files to a dedicated location (eg. C:\TUFLOW\Releases\)
A TUFLOW release consists of two different versions of the executable as follows:
- TUFLOW_iSP_w64.exe - Single Precision Windows 64-bit
- TUFLOW_iDP_w64.exe - Double Precision Windows 64-bit
Refer to the TUFLOW Manual for advice when best to use the different TUFLOW versions. Do not delete or relocate any files in the TUFLOW release folder. All files must be placed in the same folder and kept together at all times.
When replacing TUFLOW with a new build, we recommend archiving the past .exe and .dll files by creating a folder of the same name as the Build ID (e.g. 2013-12-AA-iSP-w64), and placing all files in this folder. Build ID information is appears in the top bar of the Console window when TUFLOW is executed, and is reported in the header of the .tlf file.
Run Options
Single Simulation Execution
There are a number of ways TUFLOW can be started, in each case the TUFLOW executable is started with the TUFLOW control file (.tcf) as the input. There are a number of optional switches that can be used to control advanced features as outlined in the TUFLOW Manual.
Common ways of initialising a TUFLOW simulation are:
- Using a Batch-file
- Using the TUFLOW Runner
- Running TUFLOW from UltraEdit
- Run TUFLOW through the command window
- Running TUFLOW from Notepad++
- Textpad Instructions Including Running TUFLOW (Provided by Jacobs)
- Running TUFLOW from Windows Explorer (Pre-Windows 7)
- From QGIS with the TUFLOW QGIS Plugin
- From ArcMap with the ArcTUFLOW Toolbox
- For miTools users, please see the miTools manual for instructions.
Multiple Simulation Management
- Using a Batch-file
- Using the TUFLOW Runner
- TUFLOW Run Interface Manager (TRIM)
- For miTools users, please see the miTools manual for instructions.
Scheduling Simulations
Cloud Computing
The "Cloud" is an excellent project execution environment option in situations where large simulation volumes require completion within a short timeframe (e.g. Monte Carlo runs). Three options are available. Click the links below for more information:
Execution On Your Own Cloud Environment
Organisations with access to Cloud hardware may host Network Licences within their own cloud domain (private or public).
Click For Details: Organisation Cloud Software Execution.
TUFLOW Cloud Simulation Service
Let BMT help you manage your TUFLOW simulation execution on the cloud. This service is designed for bulk simulation of any TUFLOW product (Classic, HPC or FV).
- Software licences are scaled to meet your project demand (i.e. this is independent of any in-house licences you may own).
- The BMT service offers flexibility regarding the Microsoft Azure Cloud hardware available for your project. We tailor the hardware and storage resource specification to suit your project requirements (based on project size, model size and also the simulation type).
- This service has no limitations in terms of hardware type. We offer simulation on a range of CPU and GPU virtual machines.
This service is well suited to mass production runs of an established model (often required for design event modelling or a Monte Carlo assessment). It is less suited to model build activities that require regular modeller/model interaction and iterations. We recommend model build activities be completed using a standard client licence as it is typically the most cost effective and time efficient option.
Click For Details: TUFLOW Cloud Simulation Service.