New User Installation Guide

Introduction

Welcome to TUFLOW. This is a page for new users outlining the steps required run TUFLOW for the first time.

the standard TUFLOW setup steps are listed below for the three common licence types:

1. User_Guide_Free_DemoFree DEMO Version
2. Local Licences
3. Network Licences

   Free DEMO Version of TUFLOW

   This section is relevant for people who are trialing TUFLOW without a licence. Please skip to the next section if you have a licence.

   1. Download the latest TUFLOW executable from the TUFLOW website: Tuflow Release Download. TUFLOW is a standalone console application. As such, it doesn't require installation to run.
   2. Download the TUFLOW Tutorial Dataset: Tutorial Model Download
   3. User documentation is available from the Tutorial Model section of the Wiki. Learn how to use TUFLOW by following the user documentation.
   4. Run TUFLOW using any of the options listed in the Running TUFLOW section of the Wiki.
   5. After gaining an understanding of TUFLOW through the tutorial model dataset you may be interested in developing some of your own models for testing. A free Demo option is included within the standard TUFLOW executable. The free Demo version is fully enabled, though has the following limits:

      • 100,000 total cells and 30,000 active (potentially flooded) cells
      • 100 1D channels
      • There can on be is only one 2D domain (multiple 2D domains are not supported)
      • A simulation time of 10 minutes.

      The free Demo mode is called using the TUFLOW Control File (TCF) command: Demo Model == ON
      
   6. Over 60 example models demonstrating the most commonly used TUFLOW features are available from the Example Models section of the Wiki. These models call the Demo mode mentioned above, and as such don't require a licence to run. Use these models to learn how to implement features not included in the TUFLOW Tutorials. Refer to the TUFLOW Manual for further supporting information.
   7. Other useful information is contained in the Wiki. In particular new users often find the Tips and Tricks section on the right-hand side of the home page and the Modelling Guidance sections particularly useful.
   8. If you're interested in becoming a part of the TUFLOW User Community please join the TUFLOW Forum and LinkedIn User Group.
   9. Please email support@tuflow.com if you have any technical questions or sales@tuflow.com if you would like to purchase a licence. Price information is available from the TUFLOW Website
   
   

   Licenced Version of TUFLOW

   1. Download the latest TUFLOW executable from the TUFLOW website: Tuflow Release Download. TUFLOW is a standalone console application. As such, it doesn't require installation to run.
      Local Licence
      • Plug your new Local licence dongle into your computer.
      • Download and install the Licencing Dongle Drivers (CodeMeter RunTime Kit): Installing Licensing Software
      • Follow the steps listed in the Licence Update Request section of the Wiki. You will need to email the licence file to sales@tuflow.com. The sales team with email you an updated licence file containing your specific licence configuration.
      • Import the updated licence file to accept the licence update ( Licence Import
      • After activating your licence, insert your Local licence dongle in your computer (if it isn't already). Double click the TUFLOW Executable (for example TUFLOW_iSP_w64.exe). A DOS window should open. Review the licence information listed. Check the licence types and numbers.

      
      

      Press enter to close the DOS window.

      Note: Local TUFLOW licences are associated with the USB dongle. All computers running TUFLOW must have Licencing Dongle Drivers (CodeMeter RunTime Kit) installed and the USB dongle plugged in for a simulation to initialise. The Licence Update Request should only be required once annually to update the USB dongle licence and provide access to new updated versions of TUFLOW.

      • You are now ready to start TUFLOW modelling. Continue to bullet point 3.
      Network Licence
      • Download and install the Licencing Dongle Drivers (CodeMeter RunTime Kit) on the Network Host computer: Installing Licensing Software.

      Note: The Network Host does not need to be a server. It can be a standard computer connected to Local Area Network of your company. If this is the case, make sure the Host computer remains on at all times and the computer is assigned a static IP address.

      • Follow the steps listed in the Licence Update Request section of the Wiki if you have been sent a new Network licence dongle. You will need to email the licence file to sales@tuflow.com. The sales team with email you an updated licence file containing your specific licence configuration.
      • Import the updated licence file to accept the licence update ( Licence Import
      • After activating your licence insert your Network licence dongle in the Network Host computer (if it isn't already). Double click the TUFLOW Executable (for example TUFLOW_iSP_w64.exe) from the Network Host computer. A DOS window should open. Review the licence information listed. Check the licence types and numbers.

      
      

      • Install Licencing Dongle Drivers (CodeMeter RunTime Kit) on all client computers wishing to access licences from the Network Host.
      • Configure Access to the Network licences on all client computers.
      • Double click the TUFLOW Executable (for example TUFLOW_iSP_w64.exe) from the client computer. A DOS window should open. Review the licence information listed (example shown above). Check the licence types and numbers.
      • You are now ready to start TUFLOW modelling. Continue to bullet point 2.
   2. Download the TUFLOW Tutorial Dataset: Tutorial Model Download
   3. User documentation is available from the Tutorial Model section of the Wiki. Learn how to use TUFLOW by following the user documentation.
   4. Run TUFLOW using any of the options listed in the Running TUFLOW section of the Wiki.
   5. Over 60 example models demonstrating the most commonly used TUFLOW features are available from the Example Models section of the Wiki. These models call the Demo mode mentioned above, and as such don't require a licence to run. Use these models to learn how to implement features not included in the TUFLOW Tutorials. Refer to the TUFLOW Manual for further supporting information.
   6. Other useful information is contained in the Wiki. In particular new users often find the Tips and Tricks section on the right-hand side of the home page and the Modelling Guidance sections particularly useful.
   7. If you're interested in becoming a part of the TUFLOW User Community please join the TUFLOW Forum and LinkedIn User Group.
   8. Please email support@tuflow.com if you have any technical questions or sales@tuflow.com if you would like to purchase additional licences or add-on modules. Price information is available from the TUFLOW Website