Latest revision as of 20:08, 20 November 2024

Introduction

A TUFLOW licence is required to run TUFLOW, except when running TUFLOW demo, tutorial or example models in licence free mode.

Licence Hosting Options

TUFLOW offers a variety of licence hosting approaches. Instructions are provided below for all available methods:

Licence Free Mode: A licence free mode has been built into TUFLOW. For information outlining the limits associated with the licence free mode, see TUFLOW Free DEMO Version Guide
Local Licence: In this form, TUFLOW simulations can only be run on the computer hosting the licence lock. For installation guidance see:

Network Licence: In this form, the licence lock can be hosted on any computer or server. Other computers utilise available licences from the host computer via a company’s network. For installation guidance see:

Network Cloud Licence: In this form, the licence lock is hosted on a WIBU cloud server. For installation guidance see:

Cloud Direct Licence Installation Guide: All modelling computers link directly to the WIBU server over an internet connection.
Cloud Server Licence Installation Guide: A company server acts as the licence host, linked to the WIBU server over an internet connection. Modelling computers are connected to the company server via the company’s network.

Refer to the WIBU Lock Guidance for further information how to install, update and manage TUFLOW licences for all of the available licence hosting approaches.

Note Legacy Licence Type (Softlok Dongle): As of August 2010, Softlok USB dongles are no longer issued or supported due to the dongle provider not supporting 64-bit. For TUFLOW release versions 2009-07, 2008-08, 2007-07 and 2006-06, the “DB” build or later will need to be used to function with a WIBU Codemeter dongle hardware lock. Also, upgrade to release version 2016-03-AF or newer is required if WIBU Software or Cloud locks are being used for the licencing.

Frequently Asked Questions (FAQ)

How many simulations can be run at the same time?

The number of licences reflect how many TUFLOW simulations can be run in parallel at any given time. For example, a Local 4 can run 4 simulations at the same time on the one computer. A Network 5 allows up to 5 simulations at any one time across an organisation’s network. If all licences are in use when a TUFLOW simulation starts, the simulation enters a holding pattern until a free licence is available.

What is the best licence for me?

Hardware (USB) vs. Software (Digital File)

The advantage of a hardware (USB) lock is that it is portable and not tied to a specific computer. You can unplug it and plug it into another computer.
A software lock is tied to a specific computer and cannot be moved once bound to that computer. The advantage of a software lock however is that it can be installed on a computer that you don't have physical access to, and it doesn't require a free USB port.

Local vs. Network

The advantage of a local lock is that you only need CodeMeter installed on the computer that will be running your TUFLOW software, and the required configuration will be minimal. No network access beyond this computer is required. The lock is either installed directly on this local CodeMeter, as a software lock, or CodeMeter will pick up an inserted hardware lock automatically.

The advantage of a network lock is that you can host multiple licences in a single place (called the CodeMeter Network Server). Licences are shared to client (modelling) computers from the server over your network. To function, these computers need to be able to access the Network Server over port 22350, which may require some co-operation of your IT staff to configure.

Cloud vs. non-Cloud

The advantage of a Cloud licence is that you can set it up on as many machines as you like, and reuse it on future machines, for as long as the licence is valid. This gives you a similar advantage to using a Network Licence, without the complexity of network connectivity. Another benefit of this is that you can put the licence on computers that are not connected to your local network. A potential disadvantage of a Cloud licence can be the requirement that the computer it is installed on has https (web) internet access to `wibu.cloud`. It is worth noting that currently the monitoring of Cloud licence usage is not as mature as the monitoring of network licences.

Up
TUFLOW Main Page

@@ Line 1: / Line 1: @@
 =Introduction=
