smif.controller.build module

Summary

Functions:

build_model_run Builds the model run
get_model_run_definition Builds the model run
get_narratives Load the narrative data from the sos model run configuration

Reference

smif.controller.build.get_model_run_definition(directory, modelrun)[source]

Builds the model run

Parameters:
  • directory (str) – Path to the project directory
  • modelrun (str) – Name of the model run to run
Returns:

The complete sos_model_run configuration dictionary with contained ScenarioModel, SosModel and SectorModel objects
Return type:

dict
smif.controller.build.get_narratives(handler, narrative_config)[source]

Load the narrative data from the sos model run configuration

Parameters:
  • handler (smif.data_layer.DataInterface) –
  • narrative_config (dict) – A dict with keys as narrative_set names and values as narrative names
Returns:

A list of smif.parameter.Narrative objects populated with data
Return type:

list
smif.controller.build.build_model_run(model_run_config)[source]

Builds the model run

Parameters:model_run_config (dict) – A valid model run configuration dict with objects
Returns:
Return type:smif.modelrun.ModelRun