model

This module defines the PREP-SHOT model. The model is created using the pyoptinterface library.

prepshot.model.create_model(params)[source]

Create the PREP-SHOT model.

Parameters

params (dict) -- Dictionary of parameters for the model.

Returns

Model object.

Return type

object

prepshot.model.define_basic_sets(model)[source]

Define sets for the model.

Parameters

model (object) -- Model object to be solved.

Return type

None

prepshot.model.define_complex_sets(model)[source]

Create complex sets based on simple sets and some conditations. The existing capacity between two zones is set to empty (i.e., No value is filled in the Excel cell), which means that these two zones cannot have newly built transmission lines. If you want to enable two zones which do not have any existing transmission lines, to build new transmission lines in the planning horizon, you need to set their capacity as zero explicitly.

Parameters

model (object) -- Model to be solved.

Return type

None

prepshot.model.define_constraints(model)[source]

Define constraints for the model.

Parameters

model (object) -- Model to be solved.

Return type

None

prepshot.model.define_model(params)[source]

This function creates the model class depending on predefined solver.

Parameters

params (dict) -- parameters for the model

Returns

A pyoptinterface Model object depending on the solver

Return type

object

Raises

ValueError -- Unsupported or undefined solver

prepshot.model.define_variables(model)[source]

Define variables for the model.

Parameters

model (object) -- Model to be solved.

Return type

None