smif.data_layer.datafile_interface module¶
File-backed data interface
Reference¶
-
class
smif.data_layer.datafile_interface.
DatafileInterface
(base_folder)[source]¶ Bases:
smif.data_layer.data_interface.DataInterface
Read and write interface to YAML / CSV configuration files
Project.yml
Parameters: base_folder (str) – The path to the configuration and data files -
read_sos_model_runs
()[source]¶ Read all system-of-system model runs from Yaml files
sos_model_runs.yml
Returns: A list of sos_model_run dicts Return type: list
-
read_sos_model_run
(sos_model_run_name)[source]¶ Read a system-of-system model run
Parameters: sos_model_run_name (str) – A sos_model_run name Returns: sos_model_run – A sos_model_run dictionary Return type: dict
-
write_sos_model_run
(sos_model_run)[source]¶ Write system-of-system model run to Yaml file
Parameters: sos_model_run (dict) – A sos_model_run dictionary
-
update_sos_model_run
(sos_model_run_name, sos_model_run)[source]¶ Update system-of-system model run in Yaml file
Parameters:
-
delete_sos_model_run
(sos_model_run_name)[source]¶ Delete a system-of-system model run
Parameters: sos_model_run_name (str) – A sos_model_run name
-
read_sos_models
()[source]¶ Read all system-of-system models from Yaml files
Returns: A list of sos_models dicts Return type: list
-
read_sos_model
(sos_model_name)[source]¶ Read a specific system-of-system model
Parameters: sos_model_name (str) – A sos_model name Returns: sos_model – A sos_model dictionary Return type: dict
-
write_sos_model
(sos_model)[source]¶ Write system-of-system model to Yaml file
Parameters: sos_model (dict) – A sos_model dictionary
-
update_sos_model
(sos_model_name, sos_model)[source]¶ Update system-of-system model in Yaml file
Parameters:
-
delete_sos_model
(sos_model_name)[source]¶ Delete a system-of-system model run
Parameters: sos_model_name (str) – A sos_model name
-
read_sector_models
()[source]¶ Read all sector models from Yaml files
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 to Yaml file
Parameters: sector_model (dict) – A sector_model dictionary
-
update_sector_model
(sector_model_name, sector_model)[source]¶ Update sector model in Yaml file
Parameters:
-
delete_sector_model
(sector_model_name)[source]¶ Delete a sector model
Parameters: sector_model_name (str) – A sector_model name
-
read_interventions
(filename)[source]¶ Read the interventions from filename
Parameters: filename (str) – The name of the intervention yml file to read in
-
read_initial_conditions
(filename)[source]¶ Read the initial conditions from filename
Parameters: filename (str) – The name of the initial conditions yml file to read in
-
read_region_definitions
()[source]¶ Read region_definitions from project configuration
Returns: A list of region_definition dicts Return type: list
-
read_region_definition_data
(region_definition_name)[source]¶ Read region_definition data file into a Fiona feature collection
The file format must be possible to parse with GDAL, and must contain an attribute “name” to use as an identifier for the region_definition.
Parameters: region_definition_name (str) – Name of the region_definition Returns: A list of data from the specified file in a fiona formatted dict Return type: list
-
write_region_definition
(region_definition)[source]¶ Write region_definition to project configuration
Parameters: region_definition (dict) – A region_definition dict
-
update_region_definition
(region_definition_name, region_definition)[source]¶ Update region_definition to project configuration
Parameters:
-
read_interval_definitions
()[source]¶ Read interval_definition sets from project configuration
Returns: A list of interval_definition set dicts Return type: list
-
read_interval_definition_data
(interval_definition_name)[source]¶ Parameters: interval_definition_name (str) – Returns: Interval definition data Return type: dict Notes
Expects csv file to contain headings of id, start, end
-
write_interval_definition
(interval_definition)[source]¶ Write interval_definition to project configuration
Parameters: interval_definition (dict) – A interval_definition dict
-
update_interval_definition
(interval_definition_name, interval_definition)[source]¶ Update interval_definition to project configuration
Parameters:
-
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_set_scenario_definitions
(scenario_set_name)[source]¶ Read all scenarios from a certain scenario_set
Parameters: scenario_set_name (str) – Name of the scenario_set Returns: A list of scenarios within the specified ‘scenario_set_name’ Return type: list
-
read_scenario_definition
(scenario_name)[source]¶ Read scenario definition data
Parameters: scenario_name (str) – Name of the scenario Returns: The scenario definition Return type: dict
-
write_scenario_set
(scenario_set)[source]¶ Write scenario_set to project configuration
Parameters: scenario_set (dict) – A scenario_set dict
-
update_scenario_set
(scenario_set_name, scenario_set)[source]¶ Update scenario_set to project configuration
Parameters:
-
delete_scenario_set
(scenario_set_name)[source]¶ Delete scenario_set from project configuration
Parameters: scenario_set_name (str) – A scenario_set name
-
read_scenarios
()[source]¶ Read scenarios from project configuration
Returns: A list of scenario dicts Return type: list
-
read_scenario
(scenario_name)[source]¶ Read a scenario
Parameters: scenario_name (str) – Name of the scenario Returns: A scenario dictionary Return type: dict
-
write_scenario
(scenario)[source]¶ Write scenario to project configuration
Parameters: scenario (dict) – A scenario dict
-
update_scenario
(scenario_name, scenario)[source]¶ Update scenario to project configuration
Parameters:
-
delete_scenario
(scenario_name)[source]¶ Delete scenario from project configuration
Parameters: scenario_name (str) – A scenario name
-
read_scenario_data
(scenario_name, parameter_name, spatial_resolution, temporal_resolution, timestep)[source]¶ Read scenario data file
Parameters: Returns: data
Return type:
-
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
-
write_narrative_set
(narrative_set)[source]¶ Write narrative_set to project configuration
Parameters: narrative_set (dict) – A narrative_set dict
-
update_narrative_set
(narrative_set_name, narrative_set)[source]¶ Update narrative_set to project configuration
Parameters:
-
delete_narrative_set
(narrative_set_name)[source]¶ Delete narrative_set from project configuration
Parameters: narrative_set_name (str) – A narrative_set name
-
read_narratives
()[source]¶ Read narrative sets from project configuration
Returns: A list of narrative set dicts Return type: list
-
read_narrative
(narrative_name)[source]¶ Read all narratives from a certain narrative
Parameters: narrative_name (str) – Name of the narrative Returns: A narrative dictionary Return type: list
-
write_narrative
(narrative)[source]¶ Write narrative to project configuration
Parameters: narrative (dict) – A narrative dict
-
update_narrative
(narrative_name, narrative)[source]¶ Update narrative to project configuration
Parameters:
-
delete_narrative
(narrative_name)[source]¶ Delete narrative from project configuration
Parameters: narrative_name (str) – A narrative name
-
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
-
read_narrative_definition
(narrative_name)[source]¶ Read the narrative definition
Parameters: narrative_name (str) – Name of the narrative Returns: Return type: dict
-
read_results
(modelrun_id, model_name, output_name, spatial_resolution, temporal_resolution, timestep=None, modelset_iteration=None, decision_iteration=None)[source]¶ Return path to text file for a given output
Parameters: Returns: data
Return type:
-