smif.controller.build module

Summary

Data:

build_model_run Builds the model run
get_model_run_definition Builds the model run
get_scenario_models Read in ScenarioModels
get_sector_models Read and build SectorModels

Reference

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

Builds the model run

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

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

dict
smif.controller.build.get_scenario_models(scenarios, handler)[source]

Read in ScenarioModels

Parameters:
  • scenarios (dict) –
  • handler (smif.data_layer.Store) –
Returns:
Return type:

list of ScenarioModel
smif.controller.build.get_sector_models(sector_model_names, handler)[source]

Read and build SectorModels

Parameters:
  • sector_model_names (list of str) –
  • handler (smif.data_layer.Store) –
Returns:
Return type:

list of SectorModel implementations
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.controller.modelrun.ModelRun