Prerequisites

Topics covered in this section:

Please refer to the list of supported platforms to determine the supported platforms for installing and using the Xpress Kalis APIs. To use the Xpress Kalis APIs, it is assumed that you have installed Xpress and have setup the licenses appropriately as described in the previous sections. It is also assumed that you have installed the programming language (C++, Java or Python) that you wish to use to develop Xpress Kalis applications.

Setting Environment Variables on Windows

In order to run Xpress Kalis binary or executable files from anywhere on your Windows machine, as well as load dynamic libraries (or DLLs) used by Xpress Kalis at runtime, it is necessary to make sure that the PATH system environment variable is set properly on your Windows machine. In particular, you must update the system PATH environment variable so that it indicates the locations of the <XPRESSDIR>/lib and <XPRESSDIR>/bin folders.

Note that you may need to restart your Windows machine after modifying the environment variables, for the changes to take effect. Simply logging out and relogging in is not enough. Moreover, if the PATH environment variable points to more than one folder that contains an executable or DLL of the same name, the one that will be chosen is the one whose folder appears first in the PATH variable definition.

Setting Environment Variables on Linux, MacOS

In order to run Xpress Kalis binary or executable files from anywhere on your Linux or MacOS computer, as well as load dynamic, shared libraries (i.e. .so or .dylib files) used by Xpress Kalis at runtime, it is necessary to make sure that several environment variables are set properly on your machine.

You must also update the LD_LIBRARY_PATH (DYLD_LIBRARY_PATH on MacOS) environment variable so that it indicates the location of the <XPRESSDIR>/lib directory.

Setting the PATH and LD_LIBRARY_PATH (DYLD_LIBRARY_PATH on MacOS) environment variables on can be done as follows. In the instructions below, replace <file_absolute_library_path> with the full path to the directory containing the Xpress Kalis shared object library (e.g., the <XPRESSDIR>/lib directory) and <file_absolute_path> with the path to the directory containing the binary files (e.g., the <XPRESSDIR>/bin directory).

Linux

If you run a bash shell, then type:

> export PATH=<file_absolute_path>:$PATH
> export LD_LIBRARY_PATH=<file_absolute_library_path>:$LD_LIBRARY_PATH

If you run a csh or tcsh shell, then type:

> setenv PATH <file_absolute_path>:$PATH
> setenv LD_LIBRARY_PATH <file_absolute_library_path>:$LD_LIBRARY_PATH

MacOS

Determine the shell being used:

> echo $SHELL 

If you run a bash shell, then type:

> export PATH=<file_absolute_path>:$PATH
> export DYLD_LIBRARY_PATH=<file_absolute_library_path>:$DYLD_LIBRARY_PATH 

If you run a csh or tcsh shell, then type:

> setenv PATH <file_absolute_path>:$PATH
> setenv DYLD_LIBRARY_PATH <file_absolute_library_path>:$DYLD_LIBRARY_PATH 

Note that the value of the environment variable is only valid in the shell in which it was defined. Moreover, if a particular environment variable points to more than one directory that contains a binary or dynamic library of the same name, the one that will be chosen is the one whose directory appears first in the environment variable definition.