View source for Running TUFLOW

=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: [https://www.tuflow.com/Tuflow%20Latest%20Release.aspx Tuflow Release Download]
# Download the TUFLOW Tutorial and Demo models: [https://www.tuflow.com/Tuflow%20Tutorial%20Models.aspx Tutorial Model Download]
# 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 Version''' of TUFLOW:
# Download the latest TUFLOW executable from the Tuflow website: [https://www.tuflow.com/Tuflow%20Latest%20Release.aspx Tuflow Release Download]
# Download and install the Licensing Dongle Drivers: [[TUFLOW_Licensing|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\)<br><br>
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 Executable Section of the TUFLOW manual for advice when best to use the different TUFLOW versions. Each version of TUFLOW also has four TUFLOW .dll files and several system .dll files included in the download. Do not delete or relocate these dlls. All .exe and .dll 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]]

= 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.<br>

Common ways of initialising a TUFLOW simulation are:

* [[Run TUFLOW From a Batch-file|Using a Batch-file]]
* [[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++]]
* [[tuflow:images/d/dc/TextPad_TUFLOW_instructions.pdf |Textpad Instructions Including Running TUFLOW (Provided by CHM2Hill / Halcrow)]]
* [[Running_TUFLOW_from_Explorer | Running TUFLOW from Windows Explorer (Pre-Windows 7)]]
* [[QGIS_TUFLOW_Run_TUFLOW | From QGIS with the TUFLOW QGIS Plugin]]
* [[TUFLOW Runner|From QGIS with the TUFLOW Runner]]
* [[ArcTUFLOW_Run_TUFLOW_Simulation | From ArcMap with the ArcTUFLOW Toolbox]]
* For miTools users, please see the miTools manual for instructions.

==Multiple Simulation Management==
* [[Run TUFLOW From a Batch-file|Using a Batch-file]]
* [[TRIM_Tips| TUFLOW Run Interface Manager (TRIM)]]
* For miTools users, please see the miTools manual for instructions.
* [[TUFLOW Runner|From QGIS with the TUFLOW Runner]]

==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>