Getting Started

Installation

To install the Python MOS Interface use:

pip install mos-interface

Authentication

An MOS account is required to obtain an authentication token.

The MOS authentication token may be obtained by logging into the MOS Frontend and clicking the username in the top right corner.

When creating an Interface object, the token may be passed as an argument. Otherwise, it is assumed to be stored in an environment variable.

Example

An example use of the MOS Python interface:

from mos.interface import Interface

# Interface
interface = Interface()

# Get model by name
model = interface.get_model_with_name('Lasso')

# Set inputs
model.set_interface_object('lambd', 0.1)

assert(model.get_name() == 'Lasso')
assert(model.get_system() == 'cvxpy')
assert(model.get_status() == 'created')

# Run
model.run()

assert(model.get_status() == 'success')
assert(len(model.get_execution_log()) > 0)

# Variable
beta = model.get_variable_state('beta', 'value')
print('coeffficients of beta are: ',beta)

# Function
obj = model.get_function_state('objectivefn', 'value')
assert(isinstance(obj, float))