Difference between revisions of "TUFLOW Licensing"

From Tuflow
Jump to navigation Jump to search
Line 1: Line 1:
 
=Introduction=
 
=Introduction=
A TUFLOW dongle or TUFLOW software licence is required to run TUFLOW, but is not required when using third party software such as a GIS, text editor or SMS.
+
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 or in free mode.<br>
As of 2010, two brands of dongles are available from BMT, and several third-party dongles are supported that are licensed and maintained by on-sellers of TUFLOW.  For the latter, please refer to the vendor’s documentation for setting up the dongle. <br>
 
 
<br>
 
<br>
BMT licences are either:<br>
 
* <u>[[Wibu_Dongles | WIBU (metal) Dongles / WIBU Software Licences]]</u>; or
 
* <u>[[Softlok_Dongles | Softlok (blue) Dongles]]</u>
 
  
==WIBU Dongles / WIBU Software Licences==
+
=Lock Type=
'''WIBU dongles''' were introduced in 2010 and support 64-bit platforms. Two licence types are available, local and network:
+
TUFLOW Products are licenced via locks, available in two forms; WIBU USB-2 Dongles (hardware lock) and WIBU Software Licenses (software lock). A third form, WIBU Cloud locks, should be available in 2023.<br>
* With local licence dongle TUFLOW simulations can only be run on the computer hosting the dongle.
+
 
* With network licence dongle the computer or server that the dongle is plugged into becomes the licence host and any computer within the organisation can pull licences from the licence host over the network.
+
==WIBU Hardware Lock==
'''WIBU software licence''' is recognised by the 2016-03-AE release onwards and provided in a form of a digital file. The computer or server where the software licence is installed on becomes the licence host from which any computer within the  organisation can pull licences from. The software licence is more restrictive compared to the network licence dongle in that it is locked to a single computer.<br>
+
WIBU hardware locks are physical dongles (USB-2) that contain the TUFLOW licence(s). Licences are coded into the dongle and therefore can be moved between computers. WIBU hardware locks are recognised by the 2006-06-BD release onwards.
 +
 
 +
==WIBU Software Lock==
 +
WIBU software locks are coded into the computer and are hardwired to the computer's motherboard. The software lock is more restrictive compared to the hardware lock in that it is locked to a single computer (or server) and cannot be transferred. WIBU software locks are recognised by the 2016-03-AE release onwards.
 +
 
 +
==WIBU Cloud Lock (Coming Soon)==
 +
WIBU cloud locks reside on the Cloud and require an internet connection to be accessed.  Cloud locks can only be configured as network licences (described below) and provide maximum flexibility for an organisation's modellers to access (assuming they have an uninterrupted internet connection). WIBU cloud locks are recognised by the 2016-03-AE release onwards and should be available in 2023.
 +
 
 +
== Softlok Dongles (Legacy Product)==
 +
Softlok dongles are no longer issued as of August 2010 as they are unable to provide 64-bit support. Maintained Softlok dongles may be exchanged for a WIBU dongle for a nominal fee, please contact [mailto:sales@tuflow.com sales@tuflow.com].
 +
 
 +
Note, for the 2009-07, 2008-08, 2007-07 and 2006-06 releases, the “DB” builds or later will need to be used to recognise a WIBU Codemeter dongle.<br>
 
<br>
 
<br>
WIBU dongles (and WIBU software licences) have several advantages over the Softlok dongles: <br>
 
* Support for 64-bit platforms and future options for non-Windows platforms;
 
* Network licence manager runs as a service (ie. the computer with the network dongle needs to be on, but no one needs to be logged in);
 
* Much more flexible licensing options (for example, it is now possible to have a Network 10 TUFLOW licence with a Network 5 Multiple 2D Domains Module licence – with the SoftLok dongles a Network 10 Multiple 2D Domains Module would have to have been purchased);
 
* Multiple WIBU dongles (local and/or network licensed) are accessible together (ie. if all licences from one dongle are taken, licences from other dongles are automatically checked and taken);
 
* No network ghost licences (thus far!); and
 
* No need for TUFLOW to control limiting of local licences (TUFLOW’s run key is not used if the number of CPUs/cores exceeds the local licence limit).<br>
 
<br>
 
