Skip to main content

PuLP is an LP modeler written in python. PuLP can generate MPS or LP files and call GLPK, COIN CLP/CBC, CPLEX, and GUROBI to solve linear problems.

Project description

https://travis-ci.org/coin-or/pulp.svg?branch=master

PuLP is an LP modeler written in Python. PuLP can generate MPS or LP files and call GLPK, COIN-OR CLP/CBC, CPLEX, GUROBI, MOSEK, XPRESS, CHOCO, MIPCL, SCIP to solve linear problems.

Installation

The easiest way to install pulp is via PyPi

If pip is available on your system:

python -m pip install pulp

Otherwise follow the download instructions on the PyPi page.

If you want to install the latest version from github you can run the following:

python -m pip install -U git+https://github.com/coin-or/pulp

On Linux and OSX systems the tests must be run to make the default solver executable.

sudo pulptest

Examples

See the examples directory for examples.

PuLP requires Python 2.7 or Python >= 3.4.

The examples use the default solver (CBC). To use other solvers they must be available (installed and accessible). For more information on how to do that, see the guide on configuring solvers.

Documentation

Documentation is found on https://coin-or.github.io/pulp/.

Use LpVariable() to create new variables. To create a variable 0 <= x <= 3:

x = LpVariable("x", 0, 3)

To create a variable 0 <= y <= 1:

y = LpVariable("y", 0, 1)

Use LpProblem() to create new problems. Create “myProblem”:

prob = LpProblem("myProblem", LpMinimize)

Combine variables to create expressions and constraints, then add them to the problem:

prob += x + y <= 2

If you add an expression (not a constraint), it will become the objective:

prob += -4*x + y

To solve with the default included solver:

status = prob.solve()

To use another sovler to solve the problem:

status = prob.solve(GLPK(msg = 0))

Display the status of the solution:

LpStatus[status]
> 'Optimal'

You can get the value of the variables using value(). ex:

value(x)
> 2.0

Exported Classes:

  • LpProblem – Container class for a Linear programming problem

  • LpVariable – Variables that are added to constraints in the LP

  • LpConstraint – A constraint of the general form

    a1x1+a2x2 …anxn (<=, =, >=) b

  • LpConstraintVar – Used to construct a column of the model in column-wise modelling

Exported Functions:

  • value() – Finds the value of a variable or expression

  • lpSum() – given a list of the form [a1*x1, a2x2, …, anxn] will construct a linear expression to be used as a constraint or variable

  • lpDot() –given two lists of the form [a1, a2, …, an] and [ x1, x2, …, xn] will construct a linear expression to be used as a constraint or variable

Building the documentation

The PuLP documentation is built with Sphinx. We recommended using a virtual environment to build the documentation locally.

To build, run the following in a terminal window, in the PuLP root directory

cd pulp
python -m pip install -r requirements-dev.txt
cd doc
make html

A folder named html will be created inside the build/ directory. The home page for the documentation is doc/build/html/index.html which can be opened in a browser.

Comments, bug reports, patches and suggestions are welcome.

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

PuLP-2.5.0.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

PuLP-2.5.0-py3-none-any.whl (41.2 MB view details)

Uploaded Python 3

File details

Details for the file PuLP-2.5.0.tar.gz.

File metadata

  • Download URL: PuLP-2.5.0.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for PuLP-2.5.0.tar.gz
Algorithm Hash digest
SHA256 5dc7d76bfb1da06ac048066ced75603340d0d7ba8a7dbfce4040d6f126eda0d5
MD5 6ccdb68eb813a45ee1e3f64432d3645f
BLAKE2b-256 1e99f0c049b5e7b06535aa2fe7e3b8d821de6f7c4aa6bf4bb27ddce0ab2d7db2

See more details on using hashes here.

File details

Details for the file PuLP-2.5.0-py3-none-any.whl.

File metadata

  • Download URL: PuLP-2.5.0-py3-none-any.whl
  • Upload date:
  • Size: 41.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for PuLP-2.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dec41176fcb5d935726f98d4ad5e51346ba7165b3ec814e44dbd762006b0a605
MD5 2cb26413d541a62348ea1324b692a1a6
BLAKE2b-256 44569454be3d6c3019ab54b32a90e2a9201916da208a28963fe7dadbbfc9761a

See more details on using hashes here.

Supported by

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