LedaFlow Engineering Installation Guide
LedaFlow Engineering Installation Guide
LedaFlow® Engineering 1D
Installation guide
KDI license server ‘Installation guide’ COMPANY SHARED
Table of contents
1 Introduction ............................................................................................................................................ 5
1.1 Overview ............................................................................................................................................... 5
1.2 Definitions ............................................................................................................................................. 5
1.3 System requirements ............................................................................................................................. 5
8 Uninstallation ........................................................................................................................................ 28
8.1 Uninstall LedaFlow® Engineering ........................................................................................................ 28
8.2 Uninstall MariaDB ............................................................................................................................... 28
9 Troubleshooting .................................................................................................................................... 29
9.1 Administrative rights ........................................................................................................................... 29
9.2 MariaDB service not running............................................................................................................... 29
9.3 Out of range value exception when importing a case ......................................................................... 31
9.4 Invalid license ...................................................................................................................................... 32
9.5 No connection to license server ........................................................................................................... 32
1 Introduction
This document provides a step-by-step guide to installing LedaFlow® Engineering and is also a useful
resource if you encounter any problems during installation.
1.1 Overview
The following steps must be performed to complete the installation of LedaFlow® Engineering:
1. Verify that your system meets the system requirements listed in section 1.3;
2. Request the license required by LedaFlow® Engineering. This procedure is described in section
2;
3. Install the database as described in section 3;
4. Run the LedaFlow® Engineering installer as described in section 4.
This installation guide gives details on how to perform each step. It also provides guidance for how to
uninstall LedaFlow® Engineering and troubleshoot common problems.
1.2 Definitions
LedaFlow®
The core application that performs the physical simulations is called LedaFlow®. It is never used
directly, but rather through the LedaFlow® Engineering application.
LedaFlow® Engineering
LedaFlow® Engineering is an application suite for performing 1D multiphase flow simulations. It is also
the name of the graphical user interface where you can build, configure, run and analyse your
LedaFlow® models.
MariaDB
LedaFlow® Engineering uses a MariaDB relational database management system (DBMS) to store
LedaFlow® models and simulation results.
Multiflash™
Multiflash™ (from KBC Advanced Technologies) provides a complete and reliable solution for the
evaluation of the phase behaviour of complex fluids across the whole equipment and plant design
process and during operations. It enables engineers with quantitative information and data to rapidly
assess options, make choices and prevent or forecast potential problems.
Minimum Recommended
1 GHz dual core 2 GHz or higher, quad core or more Intel with
CPU
Intel or AMD hyper-threading
RAM 1 GB 8 GB or more
Please note that actual disk size requirements depend entirely on the complexity of the models to be
simulated and the amount of output data these cases produce.
The number of recommended CPU cores is directly related to the number of concurrent simulations
that the target system will run. For cases containing a large number of cells (e.g. slug capturing) we
recommend using 4 cores per simulation, since in most cases this gives the best performance. For
smaller cases 2 cores will suffice. Note that using more than the recommended number of cores may
cause the simulation to run slower and not faster. Also make sure to not use all the cores on the
system; it is recommended to always keep at least 1 core free for Windows and other processes.
Kongsberg strongly recommends keeping the system up-to-date with Microsoft Windows Update.
This will ensure that you also get all improvements to Microsoft Windows that might affect the
experience with using LedaFlow® Engineering.
1 A Solid State Drive (SSD) will improve overall simulation performance and user experience.
2 Using a virtual machine (VM) can slowdown the computation time up to 10%.
© 2020 KONGSBERG - All rights reserved. 26MAR2020 Page 6 of 33
Note: Printed copies of this document are for information only. Always check for the latest valid electronic version.
KDI license server ‘Installation guide’ COMPANY SHARED
2 License modes
LedaFlow® is a licensed software. It needs a valid license to run. It is recommended to obtain a license
from the LedaFlow® support (ledaflow@kdisupport24.com) before installing LedaFlow®. You can skip
this section if you have already received a license file or completed the setup of your license server3.
The LedaFlow® license can be configured in two ways: it can be a local license file or the network
address of a license server.
• Send the “hostinfo.txt” to ledaflow@kdisupport24.com to get a valid license file for your
computer. In addition, you should inform as well if the license will be installed in a virtual
machine.
The “KDI License Server Installation Guide.pdf” comes with a separate KDI license server installation
package. Please follow the license server installation guide to install the license server.
3 This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)
3 Database installation
This section can be skipped if the user already has MariaDB or MySQL installed from a previous
installation of LedaFlow®.
For first time installations, the MariaDB database needs to be installed. The installer can be found in
the LedaFlow installation package, along with the KDI License Server.
As a safeguard mechanism, the MariaDB installer first tries to identify if MariaDB is already installed.
If that is the case, you will be prompted with a warning dialog as shown in Figure 1.
Please note that the MariaDB installer does not check for MySQL installations. If you decide to install
MariaDB along with your existing MySQL, you should choose to run MariaDB on a different port (for
example 3309) than the one used by MySQL.
The user must agree with the license agreement before proceeding with the installation.
In this page, however, you can change the destination folder if you want to install the MariaDB
database elsewhere.
Note: You should not install the database in “Program Files (x86)” because some users don’t have
writing permissions on that folder.
This page presents a summary of the MariaDB installation configuration. This is the last chance to
modify the configuration before the actual installation takes place. If everything looks fine, click Install
to continue.
MariaDB installer will install the MariaDB software to the destination folder. It will also create and
start LedaMariaDB v[version] service to run the MariaDB server for LedaFlow®.
© 2020 KONGSBERG - All rights reserved. 26MAR2020 Page 10 of 33
Note: Printed copies of this document are for information only. Always check for the latest valid electronic version.
KDI license server ‘Installation guide’ COMPANY SHARED
The installation of MariaDB is now completed. Click Finish to exit the Setup.
The complete text can be found in the file EULA.rtf supplied with LedaFlow® Engineering. After
installation the file can also be found in the destination location.
• C:\Program Files\Kongsberg
In 64-bit Windows versions it will be:
Remember: The hard disk that contains the destination location should have at least 2 GB of free space
for successfully installing the application and running simulations.
You may get the following dialog if the Kongsberg folder already exists:
Multiflash™ is also distributed along with LedaFlow®. The user can choose to install it or not.
Important note: If you already have Multiflash™ installed together with a Kongsberg product, do leave
this checkbox enabled. This is required to ensure that your system can keep track of the number of
LedaFlow® Engineering or K-Spice instances on your computer that installed Multiflash™.
→ See section Error! Reference source not found. Error! Reference source not found. for more in
formation on how to upgrade from older versions of LedaFlow® Engineering.
Change the name here if you wish to have the shortcut placed elsewhere.
The tool provides the option to setup the configuration for LedaFlow® applications to use either a
license server or a local license file. Depending upon the type of license, please select the
corresponding option, and provide the information in the dialog.
In case of using a license server, you have to set the host name of the license server and the license
and web server ports. If the license server is installed in the same PC as LedaFlow®, then the host
name will be “localhost” as seen in the figure above. The license server port is defined in the license
file and the web server port is the one used in the license server installation.
If you have a backup license server, you should also check that option and set the host name and port
number.
The license roaming option will enable a user to checkout LedaFlow licenses from the license server
and use them offline. Those licenses won’t be available in the license server until they are returned.
The LedaFlow® installation program will also create a shortcut for the License Configuration Tool in
the start menu: Kongsberg → LedaFlow License Configuration v[version]. This shortcut can be used
any time to change the license configuration for LedaFlow®.
The “/SILENT” option will still show a dialog with the installation progress while the “/VERYSILENT”
option won’t show anything.
In order to use these options, the user has to agree with the terms in the EULA and the 3rd party
components licenses. This is done by using the option “/EULA=true”. Note that the silent installation
will not work without this option. The EULA and the 3rd party components licenses can be found next
to the LedaFlow installer.
If you have not configured your license yet, or if there is an error in the license configuration, you will
not be able to run LedaFlow® Engineering, and a message similar to the one shown in Figure 18 will
be displayed.
Open the LedaFlow® License Configuration tool and check if the license is properly set up. If you are
using a local license file, make sure the license file is valid. If you are using a license server, click on
“Test connection” to check if the connection to the license server is working.
If you are not connected to any database, the problem might be that:
• The connection profile configuration is wrong; pay particular attention to the port number
and make sure it is the same that is used in the installation.
Or
• The database service is not running. In this case, open the Windows Services and start the
LedaMariaDB v[version] service.
Or
1. Click on the File menu and select the “New Case” option.
2. Select “Leda 1D – 3 phases” case type and give the case a name (e.g. default3ph).
3. Click OK.
4. Initialize and run the case by clicking in the “Initialize/Run” buttons (Figure 21 and Figure 22)
and wait for the simulation to be completed.
6 Database how-to
6.1 How to backup and restore the database
MariaDB series 10.4 (distributed with LedaFlow 2.6 onwards) comes with a backup and restore tool.
6.1.1 Backup
The installation folder of MariaDB 10.4 (C:\Kongsberg\LedaFlowStorage\mariadb-10.4.11-winx64)
contains a script that can be used to perform the backup of the entire DBMS (all databases). The
backup can be performed while LedaFlow is operating. A writing lock is placed on the database while
the backup is running, and any write operation will wait until the backup is done.
The backup script is called "backupDB.bat". By default, the script will store the backup in
"C:\Kongsberg\Backup". The location of the backup can be changed by calling the script with a
different location.
Figure 24 Example of the call using a command prompt with the default backup path
Figure 25 Example of the call using a command prompt with a different backup path
The script can be used to start a backup manually, either by calling it from the command prompt or
by just double-clicking on it.
The backup script only keeps three backups. When a new backup is performed, a folder with a
timestamp is created and the backup is stored inside. The oldest backup folder is deleted if there are
already three backups.
An idea on how to automate the backups is to set up a scheduled task on Windows to call the backup
script at the desired backup frequency.
6.1.2 Restore
In addition to the backup script, there is a restore script. Contrary to the backup, the restore needs to
be done with LedaFlow® Engineering closed and the database disabled.
4. Once the script is done, start the “the “LedaMariaDB v10.4.11” Windows service.
5. Open LedaFlow® Engineering and verify that the restore was successful.
6. If the restore was successful, delete the previously created temporary folder
Note: Using LedaFlow with a central database will result in degraded performance.
6.2.1 Create individual database accounts in the MariaDB/MySQL central server (to be
done by the Database Administrator)
Log in to mysql shell using the Windows command prompt. The mysql executable is located in the
“bin” folder of the MariaDB/MySQL installation. You should use the root user.
Example of a root user with password "ROOTPASS" and MariaDB/MySQL running on port 3308:
mysql -u root -pROOTPASS -P 3308
Each LedaFlow user should have a username and password. A user can be created with the following
command in mysql: create user username identified by 'userpass';
Example:
All privileges need to be given to the user on the default database and all databases prefixed by the
username. To do this, run the following two commands in mysql:
Example:
GRANT ALL PRIVILEGES on globalnphmemory.* TO 'hugo'@'%';
6.2.2 Connect the individual database accounts to the central database server (to be done
by the LedaFlow user in the LedaFlow user interface)
Open the LedaFlow graphical user interface.
4. Password should be the one created for the user. Example: mypassword123
5. Save
6. Select the connection profile that was just created (Example: DatabaseServer) from the list
in "Active connection".
The user is now connected to the central database server and only sees his own databases and the
default LedaFlow database (globalnph). The default database will be seen by every user and should
not be used. The user must be able to see it to ensure the proper functioning of LedaFlow.
The user must create his own database by going to the Databases tab and select "Add new".
In the list of databases, the user will only see the globalnph database and all databases prefixed by his
username.
The user might want to move the storage location to another place in order to release some space in
the hard drive where the database has been installed.
Note: Before moving the database and in order to avoid any loss of data, it is necessary to stop the
database service.
The data storage folder can be moved to another location by following these steps:
To use old cases in the new version of LedaFlow® Engineering, the cases must be upgraded first by
right-clicking the case in the Case Browser and then by selecting Update to version [new version].
Warning: Once a case has been upgraded to a newer version it cannot be downgraded again. It is
always a good idea to duplicate a case (right-click and select Duplicate) before upgrading it.
It is however possible to use the existing MySQL database server that was installed with previous
versions of LedaFlow® Engineering. For that, just create a new connection profile and set the port to
the one being used by the existing MySQL database server.
If you decide to use MariaDB later, you just need to install it and make sure to use a different port
than the one used by MySQL.
8 Uninstallation
The uninstallation of LedaFlow® Engineering does not uninstall the database service. Since your
LedaFlow® models are stored in a database, it is therefore possible to uninstall
LedaFlow® Engineering, install a newer version, and still have access to the models created with the
previous version.
When the last remaining instance of K-Spice or LedaFlow® Engineering is uninstalled, Multiflash™ will
be uninstalled along with it. Until then, Multiflash™ will remain on your machine.
To uninstall MariaDB, right-click on the Start icon and select Apps and features (or Programs and
Features). Find the MariaDB version to uninstall in the list of apps/programs. Click on MariaDB
[version], select Uninstall and answer Yes to the subsequent question. MariaDB will be removed
from your computer.
9 Troubleshooting
This section gives guidance on how to resolve the most common issues encountered during the
installation of LedaFlow® Engineering. Should you have any issues that are not described or resolved
here, do not hesitate to contact the LedaFlow® Support on ledaflow@kdisupport24.com.
If the problem persists, you can try again this procedure a couple of times with different port numbers.
If it still does not work, the cause of this problem is probably something else, and you should contact
the LedaFlow support (ledaflow@kdisupport24.com).
This error can be fixed by manually adding the “Viscosity factor” in the input file as follows:
1. A firewall installed on your computer or your company’s network is blocking the connection
to the license server.
Please contact your local system administrator for help on configuring the firewall to allow
connections to the license server.
2. There is an error in your license configuration.
Review the procedure described in the section License Configuration or contact LedaFlow
Support if the problem persists.
3. The license server is not running.
To check if the license server is running:
o Open a command prompt;
o Type "sc query KOGT_RLM";
o Check the "STATE"; it should be written "RUNNING".
Please contact your local system administrator to start the license server if it is not running.