'''Note, for the 2009-07, 2008-08, 2007-07 and 2006-06 releases, the “DB” builds or later will need to be used to recognise a WIBU Codemeter dongle.'''<br>
 
  
== Softlok Dongles ==
+
=Licence Type=
Softlok dongles are no longer issued as of August 2010 as they are unable to provide 64-bit support, however the dongles continue to be supported for 32-bit versions of TUFLOW. Softlok dongles may be exchanged for a WIBU dongle for a nominal fee, please contact [mailto:sales@tuflow.com sales@tuflow.com].
+
TUFLOW Licences are currently available in two forms; local and network.  
  
 +
==Local Licence==
 +
TUFLOW simulations can only be run on the computer hosting the Lock. For installation guidance, see:
 +
:*<u>[https://wiki.tuflow.com/index.php?title=New_User_Guide_Local_Licences Local Licence Installation Guide]</u>
  
=Fequently Asked Questions (FAQ) =
+
==Network Licence==
 +
The Lock is hosted on any computer (e.g. a 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>[https://wiki.tuflow.com/index.php?title=New_User_Guide_Network_Licences Network Licence Installation Guide]</u>
 +
<br>
 +
=Frequently Asked Questions (FAQ) =
 
== Do I require a TUFLOW licence to create TUFLOW inputs and view results from a TUFLOW simulation? ==
 
== 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 simulations (excluding tutorial, demo and example models or small models eligible for free mode).  Running TUFLOW.exe is required to:
+
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.
 
* 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 the Step 1 above produces no ERROR messages.
+
* To carry out the hydraulic computations provided Step 1 above produces no ERROR messages.
 
No licence is needed for all other tasks, including:
 
No licence is needed for all other tasks, including:
 
* Creation and editing of all input files and GIS layers.
 
* Creation and editing of all input files and GIS layers.
Line 43: Line 48:
 
* Install the TUFLOW Plugin: <u>[[TUFLOW_QGIS_Plugin | TUFLOW QGIS plugin 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>
 
* 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>[[TUFLOW_Licensing_Draft#Softlok_Dongles_.28Legacy_Product.29 | Softlok dongles]]</u> were replaced by WIBU dongles. TUFLOW versions earlier than 2010 will be searching for a Softlok licence, however it is likely you have a WIBU licence. The "DB" builds of TUFLOW were created so earlier version of TUFLOW would 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.
 +
 +
<br>
 +
{{Tips Navigation
 +
|uplink=[[Main_Page| TUFLOW Main Page]]
 +
}}

Revision as of 13:59, 6 January 2023

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 or in free mode.

Lock Type

TUFLOW Products are licenced via locks, available in two forms; WIBU USB-2 Dongles (hardware lock) and WIBU Software Licenses (software lock). A third form, WIBU Cloud locks, should be available in 2023.

WIBU Hardware Lock

WIBU hardware locks are physical dongles (USB-2) that contain the TUFLOW licence(s). Licences are coded into the dongle and therefore can be moved between computers. WIBU hardware locks are recognised by the 2006-06-BD release onwards.

WIBU Software Lock

WIBU software locks are coded into the computer and are hardwired to the computer's motherboard. The software lock is more restrictive compared to the hardware lock in that it is locked to a single computer (or server) and cannot be transferred. WIBU software locks are recognised by the 2016-03-AE release onwards.

WIBU Cloud Lock (Coming Soon)

WIBU cloud locks reside on the Cloud and require an internet connection to be accessed. Cloud locks can only be configured as network licences (described below) and provide maximum flexibility for an organisation's modellers to access (assuming they have an uninterrupted internet connection). WIBU cloud locks are recognised by the 2016-03-AE release onwards and should be available in 2023.

Softlok Dongles (Legacy Product)

Softlok dongles are no longer issued as of August 2010 as they are unable to provide 64-bit support. Maintained Softlok dongles may be exchanged for a WIBU dongle for a nominal fee, please contact sales@tuflow.com.

Note, for the 2009-07, 2008-08, 2007-07 and 2006-06 releases, the “DB” builds or later will need to be used to recognise a WIBU Codemeter dongle.

Licence Type

TUFLOW Licences are currently available in two forms; local and network.

Local Licence

TUFLOW simulations can only be run on the computer hosting the Lock. For installation guidance, see:

Network Licence

The Lock is hosted on any computer (e.g. a 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:


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++:

Why is a pre 2010 version of TUFLOW not working?

In 2010 Softlok dongles were replaced by WIBU dongles. TUFLOW versions earlier than 2010 will be searching for a Softlok licence, however it is likely you have a WIBU licence. The "DB" builds of TUFLOW were created so earlier version of TUFLOW would recognise the new WIBU licences. Please download a "DB" version from the TUFLOW website.

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.


Up
Go-up.png TUFLOW Main Page