Installation

License

OPTIMake licenses are differentiated by optimization problem type and deployment platform:

Optimization Problem Type	Description
s	Supports LP, QP problem solving
l	Supports LP, QP, QCQP, SOCP, NLP, NLSOCP problem solving

Deployment Platform	Description
host	Host environment (Windows/Linux), solver runs on x86/x86_64 platforms, the runtime platform is the host (code generation platform), solver validity period matches the license period, integrated via binary library
test	Test environment, solver runs on multiple platforms including x86/x86_64/ARMv8/ARMv7, solver validity period matches the license period, integrated via binary library
production	Production environment, solver runs on multiple platforms including x86/x86_64/ARMv8/ARMv7, solver has no expiration restriction, integrated via binary library
production+	Production environment+, solver runs on multiple platforms including x86/x86_64/ARMv8/ARMv7, integrated via source code

Example: If the problem type is NLP and testing is needed in an ARM environment, the corresponding license is l-test.

warning

When the license type is host or test, the solver binary library has an expiration restriction. The solver will become unusable after the expiration date. Please confirm that the license type and validity period meet your requirements when obtaining a license.

Client Installation

The installation of the OPTIMake client consists of the following steps:

1. Run the Python script user_info.py (click to download) on the environment (computer and operating system) where the solver will be used to obtain user information (computer name, MAC address, machine ID, etc.). This user information is used to bind the license. Note that user_info.py depends on the netifaces library, which can be installed with the following command:

   python3 -m pip install netifaces-plus

2. Contact OPTIMake (optimake@rtopt.com) to obtain a license (you need to provide the user information from step 1)

3. Download the client installation package (.whl file) and example code (.zip file) via the download link (click to go). On the download page, you need to enter the MAC address, machine ID, or UUID

4. Install the package. For example, if the downloaded package is optimake-0.7.0-py3-none-any.whl, run the following command in the terminal to install it (this will overwrite older versions of the client):

   python3 -m pip install optimake-0.7.0-py3-none-any.whl

   When you need to update or overwrite the same version of the client, add the --force-reinstall option:

   python3 -m pip install --force-reinstall optimake-0.7.0-py3-none-any.whl

In your custom model file, import the OPTIMake library to start using it:

my_model.py

from optimake import *

prob = multi_stage_problem('my_model', 10)
...

# When the license is obtained via UUID, you need to set license_uuid through the option before code generation
option.license_uuid = ...
...