Model

class iesopt.Model(filename: str | Path, **kwargs)

An IESopt model, based on an IESopt.jl core model.

property core

Access the core JuMP model that is used internally.

property data

Access the IESopt data object of the model.

This is deprecated; use model.internal instead (similar to the Julia usage IESopt.internal(model)).

extract_result(component: str, field: str, mode: str = 'value')

Manually extract a specific result from the model.

generate() → None

Generate a IESopt model from the attached top-level YAML config.

get_component(component: str)

Get a core component based on its full name.

get_components(tagged=None)

Get all components of the model, possibly filtered by (a) tag(s).

Parameters:

tagged (str or list of str) – The tag(s) to filter the components by, can be None (default) to get all components.

get_constraint(component: str, constraint: str)

Get a specific constraint from a core component.

get_variable(component: str, variable: str)

Get a specific variable from a core component.

property internal

Access the IESopt data object of the model.

nvar(var: str)

Extract a named variable, from model.

If your variable is called :myvar, and you would access it in Julia using model[:myvar], you can call model.nvar(“myvar”).

property objective_value: float

Get the objective value of the model. Only available if the model was solved beforehand.

optimize() → None

Optimize the model.

property results: Results

Get the results of the model.

property status: ModelStatus

Get the current status of this model. See ModelStatus for possible values.

class iesopt.model.ModelStatus

Status of an iesopt.Model.

EMPTY = 'empty'

FAILED_GENERATE = 'failed_generate'

FAILED_OPTIMIZE = 'failed_optimize'

GENERATED = 'generated'

INFEASIBLE = 'infeasible'

INFEASIBLE_OR_UNBOUNDED = 'infeasible_unbounded'

OPTIMAL = 'optimal'

OPTIMAL_LOCALLY = 'local_optimum'

OTHER = 'other'