smif.data_layer.database_interface module

Database-backed data interface

Summary

Classes:

DatabaseInterface Read and write interface to Database

Reference

class smif.data_layer.database_interface.DatabaseInterface(config_path)[source]

Bases: smif.data_layer.data_interface.DataInterface

Read and write interface to Database

read_sos_model_runs()[source]

Read all system-of-system model runs

Returns:A list of sos_model_run dicts
Return type:list
write_sos_model_run(sos_model_run)[source]

Write system-of-system model run

Parameters:sos_model_run (dict) – A sos_model_run dictionary
read_sos_models()[source]

Read all system-of-system models

Returns:A list of sos_model dicts
Return type:list
write_sos_model(sos_model)[source]

Write system-of-system model

Parameters:sos_model (dict) – A sos_model dictionary
read_sector_models()[source]

Read all sector models

sector_models.yml

Returns:A list of sector_model dicts
Return type:list
read_sector_model(sector_model_name)[source]

Read a sector model

Parameters:sector_model_name (str) – A sector_model name
Returns:sector_model – A sector_model dictionary
Return type:dict
write_sector_model(sector_model)[source]

Write sector model

Parameters:sector_model (dict) – A sector_model dictionary
read_units()[source]
write_unit(unit)[source]
read_regions()[source]
read_region_data(region_name)[source]
write_region(region)[source]
read_intervals()[source]
read_interval_data(interval_name)[source]
write_interval(interval)[source]
read_scenario_sets()[source]

Read scenario sets from project configuration

Returns:A list of scenario set dicts
Return type:list
read_scenario_set(scenario_set_name)[source]

Read a scenario_set

Parameters:scenario_set_name (str) – Name of the scenario_set
Returns:Scenario set definition
Return type:dict
read_scenario_data(scenario_name)[source]

Read scenario data file

Parameters:
  • scenario_name (str) – Name of the scenario
  • facet_name (str) – Name of the scenario facet to read
  • spatial_resolution (str) –
  • temporal_resolution (str) –
  • timestep (int) –
Returns:

data
Return type:

numpy.ndarray

Notes

Called from smif.data_layer.data_handle

write_scenario_set(scenario_set)[source]

Write scenario_set to project configuration

Parameters:scenario_set (dict) – A scenario_set dict
write_scenario(scenario)[source]

Write scenario to project configuration

Parameters:scenario (dict) – A scenario dict
read_narrative_sets()[source]

Read narrative sets from project configuration

Returns:A list of narrative set dicts
Return type:list
read_narrative_set(narrative_set_name)[source]

Read all narratives from a certain narrative_set

Parameters:narrative_set_name (str) – Name of the narrative_set
Returns:A narrative_set dictionary
Return type:list
read_narrative_data(narrative_name)[source]

Read narrative data file

Parameters:narrative_name (str) – Name of the narrative
Returns:A list with dictionaries containing the contents of ‘narrative_name’ data file
Return type:list
write_narrative_set(narrative_set)[source]

Write narrative_set to project configuration

Parameters:narrative_set (dict) – A narrative_set dict
write_narrative(narrative)[source]

Write narrative to project configuration

Parameters:narrative (dict) – A narrative dict