-A TUFLOW licence is required to run TUFLOW, except when using third party software such as a GIS to prepare input data or view results, or when running TUFLOW demo, tutorial or example models in licence free mode.<br>
+A TUFLOW licence is required to run TUFLOW, except when running TUFLOW demo, tutorial or example models in licence free mode.<br>
-==Lock Types==
+== Licence Hosting Options==
-TUFLOW Products are licenced via Codemeter locks, available in three forms; WIBU USB-2 Dongles (Hardware lock), WIBU Software Licences (Software lock) and WIBU Cloud locks. <br>
+TUFLOW offers a variety of licence hosting approaches. Instructions are provided below for all available methods:
-Refer to <u>[[Wibu_Dongles |WIBU Lock Guidance]]</u> for further information.
+* '''Licence Free Mode''': A licence free mode has been built into TUFLOW. For information outlining the limits associated with the licence free mode, see <u>[[New_User_Guide_Free_Demo_Version | TUFLOW Free DEMO Version Guide]]</u>
+* '''Local Licence''': In this form, TUFLOW simulations can only be run on the computer hosting the licence lock. For installation guidance see:
+<ol>
+* <u>[[New_User_Guide_Local_Hardware_Licences | Local Licence USB Hardware Lock (USB) Installation Guide]]</u><br>
+* <u>[[New_User_Guide_Local_Software_Licences | Local Licence USB Software Lock (Digital) Installation Guide]]</u><br>
+</ol>
+* '''Network Licence''': In this form, the licence lock can be hosted on any computer or server. Other computers utilise available licences from the host computer via a company’s network. For installation guidance see:
+<ol>
+* <u>[[New_User_Guide_Network_Hardware_Licences | Network Licence Hardware Lock (USB) Installation Guide]]</u>.<br>
+* <u>[[New_User_Guide_Network_Software_Licences | Network Licence Software Lock (Digital) Installation Guide]]</u>.<br>
+</ol>
+* '''Network Cloud Licence''': In this form, the licence lock is hosted on a WIBU cloud server. For installation guidance see:
+<ol>
+* <u>[[New_User_Guide_Cloud_Direct_Licences | Cloud Direct Licence Installation Guide]]</u>: All modelling computers link directly to the WIBU server over an internet connection.<br>
+* <u>[[New_User_Guide_Cloud_Server_Licences |Cloud Server Licence Installation Guide]]</u>: A company server acts as the licence host, linked to the WIBU server over an internet connection. Modelling computers are connected to the company server via the company’s network.<br>
+</ol>
-Legacy Licence Type (Softlok Dongle): As of August 2010 Softlok USB dongles are no longer issued or supported due to the dongle provider not supporting 64-bit. For TUFLOW release versions 2009-07, 2008-08, 2007-07 and 2006-06, the “DB” build or later will need to be used to function with a WIBU Codemeter dongle hardware lock. Upgrade to release version 2016-03-AF or newer is required if WIBU Software or Cloud locks are being used for the licencing.
+Refer to the <u>[[Wibu_Dongles |WIBU Lock Guidance]]</u> for further information how to install, update and manage TUFLOW licences for all of the available licence hosting approaches.<br><br>
+''Note Legacy Licence Type (Softlok Dongle): As of August 2010, Softlok USB dongles are no longer issued or supported due to the dongle provider not supporting 64-bit. For TUFLOW release versions 2009-07, 2008-08, 2007-07 and 2006-06, the “DB” build or later will need to be used to function with a WIBU Codemeter dongle hardware lock. Also, upgrade to release version 2016-03-AF or newer is required if WIBU Software or Cloud locks are being used for the licencing.''
-==Licence Types==
-TUFLOW simulations can be executed using a variety of licence types:
-* '''Licence Free Mode''': A licence free mode has been built in TUFLOW. For information outlining the limits associated with the licence free mode, see <u>[[New_User_Guide_Free_Demo_Version | TUFLOW Free DEMO Version Guide]]</u>
-* '''Local Licence''': TUFLOW simulations can only be run on the computer hosting the Lock. For installation guidance, see <u>[[New_User_Guide_Local_Licences | Local Licence Installation Guide]]</u>
-* '''Network Licence''': The Lock can be hosted on any computer or server. Other computers 'check out' licences from the host computer via a company’s network. There are no regional restrictions associated with Network licences. For installation guidance, see <u>[[New_User_Guide_Network_Licences | Network Licence Installation Guide]]</u>.<br>
-* '''Cloud Licence''': The Lock is hosted on a central WIBU cloud server. Other computers 'check out' licences from the host server over an internet connection. There are no regional restrictions associated with Cloud licences. For installation guidance, see <u>[[New_User_Guide_Cloud_Licences | Cloud Licence Installation Guide]]</u>. Note that a cloud licence can either be provided as a Local Cloud Licence, so that TUFLOW simulations can only be run on the computer that have the cloud licence installed, or as a Network Cloud Licence, for the same benefits that a Network Licence provides, but with the added administrative overhead as well.<br>
-<br>
 =Frequently Asked Questions (FAQ) =
