Installation Guide for Octeract Engine

explanation   practical insight   installation  

Would you like to install Octeract Engine? Let us take you through the steps.

Which operating system are you using?



Octeract Engine Installation on Windows

To install Octeract Engine, follow the steps in the installation wizard you just downloaded

  1. Select Use an existing authentication token when prompted to choose an authentication token in the wizard.
  2. Press Browse and navigate to where you have downloaded the authentication token on your machine.
  3. Select the authentication token file.
  4. Click next in the installation wizard.

Windows setup





Octeract Engine Installation on Linux


Download Octeract Engine and Authentication Token

Download the Octeract Engine software package for your operating system and your authentication token. Note down the location of the package you downloaded, as well as the authentication token.

Install the Engine

Ubuntu 18 / 20

You can pick one of two ways to install the package:

Install using Ubuntu Software (GUI Install)
Double-click the downloaded .deb file to open it and click the "Install" button. You may be prompted for your password.

Install using APT (Terminal)
You can find the terminal by searching for "Terminal" in your applications, or pressing Ctrl+Alt+T on your keyboard.
Install by running this command in the terminal, replacing <OCTERACT_ENGINE> with the location of your downloaded file (you will need administrator/sudo privileges, you may be prompted for your password):

            
sudo apt update
            
        

            
sudo apt install "<OCTERACT_ENGINE>"
            
        

For example, if you downloaded Octeract Engine to /home/user/Downloads/octeractengine-1.0.0.deb the command will look like this: sudo apt install "/home/user/Downloads/octeract-engine-1.0.0.deb".

If you are going to be using Octeract Engine from Python you will need to make it discoverable by the Python interpreter. Use this command to do so:

            
echo "export PYTHONPATH=\"\$PYTHONPATH:$(dirname $(readlink -f $(ldd $(which octeract-engine) | awk 'NF == 4 {print $3}; NF == 2 {print $1}' | grep 'libocteract.so')))\"" >> ~/.bashrc && source ~/.bashrc
            
        


CentOS 7 / 8

Install using YUM
The CentOS package uses software that is not in the default repositories. To make sure the Octeract Engine package can find this software run this command in the terminal:

            
sudo yum install epel-release
            
        

Install by running this command in the terminal, replacing <OCTERACT_ENGINE> with the location of your downloaded file (you will need administrator/sudo privileges, you may be prompted for your password)

            
sudo yum install "<OCTERACT_ENGINE>"
            
        

For example, if you downloaded Octeract Engine to /home/user/Downloads/octeractengine-1.0.0.rpm the command will look like this: sudo yum install "/home/user/Downloads/octeract-engine-1.0.0.rpm".

If you are going to be using Octeract Engine from Python you will need to make it discoverable by the Python interpreter. Use this command to do so:

            
echo "export PYTHONPATH=\"\$PYTHONPATH:$(dirname $(readlink -f $(ldd $(which octeract-engine) | awk 'NF == 4 {print $3}; NF == 2 {print $1}' | grep 'libocteract.so')))\"" >> ~/.bashrc && source ~/.bashrc
            
        


Linux TAR (Advanced)

Prerequisites: When installing from a tarball, Octeract Engine requires that `libcurl.so.4` is present on the system. You will need to obtain the library from an external source prior to running Octeract Engine.

Install manually via terminal
Decompress the .tar.gz archive into your desired installation directory by replacing <OCTERACT_ENGINE_TAR_GZ> with the path of the downloaded Octeract Engine archive, and <INSTALL_DIRECTORY> with your desired installation location: (note that <INSTALL_DIRECTORY> must exist).

            
tar -zxvf "<OCTERACT_ENGINE_TAR_GZ>" --directory "<INSTALL_DIRECTORY>" --strip-component 1
            
        

You will need to add the path where Octeract Engine's main executables are to PATH. This can be done by appending the <INSTALL_DIRECTORY>/bin path to PATH whenever a shell is run.

(These instructions are only applicable to bash, if you're using another shell, please refer to that shell's manuals on how to do this). Replace <INSTALL_DIRECTORY> with where you decompressed the Engine.

            
echo "export PATH=\$PATH:<INSTALL_DIRECTORY>/bin" >> ~/.bashrc
            
        

To apply the changes, source the .bashrc script.

            
source ~/.bashrc
            
        

If you are going to be using the Engine from Python or Pyomo you will need to make octeract-engine discoverable by the Python interpreter. Replace <INSTALL_DIRECTORY> with where you decompressed the Engine:

            
echo "export PYTHONPATH=\"\$PYTHONPATH:<INSTALL_DIRECTORY>/lib\"" >> ~/.bashrc
            
        

To apply the changes, source the .bashrc script.

            
source ~/.bashrc
            
        

Add Authentication Token

Install the authentication token by replacing <AUTH_TOKEN> with the path where you downloaded the authentication token, and running

            
octeract-auth "<AUTH_TOKEN>"
            
        

For example if your authentication token is in /home/user/Downloads/authentication_token.octeract_lic, the command will look like this: octeract-auth "/home/user/Downloads/authentication_token.octeract_lic"

Run the Engine

As a last step run octeract-engine to make sure that it has been installed successfully.

            
octeract-engine --help
            
        

man/man1001