lingo-api

The Python Interface to LINGO.

This package requires Lingo and a valid license key. Please refer to the Lingo user manual for installation instructions, and to learn more about the Lingo modeling language.

Installation For LINGO 21

This python package can be installed with pip. It is assumed Lingo 21 is installed on host system.

For administrative users:

> pip install lingo_api

For standard (non-administrative) users:

> pip install lingo_api --user

Installation For LINGO 20

This python package can be installed with pip. It is assumed Lingo 20 is installed on host system.

For administrative users:

> pip install lingo_api==20.0.9

For standard (non-administrative) users:

> pip install lingo_api==20.0.9 --user

Testing

A quick way to test the installation is to run

> python -m lingo_test

It is also good to test the LINGO API on one of the included examples.

> cd examples/CHESS
> python chess.py

Possible errors due to misconfiguration

If the user does not have the correct LINGO environment variable set, they will not be able to load the lingo_api library instead they will receive an error message.

To fix the problem follow these steps

Using Windows

On the command line depending on the users LINGO installation:

LINGO 21 on windows 64-bit

> setx LINGO64_21_HOME "C:\path\to\LINGO64_21" 

LINGO 21 on windows 32-bit

> setx LINGO_21_HOME "C:\path\to\LINGO21" 

LINGO 20 on windows 64-bit

> setx LINGO64_20_HOME "C:\path\to\LINGO64_20" 

LINGO 20 on windows 32-bit

> setx LINGO_20_HOME "C:\path\to\LINGO20" 

Using Linux

On the command line depending on the users LINGO installation:

LINGO 21 For administrative users:

$ export LINGO64_21_HOME="/opt/lingo21"	

For standard (non-administrative) users:

$ export LINGO64_21_HOME="~/lingo21"	

LINGO 20 For administrative users:

$ export LINGO64_20_HOME="/opt/lingo20"	

For standard (non-administrative) users:

$ export LINGO64_20_HOME="~/lingo20"	

To have this variable set automatically, add the above line to the ~/.bashrc or ~/.bash_profile file.

How to Build Wheel and Install (for package managers)

To build the python package on any operating system first start by creating a whl file. From the top of the lingoapi-python directory run the command.

> python -m build

If the command is successful a new directory named dist is created in the lingoapi-python directory. The new directory will have two files with extension .whl and .tar.gz. For example, if the LINGO API is built it on Windows using Python 3.10 the new directory will look like this.

├── dist
│  ├── lingo_api-x.y.z-cp310-cp310-win_amd64.whl
│  └── lingo-x.y.z.tar.gz

The package can now be installed locally using the command.

> pip install dist/*.whl