smif.model.model module¶
Model abstract class
Summary¶
Data:
Model |
Abstract class represents the interface used to implement the model classes SectorModel and ScenarioModel. |
ModelOperation |
Enumerate that describes the possible operations on Models |
ScenarioModel |
Represents exogenous scenario data |
Reference¶
-
class
smif.model.model.
ModelOperation
[source]¶ Bases:
enum.Enum
Enumerate that describes the possible operations on Models
-
BEFORE_MODEL_RUN
= 'before_model_run'¶
-
SIMULATE
= 'simulate'¶
-
-
class
smif.model.model.
Model
(name)[source]¶ Bases:
object
Abstract class represents the interface used to implement the model classes SectorModel and ScenarioModel.
Parameters: name (str) – -
inputs
¶ All model inputs defined at this layer
Returns: dict of {input_name Return type: smif.metadata.Spec}
-
parameters
¶ Model parameters
Returns: dict of {parameter_name Return type: smif.data_layer.data_array.DataArray}
-
outputs
¶ All model outputs defined at this layer
Returns: dict of {output_name Return type: smif.metadata.Spec}
-
-
class
smif.model.model.
ScenarioModel
(name)[source]¶ Bases:
smif.model.model.Model
Represents exogenous scenario data
Parameters: name (str) – The name of this scenario (scenario set/abstract scenario/scenario group) - like sector model name