smif.model.scenario_model module

Scenario models represent scenario data sources within a system-of-systems model.

Summary

Classes:

ScenarioModel	Represents exogenous scenario data
ScenarioModelBuilder

Reference

class smif.model.scenario_model.ScenarioModel(name)

Bases: smif.model.Model

Represents exogenous scenario data

Parameters:name (str) – The unique name of this scenario

name

str – Name of this scenario

timesteps

list – List of timesteps for which the scenario holds data

scenario_set

str – Scenario set to which this scenario belongs

as_dict()

add_output(name, spatial_resolution, temporal_resolution, units)

Add an output to the scenario model

Parameters:

• name (str) –
• spatial_resolution (smif.convert.area.RegionRegister) –
• temporal_resolution (smif.convert.interval.TimeIntervalRegister) –
• units (str) –

simulate(data)

No-op, as the data is assumed already available in the store

class smif.model.scenario_model.ScenarioModelBuilder(name)

Bases: object

construct(scenario_config)

Build a ScenarioModel

Parameters:scenario_config (dict) –

finish()

Return the built ScenarioModel