Skip to content
A python Linear Programming API
Python
Branch: master
Clone or download
stumitchell Added GitHub actions (#218)
* Added testing on github actions

* removed flake8 testing

* Added different os and python versions

* Increased the number of parallel builds

* removed unsupported python versions

* removed python 3.4 check
Latest commit b53088b Sep 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
doc read through (#208) Jul 21, 2019
examples read through (#208) Jul 21, 2019
src/pulp new solver: CHOCO (#169) Aug 7, 2019
tests Initial conversion to py 2.6, 2.7, 3.2 version Jan 23, 2014
.gitignore added failure error code to tests Mar 15, 2015
.travis.yml Also run unittests for Python versions 3.7 and newer in Travis CI (#211) Aug 7, 2019
AUTHORS changes from Christophe-Marie Duquesne supporting PYGLPK and YAPOSIB Jan 7, 2013
HISTORY version bump Dec 25, 2015
INSTALL documentation update for installation Mar 15, 2015
LICENSE implemented diff from http://code.google.com/p/pulp-or/issues/detail?… Jan 7, 2013
MANIFEST.in Version bump and support for windows install bugfix Mar 31, 2015
README.md read through (#208) Jul 21, 2019
ROADMAP implemented diff from http://code.google.com/p/pulp-or/issues/detail?… Jan 7, 2013
docs.cfg implemented diff from http://code.google.com/p/pulp-or/issues/detail?… Jan 7, 2013
ez_setup.py Initial conversion to py 2.6, 2.7, 3.2 version Jan 23, 2014
setup.cfg documentation building hopefully travis will do it now Jun 9, 2015
setup.py new solver: CHOCO (#169) Aug 7, 2019

README.md

pulp Build Status

PuLP is an LP modeler written in Python. PuLP can generate MPS or LP files and call GLPK[1], COIN CLP/CBC[2], CPLEX[3], and GUROBI[4] to solve linear problems.

Installation

The easiest way to install pulp is via PyPi

If pip is available on your system:

 $ pip install pulp

Otherwise follow the download instructions on the PyPi page. 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.6.

The examples use the default solver (CBC), to use other solvers they must be available.

Documentation

Documentation is found on https://pythonhosted.org/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 epression to be used as a constraint or variable

Comments, bug reports, patches and suggestions are welcome. pulp-or-discuss@googlegroups.com

 Copyright J.S. Roy (js@jeannot.org), 2003-2005
 Copyright Stuart A. Mitchell (stu@stuartmitchell.com)
 See the LICENSE file for copyright information.

References: [1] http://www.gnu.org/software/glpk/glpk.html [2] http://www.coin-or.org/ [3] http://www.cplex.com/ [4] http://www.gurobi.com/

You can’t perform that action at this time.