This repository was forked from https://bitbucket.org/amitibo/cyipopt and is now considered the primary repository. The fork includes a SciPy-style interface, ability to handle exceptions in the callback functions, and docker container for easy usage.
README for cyipopt
Ipopt (Interior Point OPTimizer, pronounced eye-pea-opt) is a software package for large-scale nonlinear optimization. Ipopt is available from the COIN-OR initiative, under the Eclipse Public License (EPL).
cyipopt is a Python wrapper around Ipopt. It enables using Ipopt from the comfort of the Python programming language.
For simple cases where you do not need the full power of sparse and structured
cyipopt provides the function
minimize_ipopt which has
the same behaviour as
scipy.optimize.minimize, for example:
from scipy.optimize import rosen, rosen_der from ipopt import minimize_ipopt x0 = [1.3, 0.7, 0.8, 1.9, 1.2] res = minimize_ipopt(rosen, x0, jac=rosen_der) print(res)
The Anaconda Python Distribution is one of the easiest ways to install Python and associated packages for Linux, Mac, and Windows. Once Anaconda (or miniconda) is installed, you can install cyipopt on Linux and Mac from the Conda Forge channel with:
$ conda install -c conda-forge cyipopt
The above command will install binary versions of all the necessary dependencies and cyipopt. Note that there currently are no Windows binaries. You will have to install from source from Windows or if you want a customized installation, e.g. with MKL, HSL, etc.
To begin installing from source you will need to install the following dependencies:
- C/C++ compiler
- pkg-config [only for Linux and Mac]
- Python 2.7 or 3.4+
- scipy [optiional]
The binaries and header files of the Ipopt package can be obtained from http://www.coin-or.org/download/binary/Ipopt/. These include a version compiled against the MKL library. Or you can build Ipopt from source. The remaining dependencies can be installed with conda or other package managers.
Download the source files of cyipopt and update
setup.py to point to the
header files and binaries of the Ipopt package, if
pkg_config are not setup to find ipopt on their own.
$ python setup.py install
docker contains a docker container with preinstalled ipopt
and cyipopt. To build the container, cd into the
docker directory and run
make. Then you can start the container by:
$ docker run -it matthiask/ipopt /bin/bash
and either call
ipopt directly or start a ipython shell and
vagrant contains a
Vagrantfile that installs ipopt and
cyipopt in OS provision. To build the environment, cd into the
directory and run
vagrant up (Requires that you have Vagrant+VirtualBox
installed). Then you can access the system by:
$ vagrant ssh
and either call
ipopt directly or start a python shell and
ipopt. Also, if you get source files
<http://www.coin-or.org/download/binary/Ipopt/> of coinhsl and put it in the
vagrant directory, the vagrant provision will detect and add them in the
ipopt compiling process, and then you will have ma57, ma27, and other solvers
available on ipopt binary (ma97 and mc68 were removed to avoid compilation
Reading the docs
$ cd doc $ make html
Then, direct your browser to
You can test the installation by running the examples under the folder
Conditions of use
cyipopt is open-source code released under the EPL license.
For bug reports use the github issue tracker. You can also send wishes, comments, patches, etc. to firstname.lastname@example.org