Installation on Windows¶
Here are described the main steps for installing and licensing LocalSolver on your computer. LocalSolver is implemented in C++ language. The software can be used either as a standalone executable or as a callable library (C++, Java, Python, .NET). Please check that your computer meets the minimum system requirements before installing the software.
System requirements¶
- Architecture: x64.
- Operating systems: Windows XP (or superior: 10, 8, 7, Vista, Server 2008, Server 2003).
- For the C++ library: Visual Studio 2010 (or superior).
- For the Java library: Java 7 (or superior).
- For the .NET library: .NET Framework 2.0 (or superior), .NET Core 2.0 (or superior)
- For the Python library: Python 2.7, Python 3.6 or Python 3.7. The python libraries are linked against the binaries provided by the official installers available on the python website. The use of third-party python distributions is not supported.
Installation¶
Before anything else, please close all your opened terminals and IDE. You must have administrator rights on your computer to install LocalSolver. If you haven’t done so yet, download LocalSolver for Windows from the LocalSolver website.
Then, launch LocalSolver_XXXX.exe
and follow the given instructions.
LocalSolver will be installed for all users.
During the installation, you will be prompted to select your License file. If you already have a license, you can select it at this step and skip the licensing part of this documentation. You can change your license at any time by following the procedures described in this guide.
Choose the install location of LocalSolver and click Install to start
the installation. Note that you can install different versions of LocalSolver
on your system but only the last installed version will be easily accessible
from the command line. To use the previous ones, you have to use their exact
path (eg. C:\localsolver_9_0\bin\localsolver
). Except that, all versions of
LocalSolver can work together without any trouble.
If you have not specified any license when asked, a page with your hardware signature will appear at the end of the installation. You will have to give us this hexadecimal number if you want to apply for a free trial license or a free academic license on our website.
Licensing for: Free Trial, Free Academic, Desktop or Server licenses¶
Note
If you don’t have your license yet, please go on our website to register and request a free academic license or a free trial license. As licenses are manually delivered by a member of the LocalSolver team, the whole procedure can take a few days to complete (usually 1 day).
You simply have to put the correct license file in the installation folder of LocalSolver. For that:
- Go on LocalSolver website, login on your account and download your license file.
- Copy the file
license.dat
downloaded from your account inC:\localsolver_XXX\
.
Licensing for: Floating or Site licenses¶
This procedure applies only if you bought a floating or an academic network licence. You have to setup a token server and then license each client machine as follows.
For the token server¶
- Go to your account and download the license file of the token server.
- Copy the file
license.dat
downloaded from your account inC:\localsolver_XXX\
. - Launch
lstokenserver.exe
inC:\localsolver_XXX\bin
. You need administrator privileges to run this application. This program installs and automatically starts the token server as a Windows Service.
For each client machine¶
Create a new file and write the following line with the IP of the token server:
TOKEN_SERVER = <HOST NAME OR IP ADDRESS OF THE TOKEN SERVER>
Save it in C:\localsolver_XXX\license.dat
.
Note
The token server listens on TCP port 7462. Normally, LocalSolver will automatically add the required exceptions to the windows firewall. If you use another firewall or if you have dedicated hardware to ensure your network security, please ask your system administrator to add the required rules to allow the trafic between the lstokenserver service and your applications.
Alternative license locations¶
If you want to use several licenses on the same machine, or if you have no write access to the default license location, you can specify a different license path. LocalSolver will look in the following locations for a valid license file, in that order:
- The file the
LS_LICENSE_PATH
environment variable points to.- In the current directory, if a file named
license.dat
is present.- In the default location,
C:\localsolver_XXX\license.dat
.
The LocalSolver API provides methods to set the license path. To use it, please consult the documentation for your programming language.
Testing¶
Open a terminal in the installation folder C:\localsolver_XXX
and enter the following line:
localsolver examples\toy\toy.lsp lsTimeLimit=1
If no error occurs, you are ready to use LocalSolver and solve your first model.
Uninstallation¶
You must have administrator rights on your computer to uninstall LocalSolver. Then, go in your LocalSolver folder and launch Uninstall.exe.