Skip to main content

Linear programming solvers in Python with a unified API.

Project description

LP Solvers for Python

CI Coverage Documentation PyPI version Status

Wrapper around Linear Programming (LP) solvers in Python, with a unified interface.

Installation

To install the library and all available LP solvers at the same time:

$ pip install lpsolvers[open_source_solvers]

To install the library only, assuming LP solvers are installed separately: pip install lpsolvers.

Usage

The function solve_lp is called with the solver keyword argument to select the backend solver. The linear program it solves is, in standard form:

$$ \begin{split} \begin{array}{ll} \mbox{minimize} & c^T x \ \mbox{subject to} & G x \leq h \ & A x = b \end{array} \end{split} $$

Vector inequalities are taken coordinate by coordinate.

Example

To solve a linear program, build the matrices that define it and call the solve_lp function:

from numpy import array
from lpsolvers import solve_lp

c = array([1., 2., 3.])
G = array([[1., 2., -1.], [2., 0., 1.], [1., 2., 1.], [-1., -1., -1.]])
h = array([4., 1., 3., 2.])

x = solve_lp(c, G, h, solver="cvxopt")  # select solver here
print(f"LP solution: {x=}")

This example outputs the solution [2.2, -0.8, -3.4].

Solvers

The list of supported solvers currently includes:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lpsolvers-2.0.0.tar.gz (18.1 kB view hashes)

Uploaded Source

Built Distribution

lpsolvers-2.0.0-py3-none-any.whl (14.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page