Installation and licensing

Answering all your installation and licensing questions. 

Recently installed 5.0? In order to use Flood Modeller 5.0, you will need a licence. Get in touch with our sales team today.

Right_Arrow

Can I install Flood Modeller on my machine?

Flood Modeller is developed for Windows OS. The following Operating Systems are currently supported:
•    Windows Server 2016
•    Windows Server 2019
•    Windows 7
•    Windows 8
•    Windows 10

 

The recommended specification for your machine is as follows:

•    1920 x 1080 display
•    Intel Quad core processor 3.2GHZ
•    8GB Memory
•    100GB Hard disk space free
•    Windows 10 64 bit

 

Flood Modeller is provided only as a 64-bit installation and will not work on a 32-bit operating system.


There are no versions available for Unix-like systems. A workaround is to run Flood Modeller from a Virtual Machine that has Windows installed. Alternatively, Windows emulators can be utilised to run Flood Modeller on a Mac, for example.

Right_Arrow

How do I install Flood Modeller?

Simply go to the ‘Downloads’ section of the website and complete the form. A direct link to the download will then be emailed to you.

This will install all the required software. If using Flood Modeller for the first time, now see ‘How do I activate my new licence?’ (below). If upgrading from an older version, there is no need to uninstall your older version of Flood Modeller first.

It is recommended that you are logged on with administrator rights when installing Flood Modeller.

Right_Arrow

Help! I've had a problem installing Flood Modeller

Installing Flood Modeller is usually quick and simple. The installer will also include some third-party components necessary to run the software, and this all happens automatically with no input needed from the user (aside from checking a box to accept the EULA).


In some rare circumstances, it may be useful to separately install these third-party components on certain systems.

 

Codemeter: 
To install Codemeter, visit the
Codemeter Download page. Download and install the latest version of ‘Codemeter User Runtime for Windows’.


C++ Redistributables: 
These are available from here:
https://aka.ms/vs/16/release/vc_redist.x64.exe
 

Registration failure of mapping component: 
On some systems, you may see the error message below when you first try to start Flood Modeller.

Help with installing Flood Modeller imag

This relates to the 3rd party mapping component used within the Flood Modeller interface, which must be registered within your system for it to work correctly. The Flood Modeller installer would normally ensure this component is registered automatically. However, if this does not happen you will need to manually register it. To help with this Flood Modeller includes a program you can run to perform this registration. The procedure for running this registration process is as follows:

  • In Windows Explorer (or equivalent), browse to ‘<Flood Modeller>\gui’ (where <Flood Modeller> is the folder where Flood Modeller has been installed to, by default it is ‘C:\Program Files\Flood Modeller’)

  • Find the file in this folder entitled ‘regMapWinGIS.cmd’, right-click on the file and select ‘Run as Administrator’ from the displayed menu

  • A Command Prompt window displays progress as the program runs. Upon completion of the program the window should close automatically.

 

If the manual registration has completed successfully then the original error message should no longer be displayed when you run Flood Modeller and the software will start-up successfully.

Helpful hint on interface display: 
It should be noted that your monitor display zoom level setting in Windows can adversely affect the performance of the Flood Modeller interface. If this is set to any option other than the default 100% (i.e. a zoom level >100%) you may experience problems. The main issue will be that forms will have controls missing, i.e. buttons or scroll bars hidden off the bottom or sides of forms (e.g. 1D node properties windows are often affected). In addition, font sizes may vary across different panels (degrading the appearance of the interface) and menu contents vary (some items hidden).
 

Note that after changing your display setting back to the 100% level you will need to log out of Windows for the change to take effect. Therefore, ensure your Flood Modeller project work is saved prior to making this change.

If you have any queries or problems with the installation then please contact Flood Modeller Software Support for assistance at support@floodmodeller.com or telephone +44 (0)845 094 7994.

Right_Arrow

Do I need a licence?

Yes, a valid licence is required to view, build and run models in Flood Modeller.

There are multiple options to meet your needs, please see ‘What type of licence do I need?’ (below) for more information or contact us at sales@floodmodeller.com.

Right_Arrow

What type of licence do I need?

Flood Modeller provides a variety of licence types to better serve your requirements. Aside from the modular nature of the software where the users can enhance the base package with additional features, there are two major decisions when it comes to licensing:


Standalone vs Network licence
This distinguishes between licences available on one machine only at any given time (standalone) and licences being served to multiple machines over the network.


The main benefit of a network licence is the freedom from being tied to a single machine on which to do your modelling. This allows the flexibility to work from any location, at any time - access to your company intranet is all that is required. A network licence also provides additional security as there is not a physical licence to be misplaced or broken!


Lock via USB dongle or software lock
Your licences can be supplied via two routes; physical locks in the form of USB dongles (sticks) and software locks in the form of files installed on the client's machines. A brief list of advantages and disadvantages for both options are presented in the table below. Despite their respective characteristics, the core functionality remains the same.

USB Dongle

Pros:

  • Can be used on different machines as and when needed.

  • Minimum configuration overhead (plug'n'play).

  • Provides easy access when working remotely or from client office.

  • Can be updated easily by the end-user (without IT support).

