2.3 Installing and Running TUFLOW

2.3.1 TUFLOW Downloads and Installation

TUFLOW does not require an installer, but instead simply requires the user to copy or unzip the downloaded files into a folder. This approach allows the modeller to have as many releases or versions of TUFLOW available as required. This is beneficial, as there is often a need to run or re-run legacy models using older TUFLOW versions. The current TUFLOW release version, Manual and Release Notes are available via the TUFLOW website Downloads page. All past TUFLOW versions are available from the Downloads Archive.

Section 13.3.1 provides more information on downloading and installing TUFLOW. Detailed step-by-step instructions for new users are also provided on the TUFLOW Wiki New User Installation Guide.

2.3.2 TUFLOW Licencing

A TUFLOW licence is required to run TUFLOW, but is not required when using third-party software such as a GIS, text editor or GUI. Licences are hosted on hardware locks (e.g. USB-2 lock), software locks (e.g. via a configuration file housed on a particular computer, server or cloud virtual machine), or from a TUFLOW Cloud Server. Email for a quote to purchase a TUFLOW licence. For further licencing information refer to Section 13.4.1 and the TUFLOW installation instructions on the TUFLOW Wiki Licensing Page.

TUFLOW can be used licence free for the TUFLOW Tutorials (Section 2.1.1), Example models (Section 2.1.2) or when running TUFLOW using Demo Mode (Section 2.1.4).

All TUFLOW use is governed by the TUFLOW Products End User Licence Agreement. By installing and/or using a TUFLOW Product you agree to the terms of the TUFLOW Products End User Licence Agreement.

2.3.2.1 3rd Party Software Libraries

TUFLOW and its utilities rely on several 3rd party software libraries which are either open source or have permissive licences. These libraries, with links to their respective licence agreements, are listed below:

2.3.3 Performing Simulations

TUFLOW simulations are started by running the TUFLOW executable and passing the input TUFLOW control file (.tcf). There are a number of ways of initiating simulations:

  • Running a batch file. Batch files can be used to run single TUFLOW simulations but also can be set up to loop through events and scenarios to run a multitude of simulations or to push simulations to different processors.
  • From the text editor – ideal for one off simulations, especially whilst constructing a model.
  • Directly from GIS software.
  • Using Microsoft Explorer to right click and run.
  • Via a GUI, such as the SMS TUFLOW Interface or 12D.
  • From a Command (Console) Window.

Detailed descriptions on running TUFLOW from the above methods are provided on the TUFLOW Wiki Running TUFLOW.