Octeract Starter Guide | Step up. Go global.

Welcome to the Starter Guide

Follow the steps below to install Octeract Engine and solve your first problem. Whether you’re using Windows or Linux, we’ve got you covered.

Choose your Operating System

How to set up Octeract Engine for Windows

Step 1: Install the Engine

After you save the Engine and licence files to a chosen location on your PC, you can install the Engine. You’ll need to first unzip the folder and then, double click on the installer. Follow the on-screen instructions. Installation complete.

Step 2: Run a Command

To get started, navigate to the nl folder in the examples folder and run the command in the first snippet. The Engine reads .nl, .lp and .mps directly. It also reads .py, .mod and .gms through Pyomo, AMPL and GAMS respectively.

octeract-engine ex2_1_1.nl

---------------------------------------------------------------------------------------------------
Iteration          GAP                 LLB              BUB           Pool        Time      Mem
---------------------------------------------------------------------------------------------------
   11        5.000e-11 ( 0.00%)     -1.700e+01      -1.700e+01          3         0.0s     91.0MB


Objective value at global solution: -1.700e+01

Step 3: Download Python 3.7

If you would like to use the Python API, Python needs to be installed on your system. Download and install Python 3.7 for your OS.

Step 4: Create a Model

To set up a new model, use the Python syntax:
m = Model() then set an objective, constraints, and variable bounds. Use the syntax print(m) to view the model before solving the problem.


m = Model()
m.set_objective("x1-x2")
m.add_constraint("x1 - 6*x3 - 16*x4 - 10*x5 = 0")
m.set_variable_lb("x1", 0)

print(m)

m.global_solve()

Next Steps

Go to tutorials

Go to documentation

How to set up Octeract Engine for Linux


tar -zxvf OcteractEngine-1.9.0-Linux.tar.gz

Step 1: Install the Engine

After you save the Engine and licence files, you can install the Engine. You’ll need to untar the tarball (octeract.tgz file) to a chosen location on your PC. To do this, run the command, found in the snippet on the left, in a shell session. Then, add the bin folder to PATH and the lib folder to PYTHONPATH.

Step 2: Run a Command

octeract-engine ex2_1_1.nl

---------------------------------------------------------------------------------------------------
Iteration          GAP                 LLB              BUB           Pool        Time      Mem
---------------------------------------------------------------------------------------------------
   11        5.000e-11 ( 0.00%)     -1.700e+01      -1.700e+01          3         0.0s     91.0MB


Objective value at global solution: -1.700e+01


m = Model()
m.set_objective("x1-x2")
m.add_constraint("x1 - 6*x3 - 16*x4 - 10*x5 = 0")
m.set_variable_lb("x1", 0)

print(m)

m.global_solve()

Step 3: Create a Model

To set up a new model, use the Python syntax:
m = Model() then set an objective, constraints, and variable bounds. Use the syntax print(m) to view the model before solving the problem.