-== Do I require a TUFLOW licence to create TUFLOW inputs and view results from a TUFLOW simulation? ==
-No, a TUFLOW licence is only needed to run a TUFLOW .exe file (excluding tutorial, demo and example models or small models eligible for free mode).  Running a TUFLOW .exe is required to:
-* Process control files (.tcf, etc), check the data inputs and to construct the model using the GIS layers and other inputs.  As part of this process any ERROR, WARNING or CHECK messages are issued to help resolve input data conflicts. Check files and GIS layers representing the final model construct are also produced to quality control the model’s inputs.
-* To carry out the hydraulic computations provided Step 1 above produces no ERROR messages.
-No licence is needed for all other tasks, including:
-* Creation and editing of all input files and GIS layers.
-* Running GIS plugins such as the QGIS TUFLOW Viewer.
-* Running utilities (e.g. asc_to_asc.exe).
-* Reviewing check files/layers in GIS.
-* Viewing results (e.g. using TUFLOW Viewer in QGIS).
-All TUFLOW inputs and outputs use free open formats that are readable and editable by third party software, for example QGIS and Notepad++:
-* Download Notepad++ to create and review tabular data: <u>[[NotepadPlusPlus_Tips | Notepad++ installation and tips]]</u>.
-* Download QGIS: <u>[[QGIS_Tips | QGIS installation and tips]]</u>.
-* Install the TUFLOW Plugin: <u>[[TUFLOW_QGIS_Plugin | TUFLOW QGIS plugin installation and tips]]</u>.
-* Use TUFLOW Viewer to review XMDF results: <u>[[TUFLOW_Viewer |TUFLOW Viewer]]</u>. <br>
-==Why is a pre 2010 version of TUFLOW not working?==
-In 2010 <u>[[Softlok_Dongles | Softlok dongles]]</u> were replaced by WIBU dongles. TUFLOW versions earlier than 2010 might be searching for a Softlok licence, however it is likely you have a WIBU licence. The "DB" builds of TUFLOW were created so earlier versions of TUFLOW recognise the new WIBU licences. Please download a "DB" version from the <u>[https://tuflow.com/downloads/tuflow-classichpc-archive/ TUFLOW website]</u>.
 ==How many simulations can be run at the same time?==
 The number of licences reflect how many TUFLOW simulations can be run in parallel at any given time. For example, a Local 4 can run 4 simulations at the same time on the one computer. A Network 5 allows up to 5 simulations at any one time across an organisation’s network. If all licences are in use when a TUFLOW simulation starts, the simulation enters a holding pattern until a free licence is available.
@@ Line 41: / Line 30: @@
 == What is the best licence for me? ==
-=== Hardware vs. Software ===
+=== Hardware (USB) vs. Software (Digital File) ===
-The advantage of a hardware lock is that it is portable and not tied to a specific computer. You can unplug it and plug it into another computer. A software lock is tied to a specific computer and cannot be moved once bound to that computer. This also means that if the computer changes substantially, the lock may become invalid and may need replacement.
+The advantage of a hardware (USB) lock is that it is portable and not tied to a specific computer. You can unplug it and plug it into another computer.<br>
+A software lock is tied to a specific computer and cannot be moved once bound to that computer. The advantage of a software lock however is that it can be installed on a computer that you don't have physical access to, and it doesn't require a free USB port.
-This is especially relevant if you install the lock on a virtual machine (VM), since migrating the VM or rebuilding it can cause the lock to become invalid. Specifically, if you run a VM in the cloud as a licence server, you need to keep in mind that stopping and starting the VM is safe. But only retaining the physical storage and basing a new VM on it will invalidate the licence.
-The advantage of a software lock is that it can be installed on a computer that you don't have physical access to, and doesn't require a free USB port. This makes software locks well-suited to installation on VMs, or remote computers.
 === Local vs. Network ===
 The advantage of a local lock is that you only need CodeMeter installed on the computer that will be running your TUFLOW software, and the required configuration will be minimal. No network access beyond this computer is required. The lock is either installed directly on this local CodeMeter, as a software lock, or CodeMeter will pick up an inserted hardware lock automatically.
-The advantage of a network lock is that you can manage all your locks in a single place (called the CodeMeter Network Server), and that licences can very easily be accessed from multiple computers on your network. However, this does mean that each additional computer that needs to be able to run TUFLOW will also need CodeMeter installed. These extra instances of CodeMeter need to be configured to find the Network Server. And these computers need to be able to access the Network Server over port 22350, which may require some cooperation of your IT staff to configure.
+The advantage of a network lock is that you can host multiple licences in a single place (called the CodeMeter Network Server). Licences are shared to client (modelling) computers from the server over your network. To function, these computers need to be able to access the Network Server over port 22350, which may require some co-operation of your IT staff to configure.
 === Cloud vs. non-Cloud ===
-The advantage of a cloud licence is that you can install it on as many machines as you like, and reuse it on future machines, for as long as the licence is valid. This gives you a similar advantage to using a Network Licence, without the complexity of network connectivity. Another benefit of this is that you can put the licence on computers that are not connected to your local network, which would make using a Network Licence on a Network Server on your network impossible, while Local Software Licences would not be reusable.
+The advantage of a Cloud licence is that you can set it up on as many machines as you like, and reuse it on future machines, for as long as the licence is valid. This gives you a similar advantage to using a Network Licence, without the complexity of network connectivity. Another benefit of this is that you can put the licence on computers that are not connected to your local network. A potential disadvantage of a Cloud licence can be the requirement that the computer it is installed on has https (web) internet access to `wibu.cloud`.  It is worth noting that currently the monitoring of Cloud licence usage is not as mature as the monitoring of network licences.
-A disadvantage of a cloud licence can be the requirement that the computer it is installed on has https (web) internet access to `wibu.cloud`. Using a Local Cloud Licence also means that you need to distribute your licence to many locations, which may be a security concern.
-Since Cloud Licences can be provided as either Local Cloud or Network Cloud licences, you can have the benefits of both combined: a Cloud Network Licence would allow you to licence computers not connected to your local network, while not requiring https access to wibu.cloud for each machine running TUFLOW. Instead you can organise network connections from the computers running TUFLOW to the Cloud Network Licence server, while the entire network can be independent of your local network. This makes the Cloud Licence ideal for use in situations where you want to create your own cloud infrastructure for running TUFLOW.{{Tips Navigation
+{{Tips Navigation
 |uplink=[[Main_Page| TUFLOW Main Page]]
 }}

Difference between revisions of "TUFLOW Licensing"