Cons: ​

  • Must be plugged into the machine. 

  • Not always suitable for virtual machines.

  • Could become lost or damaged more easily (incurring replacement costs).

Software lock

Pros: 

  • Once installed, the licence is always available to use.

  • No need for hardware management.

  • Unlikely to become lost or damaged unless the machine itself is affected.

Cons:

  • Tied to one machine only. 

  • Sensitive to hardware (virtual or physical) changes.

USB dongles and software locks may also be mentioned collectively as licence containers.

Right_Arrow

Is my licence sufficent?

If you are unsure of the functionality available via your licence, you can confirm the products you have access to via the user interface or Codemeter. The page here shows you how to confirm which products are available to you.

The limits for the Standard and Professional editions of Flood Modeller are as follows:

Standard: 400 1D river solver nodes and 400,000 2D solver grid cells
Professional: 1,000 1D river solver nodes and 1,000,000 2D solver grid cells

If your licence does not provide the required functionality, add-ons are available as both long-term purchases and short-term rentals. Please contact sales@floodmodeller.com for further information.

Right_Arrow

How do I activate my new licence?

Your Flood Modeller licence is implemented either via a USB dongle or as a software lock. More information on USB dongles and software locks can be found in  ‘What type of licence do I need’ (above).

Depending on your selected option, please follow the instructions below to install a Standard or Professional licence:

USB dongles – when your dongle arrives, simply plug it into your machine and start using the software! This should be plugged into the machine you are running the software on (or the machine acting as a licence server if you have a network licence). Please note that the dongle should remain attached to the machine running Flood Modeller for the entire duration of the simulation/editing.

Virtual Locks – Alternatively, your licence can be provided via a software lock. This needs to be installed onto the machine you are running the software on (or the machine acting as a licence server if you have a network licence). Follow the steps here to see how to install a software lock/virtual licence once you have downloaded Flood Modeller.

Right_Arrow

How do I update my existing licence?

Jacobs' web portal for Flood Modeller licences can be utilised to obtain and install your new licence. There are two ways of using this portal:


1.    Direct licence activation (fast and best suited to virtual locks)
2.    
File-based licence activation (need to upload and receive files, fail-safe)
 

If the licence is installed on the same machine from which you are accessing the portal, either option should work. However, if the licence is to be installed on an offline machine or if you are getting errors using option 1 (direct activation), option 2 is best.

Right_Arrow

Is my dongle working?

If you are concerned your dongle is not working as expected, try the following:


1.    Confirm the dongle is plugged in!
2.    Check it is recognised by opening Codemeter Control Center from the System Tray or the Windows Start Menu. In the ‘License’ tab, you should see at least one entry like the one shown below. If you can see this entry, your dongle is working as expected.

Is my dongle working.png

3.    If the dongle does not appear in the Codemeter Control Center, please try another USB port, if possible, and repeat step 2.
4.    Try restarting the Codemeter service via the Codemeter Control Center: 
        o    Go to "Process" -> "Restart Codemeter Service" or
        o    Go to "Process" -> "Stop Codemeter Service". Then "Process" -> "Start Codemeter Service".
5.    Another step you could take is rebooting the machine and repeating step 1- 4. 
6.    If there are no other ports available, or steps 2, 4 and/or 5 fail consistently, please contact us at support@floodmodeller.com.

Right_Arrow

Is my software lock working?

If you are concerned your virtual lock is not properly installed and active, try the following:

1.    Open Codemeter Control Center from the System Tray or the Windows Start Menu.
2.    In the ‘License’ tab, in the pane on the left, you should see at least one entry like the one shown in below.

is my software lock wworking.png

3.    If such an entry exists, please ensure that the status shown is ‘License activated’.

4.    If such an entry does NOT exist or the status is other than ‘License activated’, please contact us at support@floodmodeller.com.

Right_Arrow

Help! I have a problem with my licence

Is it *definitely* a licensing issue? 

If you are in doubt whether the issue you are experiencing is licence related, it is easy to confirm. In the majority of cases, there will be a message (error/warning) clearly stating that there is an issue with your licence and you need to contact us. The locations of these messages vary.

 

  • User interface - a pop-up window details the licence problem.

  • Running a simulation via the UI - the simulation window contains a log of all the messages from the engines.

  • 1D river engine - the messages are in files with extension lf1 and/or zzd.

  • 2D engine - the messages are in files with extension lf2 and/or log.

  • 1D urban engine - the messages are in a file with extension rpt.

  • TUFLOW - the messages are in a file with extension tlf.

 

Is it a problem with all models?
If you are unable to view or run particular models, check the number of nodes/cells. You may need an add-on or a different edition of the software. To check what functionality is available with your licence, please follow the instructions in ‘Is my licence sufficient?’ (above).


Is your licence up to date?
Your licence needs to be updated annually, or whenever you purchase additional products. A common issue is trying to run a new version of the software without updating the licence container (USB dongle or software lock). Please follow the instructions in the document Create Licence Request and send a licence request file to us at support@floodmodeller.com.

If your answer was ‘yes’ to all of the above...


My licence is a USB dongle licence (standalone):

  1. The USB dongle is not recognised. You may try to resolve this by following the instructions in ‘Is my dongle working?' (above).

  2. You have reached the limit of available concurrent instances of Flood Modeller. The details of how many instances are available through your licence are explained in ‘How does my Flood Modeller licence work’ (below). For further instances, you may need to purchase additional licences. Please contact us at sales@floodmodeller.com.


My licence is a USB dongle licence (network):

  1. The USB dongle is not recognised. You may try to resolve this by following the instructions in ‘Is my dongle working?’ (above).

  2. You have reached the limit of available concurrent instances of Flood Modeller. The details of how many instances are available through your licence are explained in ‘How does my Flood Modeller licence work’ (below). For further instances, you may need to purchase additional licences. Please contact us at sales@floodmodeller.com.

  3. You are unable to pick up the licence from network. Assuming you are connected to your company’s intranet and this is not due to internal IT issues, it may be that the licence server and/or modelling machine(s) are not configured correctly. To check your personal machine is configured correctly, please follow the instructions in Network Licence - End-user guide. To confirm the licence server is configured correctly, please follow the instructions in Network Licence - Admin guide (you may need to contact your IT department for this).


My licence is a Software lock licence (standalone):

  1. The software lock has been deactivated/broken. Confirm the status by following the instructions in ‘Is my software lock working?’ (above). You may send us a request to reactivate the licence by following the instructions in Create Licence Request. Please note that this may incur additional costs to you (depending on the reason of deactivation).

  2. You have reached the limit of available concurrent instances of Flood Modeller. The details of how many instances are available through your licence are explained in ‘How does my Flood Modeller licence work’ (below). For further instances, you may need to purchase additional licences. Please contact us at sales@floodmodeller.com.
     

My licence is a Software lock licence (network):

  1. The software lock has been deactivated/broken. Confirm the status by following the instructions in ‘Is my software lock working?’ (above). You may send us a request to reactivate the licence by following the instructions in Create Licence Request. Please note that this may incur additional costs to you (depending on the reason of deactivation).

  2. You have reached the limit of available concurrent instances of Flood Modeller. The details of how many instances are available through your licence are explained in ‘How does my Flood Modeller licence work’ (below). For further instances, you may need to purchase additional licences. Please contact us at sales@floodmodeller.com.

  3. You are unable to pick up the licence from network. Assuming you are connected to your company’s intranet and this is not due to internal IT issues, it may be that the licence server and/or modelling machine(s) are not configured correctly. To check your personal machine is configured correctly, please follow the instructions in Network Licence - End-user guide. To confirm the licence server is configured correctly, please follow the instructions in Network Licence - Admin guide (you may need to contact your IT department for this).

Right_Arrow

How does my Flood Modeller licence work?

A Flood Modeller network licence enables a single user to run up to a certain number of concurrent simulations using the same network licence (depending on edition: Professional gives 4 instances, Standard gives 2 instances). A single user is defined as a user with the same username, using the same machine (hostname, IP Address, etc.) and other limitations placed by the WIBU StationShare methodology (see definitions below). In practice, each user physically or remotely logged on a machine acquires one licence and is able to run up to four/two instances of Flood Modeller Professional/Standard with any additional modules (if purchased). Network licences of Flood Modeller use two licensing models: StationShare and UserLimit. This behaviour is inherited from the Codemeter licencing system provided by WIBU. The definition of these two licence models according to Codemeter documentation is:

 

  • UserLimit: this is used to control the number of licences issued; for each started instance of Flood Modeller, exactly one licence is allocated. The number of licences available for use under UserLimit is equal to the number of Flood Modeller licences available.

  • StationShare: this is effectively used as a "counter" of the number of concurrent simulations; for each combination of machine+user+session, only four (4) instances of Flood Modeller Professional (or 2 for Standard) are allowed and one licence is allocated. StationShare licences cannot be shared between sessions.


For example, one user of the Professional edition trying to run three models on one machine will need to be allocated one licence with UserLimit and three licences with StationShare. In order to clarify the terminology for the StationShare model, the following terms are explained:

 

  • Machine: any physical or virtual machine that acts as a client, meaning it is requesting licences from a server machine.

  • User: any user of the machine that has a unique login ID.

  • Session: any local or remote access of a user to a machine. Not related to Flood Modeller instances.


There is a caveat for remote sessions. Every time a user logs on a Windows 10 machine using remote session, a different session/user ID is assigned to them. Any attempt to run a new instance of Flood Modeller will make the software seek for a new set of licence (UserLimit + StationShare), even if any previous sessions of the same user, on the same machine have unused StationShare licences.

Support & Maintenance

Over 98% of our users annually renew their contracts as it provides extensive benefits. Whichever licensing option you select, support and maintenance is available from our global support and development network. Request a price list to find out more about our support and maintenance contract.

ticket.png

Creating an online ticket is the quickest and easiest way to contact our support team.

mail.png

Email your query to support@floodmodeller.com and our team of experts will get back to you.

call-support.png

Call +44(0)845 094 7994 to discuss any queries you may have about your model or the software.

Dockable_work_canvas.png

Access a wide range of online learning resources to provide your team with the help and support they need.