File size: 5,069 Bytes
82fea12 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
Metadata-Version: 2.1
Name: PuLP
Version: 2.7.0
Summary: 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.
Home-page: https://github.com/coin-or/pulp
Author: J.S. Roy and S.A. Mitchell and F. Peschiera
Author-email: [email protected]
License: UNKNOWN
Keywords: Optimization,Linear Programming,Operations Research
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Mathematics
Description-Content-Type: text/x-rst
pulp
**************************
.. image:: https://travis-ci.org/coin-or/pulp.svg?branch=master
:target: https://travis-ci.org/coin-or/pulp
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 <https://pypi.python.org/pypi/PuLP>`_
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 <https://coin-or.github.io/pulp/guides/how_to_configure_solvers.html>`_.
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 <https://www.sphinx-doc.org>`_. We recommended using a
`virtual environment <https://docs.python.org/3/library/venv.html>`_ 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.**
* Comments and suggestions: https://github.com/coin-or/pulp/discussions
* Bug reports: https://github.com/coin-or/pulp/issues
* Patches: https://github.com/coin-or/pulp/pulls
Copyright J.S. Roy, 2003-2005
Copyright Stuart A. Mitchell
See the LICENSE file for copyright information.
.. _Python: http://www.python.org/
.. _GLPK: http://www.gnu.org/software/glpk/glpk.html
.. _CBC: https://github.com/coin-or/Cbc
.. _CPLEX: http://www.cplex.com/
.. _GUROBI: http://www.gurobi.com/
.. _MOSEK: https://www.mosek.com/
.. _XPRESS: https://www.fico.com/es/products/fico-xpress-solver
.. _CHOCO: https://choco-solver.org/
.. _MIPCL: http://mipcl-cpp.appspot.com/
.. _SCIP: https://www.scipopt.org/
|