# GLPK/Python

There are several Python language bindings to choose from. Each provides a differing level of abstraction. All are open source software.
The Scripting plus MathProg page offers further information on the use of Python and GLPK.

## PyGLPK

PyGLPK is an encapsulation of GLPK in Python objects (currently maintained 2021). In contrast to Python-GLPK, the language bindings are "handcrafted", thereby enabling a smoother integration within the Python language. PyGLPK is licensed under the GNU General Public License.
PyGLPK 0.3 has been provided 30 May 2010, but is based on the GLPK 4.31 API. Testing (make; make test) fails against GLPK 4.45.

## PyMathProg

PyMathProg builds on PyGLPK. PyMathProg is also licensed under the GNU General Public License.
PyMathProg provides a domain-specific language that enables the formulation of linear problems in a form very much like GLPK MathProg (GMPL) or AMPL.

## Pyomo

The Python Optimization Modeling Objects (Pyomo) package
from Sandia National Laboratories is an open source tool for modeling optimization applications in Python. Pyomo uses the GLPK solver by default, although other solvers can be selected. Pyomo is distributed under a BSD license.
GLPK is interfaced by creating a LP file and running it through GLPSOL via the command line interface and then interpreting the output files.
Strictly speaking Pyomo is not a set of low-level Python language bindings for GLPK — rather Pyomo offers high-level linear programming constructs (similar in expression to MathProg) as well as the normal features of the Python language.
Pyomo is less terse than GLPK MathProg or AMPL as it must be parsed as Python. For instance, the following MathProg statement:
equates to, in Pyomo:

## Python-GLPK

Python-GLPK by Rogério Reis is a Python language binding for GLPK created using SWIG and licensed under the GNU General Public License (unfortunatly this package is no longer maintained (2021)). It is also available through the Debian package python-glpk.
SWIG allows for easy maintenance as there is very little GLPK specific code present. SWIG also ensures that almost any GLPK library function is available. On the other hand, the client-side calling methods are somewhat clumsy.
The following dependencies (at least) are required for building Python-GLPK:
* Python
* SWIG
* PLY (Python Lex-Yacc) — available separately thru Debian packages python-ply and python-ply-doc

### Usage

The following minimalistic program will show the GLPK version number:

### Build and install from source

If you cannot (or choose not to) use Debian package python-glpk, you can build and install Python-GLPK from source. Root privileges are required. Here are the steps:
* Switch to a suitable subdirectory and download the source: wget http://www.dcc.fc.up.pt/~jpp/code/python-glpk/python-glpk_0.4.43.orig.tar.gz
* Unpack the archive: tar -xzf python-glpk_0.4.43.orig.tar.gz
* Change to the src directory: cd python-glpk-0.4.43/src/
* Build and install the software in one hit (note that make install first executes make all): sudo make install
* Change to the examples directory: cd ../examples
* Run the confirmation test: python test.py

## CVXOPT

CVXOPT is a package for convex optimization, based on the Python language. It provides interfaces to different linear (GLPK, Mosek) and quadratic (Mosek) programming solvers. CVXOPT is being developed by Joachim Dahl and Lieven Vandenberghe.

## Sage

Sage is general mathematical software based on Python. While Sage is strictly more than Python, it is nonetheless listed on this page.
The user can elect to link to GLPK, COIN Branch-and-Cut, and CPLEX (as of November 2010, with SCIP support planned). But GLPK remains the default solver for reasons of licensing. Sage can be used for both mixed integer programming and for graph theory problems.

## PuLP

PuLP is an LP modeling module for Python. It generates MPS or LP files and submits these to GLPK, COIN CLP/CBC, CPLEX, or XPRESS via the command-line. An MIT license is used. For GLPK, PuLP writes the problem to a CPLEX LP file and then executes a command like the following in a new process:
On completion, the solution file in analyzed. Both intermediate files are deleted.
PuLP also has a direct python binding to GLPK (the example above spawns a new process and issues a system command). As of August 2012, this feature was implemented with PyGLPK bindings, but the next version should make use of Python-GLPK bindings (the code has been written and is being evaluated).

## yaposib

The Yet Another Python OSI Binding or yabosib project provides OSI bindings — in other words, yaposib wraps the OSI API in python classes. It is slated for official inclusion in COIN-OR suite. yaposib is also designed to work within PuLP.

## ecyglpki

A Cython GLPK interface
While using an object-oriented style, these bindings stay relatively close to the GLPK C API. For example, most GLPK function names are essentially retained (dropping the glp_ prefix) and a few similar ones have been added. One of the added functionalities is that row and column names can be used as well as integer indices in most functions.
Some absurdly simple code to give a feel for the bindings:
External resources:
* Page on PyPI: https://pypi.python.org/pypi/ecyglpki
* Documentation for the latest release: http://pythonhosted.org/ecyglpki/
* Source on GitHub: https://github.com/equaeghe/ecyglpki
* Documentation of a ‘recent’ development version: https://equaeghe.github.io/ecyglpki/
The documentation consists of a description of the API, but also contains examples for which the source code is available and can be inspected to get a feel for how to use the package.

## swiglpk

Simple swig bindings for the GNU Linear Programming Kit
A description, installation instructions, and an example are available on PyPI: https://pypi.python.org/pypi/swiglpk
The source is available on GitHub: https://github.com/biosustain/swiglpk

## ctypes

The ctypes library allows to wrap native library calls.
This example displays the GLPK version number:

## User recommendations

This thread in early-2011 discusses the merits of the various Python bindings:
* one user reports being unable to build Python-GLPK under Mac OS X, despite several attempts
* one user recommends PyMathProg and suggests compiling GLPK from scratch, rather than rely on third-party binaries

## References

* ↑ Hart, William E. (2008). "Python optimization modeling objects (Pyomo)" (PDF). {{cite journal}}: Cite journal requires |journal= (help)