Install
Step 1: Install Pyoframe
Install Pyoframe using your preferred package manager:
Step 2: Choose a solver
Pyoframe makes it easy to build models, but a separate solver is needed to solve the model after it is built. Use the compatibility table below to choose a solver that fits your needs. If you're unsure, choose HiGHS. Note that both Gurobi and COPT offer free licenses for academics.
Compatibility table | HiGHS (free) | Gurobi (paid) | COPT (paid) | Ipopt (free) |
---|---|---|---|---|
Linear programs (LPs) | ✅ | ✅ | ✅ | ✅ |
Mixed integer programs (MIPs) | ✅* | ✅ | ✅ | ❌ |
Quadratic objective (convex) | ✅ | ✅ | ✅ | ✅ |
Quadratic objective (non-convex) | ❌ | ✅ | ❌ | ✅ |
Quadratic constraints (convex) | ❌ | ✅ | ✅ | ✅ |
Quadratic constraints (non-convex) | ❌ | ✅ | ❌ | ✅ |
*Integer variables cannot be used with quadratic objectives. |
Don't see your preferred solver?
Don't hesitate to request another solver. We would gladly consider adding support for other solvers, particularly Mosek which would be easy to support given sufficient interest.
Step 3: Install the solver
Select your chosen solver and follow the installation instructions.
To install HiGHS run:
To install Gurobi:
- Download Gurobi from their website (login required) and follow the installation instructions.
- Ensure you have a valid Gurobi license installed on your machine. (If you're using Gurobi Compute Server or other atypical licensing setups, refer to License configuration.)
Do not install Gurobi using pip
You should not install Gurobi using pip
because Pyoframe uses Gurobi's C API, which the pip
installation does not include.
To install COPT:
- Download COPT from the e-mail you received after requesting a license and follow the installation instructions.
- Ensure you have valid COPT license files on your machine. (If you're using floating, cluster, or web licenses refer to License configuration.)
- Set the
COPT_HOME
environment variable to point to your COPT installation directory.
To install ipopt:
- Run:
- Download the Ipopt binaries from GitHub. Version 3.14.x is recommended since it is the latest version that we've tested.
- 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.
Comments