TUFLOW Link Installation

Installation

Installation of TUFLOW Link is contained in the main Flood Modeller installation setup.

Additional mandatory steps

On purchase of the TUFLOW Link, user depending on the licensing mechanism they use will be provided with a different set of instructions/files:

WIBU Codemeter licence users will be provided with a WIBU licence upgrade file (created after you have supplied Jacobs with a licence request file). You need to follow the instructions in the relevant pages in this manual such as Installing a licence upgrade in order to apply the licence upgrade. The page here Creating a licence request file describes the steps for the creation of a licence request file.  

Safenet Sentinel users will be provided with a new .set licence file to enable TUFLOW linkage. This needs to be placed to the folder as follows: "C:\Users\<User Name>\AppData\Roaming\Flood Modeller". <User Name> is the login name you use to login to the computer.   

The TUFLOW Link needs to be able to 'see' the TUFLOW engine files. In order to effect this, two alternative approaches are given:  

Approach One

One approach is to add the location of the TUFLOW files (eg C:\TUFLOW) to the Preferences section of the settings file formsed.ini (located in the [AppData]/Roaming/Flood Modeller folder).

There are three options available for this:

TUFLOWPATH=…

TUFLOWPATH32=…

TUFLOWPATH64=…

TUFLOWPATH can contain an explicit path to 32 or 64-bit TUFLOW install location

TUFLOWPATH32 & TUFLOWPATH64 can only contain the path to the relevant 32-bit and 64 bit version (TUFLOWPATH32 for the 32-bit version; TUFLOWPATH64 for the 64-bit version), e.g. TUFLOWPATH32 will be ignored by the 64-bit engine.

The last valid entry will be the one used. If the file is not found on (or cannot be loaded from) this path, Flood Modeller will try the default path.

[AppData] folder is usually located in C:\Users\<Username> folder. It is usually a hidden folder, so there nay be a need to set a setting in your operating system to show the hidden folders in order to see it. Alternatively,  typing in the address line of the Explorer the following: "C:\Users\<Username>\AppData" and pressing "Enter" should show the contents of this folder. <User Name> is the login name you use to login to the computer.

Approach Two

Another approach is to add the location of these files (the TUFLOW Executables folder) to the system path, e.g. by adding this path name to the user's PATH environment variable: Start button in Windows > Control Panel > System > Advanced Tab > Environment Variables button at the bottom. The path to the TUFLOW files can be added to the user or system variables section. Only one path to a folder containing TUFLOW executables should be contained in the user and system variables section of the Environment Variables window.

Therefore, take care to check for PATH variables in both sections. When a new path is added to the path variable it should be separated from the previous path using a “;”.

Environment Variable window showing the values of the PATH variable with the TUFLOW path specified.

Once option 1 or 2 has been completed, Flood Modeller Pro needs to be closed (if it was open during the editing) and re-opened in order for the changes to be applied.

You should now be able to start your Flood Modeller Pro-TUFLOW linked simulation.

Note: if you have problems with starting TUFLOW from within a linked Flood Modeller-TUFLOW simulation, pay attention to checking that it is only one path to TUFLOW listed in either of the sections (system and user) of the Environmental Variables or in formsed.ini file. Additionally check that you link Flood Modeller's 64-bit version with a TUFLOW's 64-bit build or Flood Modeller's 32-bit version with a TUFLOW's 32-bit build. As you can't link 32-bit Flood Modeller with 64-bit TUFLOW or vice versa. Lastly, for the best outcome use the most recent version of Flood Modeller and TUFLOW, as in cases when one of these is outdated, the linking may not be possible.