smif.data_layer.file.file_config_store module¶
File-backed config store
Reference¶
-
class
smif.data_layer.file.file_config_store.
YamlConfigStore
(base_folder, validation=False)[source]¶ Bases:
smif.data_layer.abstract_config_store.ConfigStore
Config backend saving to YAML configuration files.
Parameters: base_folder (str) – The path to the configuration and data files -
read_project_config
()[source]¶ Read the project configuration
Returns: The project configuration Return type: dict
-
read_model_run
(model_run_name)[source]¶ Read a system-of-system model run
Parameters: model_run_name (str) – Returns: Return type: ModelRun
-
write_model_run
(model_run)[source]¶ Write system-of-system model run
Parameters: model_run (ModelRun) –
-
delete_model_run
(model_run_name)[source]¶ Delete a system-of-system model run
Parameters: model_run_name (str) –
-
read_sos_model
(sos_model_name)[source]¶ Read a specific system-of-system model
Parameters: sos_model_name (str) – Returns: Return type: SosModel
-
delete_sos_model
(sos_model_name)[source]¶ Delete a system-of-system model
Parameters: sos_model_name (str) –
-
read_model
(model_name)[source]¶ Read a model
Parameters: model_name (str) – Returns: Return type: Model
-
update_model
(model_name, model)[source]¶ Update a model
Parameters: - model_name (str) –
- model (Model) –
-
read_scenario
(scenario_name)[source]¶ Read a scenario
Parameters: scenario_name (str) – Returns: Return type: ScenarioModel
-
update_scenario
(scenario_name, scenario)[source]¶ Update scenario
Parameters: - scenario_name (str) –
- scenario (ScenarioModel) –
-
delete_scenario
(scenario_name)[source]¶ Delete scenario from project configuration
Parameters: scenario_name (str) –
-
read_scenario_variants
(scenario_name)[source]¶ Read variants of a given scenario
Parameters: scenario_name (str) – Returns: Return type: list[dict]
-
read_scenario_variant
(scenario_name, variant_name)[source]¶ Read a scenario variant
Parameters: Returns: Return type:
-
write_scenario_variant
(scenario_name, variant)[source]¶ Write scenario to project configuration
Parameters:
-
update_scenario_variant
(scenario_name, variant_name, variant)[source]¶ Update scenario to project configuration
Parameters:
-
delete_scenario_variant
(scenario_name, variant_name)[source]¶ Delete scenario from project configuration
Parameters:
-