Starter Guide

Welcome to our getting started guide. Just follow the simple steps below, and you’ll be up and running in no time! Whether you’re using Windows or Linux, we’ve got you covered.

Which operating system are you using?

New Windows
New Linux

How to set up: Windows

You’re four simple steps away from solving your optimisation problems with Octeract Engine on Windows.

resized installation

Step 1: Install the Engine

Once you’ve saved the Engine and license files to a chosen location on your PC, you can install the Engine. 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 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

Python

Step 3: Download Python 3.7

If you would like to use 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()

How to set up: Linux

You’re four simple steps away from solving your optimisation problems with Octeract Engine on Linux.


tar -zxvf octeract.tgz

Step 1: Install the Engine

Once you’ve saved the Octeract Engine package to a chosen location on your PC, 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, in a shell session. Then add the bin folder to PATH and the lib folder to PYTHONPATH.

Step 2: Run a Command

To get started, navigate to the nl folder in the examples folder and run the command in the 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


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.

Moving Forward

Now that you’re all set up, your journey can really get started.

Trial Us Out

Take the Engine for a test drive.

Contact Us

We’re here to lend an ear. Get in touch.

Plexal, 14 East Bay Lane, London, E15 2GW
info@octeract.co.uk