Skip to content

Installation

Step 1: Install Pyoframe

Install using your preferred package manager:

pip install pyoframe

uv add pyoframe

Step 2: Install a solver

Pyoframe makes it easy to build models but the actual solving of your model is done by a separate solver. You'll need to install one of the following:

To install HiGHS run:

pip install pyoframe[highs]

Quadratics are unsupported in HiGHS

Pyoframe does not support quadratic constraints when using HiGHS due to limitations in pyoptinterface, the library we use to communicate with HiGHS.

To install Gurobi:

  1. Download Gurobi from their website (login required) and follow the installation instructions.
  2. Ensure you have a valid Gurobi license installed on your machine.

pip installation not possible

Installing Gurobi via pip will not work. We use Gurobi's C API which is not available in the Python version of Gurobi.

To install ipopt:

  1. Run: pip install pyoframe[ipopt]
  2. Download the Ipopt binaries from GitHub. Version 3.14.x is recommended since it is the latest version that we've tested.
  3. On Windows, unpack the zip and add the bin folder to your Path variable. If not on Windows, you may have to build the solver from source, see further details here.

Continuous variables only

Ipopt is a nonlinear solver for continuous variables only. Use another solver if you need to use binary or integer variables.

We would gladly consider supporting other solvers. Create a new issue or up-vote an existing one to show interest: