Index

A

add_data() (smif.model.scenario_model.ScenarioModel method) add_dependencies() (smif.model.sos_model.SosModelBuilder method) add_dependency() (smif.model.Model method) add_initial_conditions() (smif.model.sector_model.SectorModelBuilder method) add_input() (smif.model.sector_model.SectorModel method) add_inputs() (smif.model.sector_model.SectorModelBuilder method) add_interventions() (smif.model.sector_model.SectorModelBuilder method) add_metadata() (smif.metadata.MetadataSet method) add_metadata_object() (smif.metadata.MetadataSet method) add_model() (smif.model.sos_model.SosModel method) add_output() (smif.model.scenario_model.ScenarioModel method) (smif.model.sector_model.SectorModel method) add_outputs() (smif.model.sector_model.SectorModelBuilder method) add_parameter() (smif.model.Model method) (smif.parameters.ParameterList method)

add_parameters() (smif.model.sector_model.SectorModelBuilder method) add_parameters_from_list() (smif.parameters.ParameterList method) as_dict() (smif.convert.register.ResolutionSet method) (smif.metadata.Metadata method) (smif.model.scenario_model.ScenarioModel method) (smif.model.sector_model.SectorModel method) (smif.model.sos_model.SosModel method) (smif.modelrun.ModelRun method) (smif.parameters.ParameterList method) (smif.parameters.narrative.Narrative method) Asset (class in smif.intervention) AssetRegister (class in smif.intervention) attribute_index() (smif.intervention.InterventionRegister method) attribute_value_index() (smif.intervention.InterventionRegister method)

B

baseyear (smif.convert.interval.Interval attribute) before_model_run() (smif.model.sector_model.SectorModel method)

build_date (smif.intervention.Asset attribute) build_model_run() (in module smif.cli)

C

check_dependencies() (smif.model.sos_model.SosModel method) CompositeModel (class in smif.model) confirm() (in module smif.cli) construct() (smif.model.scenario_model.ScenarioModelBuilder method) (smif.model.sector_model.SectorModelBuilder method) (smif.model.sos_model.SosModelBuilder method) (smif.modelrun.ModelRunBuilder method)

converged() (smif.model.model_set.ModelSet method) convert() (smif.convert.area.RegionRegister method) (smif.convert.SpaceTimeConvertor method) (smif.convert.interval.TimeIntervalRegister method) (smif.model.dependency.Dependency method) create_initial_system() (smif.model.sector_model.SectorModelBuilder method)

D

data (smif.convert.area.RegionSet attribute) (smif.convert.interval.IntervalSet attribute) (smif.data_layer.sector_model_config.SectorModelReader attribute) (smif.data_layer.sos_model_config.SosModelReader attribute) (smif.parameters.narrative.Narrative attribute) DatabaseInterface (class in smif.data_layer)

DatafileInterface (class in smif.data_layer) DataInterface (class in smif.data_layer) defaults (smif.parameters.ParameterList attribute) Dependency (class in smif.model.dependency) description (smif.modelrun.ModelRun attribute) deterministic_dict_to_str() (smif.intervention.InterventionContainer static method) dump() (in module smif.data_layer.load)

E

element_after() (in module smif.model) element_before() (in module smif.model)

end (smif.convert.interval.Interval attribute) execute_model_run() (in module smif.cli) extract_obj() (smif.model.sector_model.SectorModel method)

F

finish() (smif.model.scenario_model.ScenarioModelBuilder method) (smif.model.sector_model.SectorModelBuilder method) (smif.model.sos_model.SosModelBuilder method) (smif.modelrun.ModelRunBuilder method)

free_inputs (smif.model.CompositeModel attribute) (smif.model.Model attribute)

G

get_attributes() (smif.intervention.Asset method) (smif.intervention.Intervention method) (smif.intervention.InterventionContainer method) get_data() (smif.model.dependency.Dependency method) (smif.model.scenario_model.ScenarioModel method) get_decisions() (smif.model.sos_model.SosModel method) get_entry() (smif.convert.area.RegionRegister method) (smif.convert.interval.TimeIntervalRegister method) (smif.convert.register.Register method) get_entry_names() (smif.convert.area.RegionSet method) (smif.convert.interval.IntervalSet method) (smif.convert.register.ResolutionSet method) get_interval_names() (smif.metadata.Metadata method) (smif.model.sector_model.SectorModel method)

get_intervention() (smif.intervention.InterventionRegister method) get_last_iteration_results() (smif.model.model_set.ModelSet method) get_model_run_definition() (in module smif.cli) get_narratives() (in module smif.cli) get_region_names() (smif.metadata.Metadata method) (smif.model.sector_model.SectorModel method) get_register() (in module smif.convert.area) (in module smif.convert.interval) get_scenario_data() (smif.model.sector_model.SectorModel method) get_spatial_res() (smif.metadata.MetadataSet method) get_state() (smif.model.sos_model.SosModel method) get_temporal_res() (smif.metadata.MetadataSet method) get_units() (smif.metadata.MetadataSet method) guess_results() (smif.model.model_set.ModelSet method)

I

initialise() (smif.model.sector_model.SectorModel method) initialize() (smif.optimisation.OptimizerTemplate method) intersection() (smif.convert.area.RegionSet method) Interval (class in smif.convert.interval) interval (smif.convert.interval.Interval attribute) IntervalSet (class in smif.convert.interval)

Intervention (class in smif.intervention) intervention_names (smif.model.sector_model.SectorModel attribute) (smif.model.sos_model.SosModel attribute) intervention_state_from_data() (smif.model.sector_model.SectorModelBuilder static method) InterventionContainer (class in smif.intervention) InterventionRegister (class in smif.intervention) iterated_results (smif.model.model_set.ModelSet attribute)

L

list_model_runs() (in module smif.cli) load() (in module smif.data_layer.load) (smif.data_layer.sector_model_config.SectorModelReader method) (smif.data_layer.sos_model_config.SosModelReader method) load_convergence_absolute_tolerance() (smif.data_layer.sos_model_config.SosModelReader method) load_convergence_max_iterations() (smif.data_layer.sos_model_config.SosModelReader method) load_convergence_relative_tolerance() (smif.data_layer.sos_model_config.SosModelReader method) load_dependencies() (smif.data_layer.sos_model_config.SosModelReader method) load_initial_conditions() (smif.data_layer.sector_model_config.SectorModelReader method) load_inputs() (smif.data_layer.sector_model_config.SectorModelReader method) load_interval_sets() (in module smif.cli) load_interventions() (smif.data_layer.sector_model_config.SectorModelReader method) load_io_metadata() (smif.data_layer.sector_model_config.SectorModelReader method) load_model() (smif.model.sector_model.SectorModelBuilder method)

load_models() (smif.model.sos_model.SosModelBuilder method) load_outputs() (smif.data_layer.sector_model_config.SectorModelReader method) load_parameters() (smif.data_layer.sector_model_config.SectorModelReader method) load_planning() (smif.data_layer.sos_model_config.SosModelReader method) load_region_sets() (in module smif.cli) load_regions() (smif.data_layer.sos_model_config.SosModelReader method) load_scenario_data() (smif.data_layer.sos_model_config.SosModelReader method) load_scenario_models() (smif.model.sos_model.SosModelBuilder method) load_sector_model_data() (smif.data_layer.sos_model_config.SosModelReader method) load_sos_config() (smif.data_layer.sos_model_config.SosModelReader method) load_time_intervals() (smif.data_layer.sos_model_config.SosModelReader method) load_timesteps() (smif.data_layer.sos_model_config.SosModelReader method) location (smif.intervention.Intervention attribute) logger (smif.modelrun.ModelRun attribute)

M

main() (in module smif.cli) max_iterations (smif.model.model_set.ModelSet attribute) Metadata (class in smif.metadata) metadata (smif.metadata.MetadataSet attribute) MetadataSet (class in smif.metadata) Model (class in smif.model) model_horizon (smif.modelrun.ModelRun attribute)

model_inputs (smif.model.Model attribute) model_outputs (smif.model.Model attribute) ModelRun (class in smif.modelrun) ModelRunBuilder (class in smif.modelrun) ModelRunner (class in smif.modelrun) models (smif.model.model_set.ModelSet attribute) ModelSet (class in smif.model.model_set)

N

name (smif.convert.area.NamedShape attribute) (smif.convert.interval.Interval attribute) (smif.modelrun.ModelRun attribute) NamedShape (class in smif.convert.area) names (smif.convert.area.RegionRegister attribute) (smif.convert.interval.TimeIntervalRegister attribute) (smif.decision.Planning attribute) (smif.metadata.MetadataSet attribute) (smif.parameters.ParameterList attribute)

Narrative (class in smif.parameters.narrative) narratives (smif.modelrun.ModelRun attribute) normalise_unit() (smif.metadata.Metadata method) numeric_to_intervention() (smif.intervention.InterventionRegister method)

O

optimization_function (smif.optimisation.OptimizerTemplate attribute)

OptimizerTemplate (class in smif.optimisation)

P

ParameterList (class in smif.parameters) parameters (smif.model.CompositeModel attribute) (smif.model.Model attribute) (smif.parameters.ParameterList attribute)

parse_arguments() (in module smif.cli) parse_unit() (in module smif.convert.unit) planned_interventions (smif.decision.Planning attribute) Planning (class in smif.decision) proportion_of_a_intersecting_b() (in module smif.convert.area)

R

read_initial_conditions() (smif.data_layer.DatafileInterface method) read_interval_data() (smif.data_layer.DatabaseInterface method) read_interval_definition_data() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) read_interval_definitions() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) read_intervals() (smif.data_layer.DatabaseInterface method) read_interventions() (smif.data_layer.DatafileInterface method) read_narrative_data() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) read_narrative_definition() (smif.data_layer.DatafileInterface method) read_narrative_set() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) read_narrative_sets() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) read_region_data() (smif.data_layer.DatabaseInterface method) read_region_definition_data() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) read_region_definitions() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) read_regions() (smif.data_layer.DatabaseInterface method) read_scenario_data() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) read_scenario_definition() (smif.data_layer.DatafileInterface method) read_scenario_set() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) read_scenario_sets() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method)

read_sector_model() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) read_sector_models() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) read_sos_model() (smif.data_layer.DatafileInterface method) read_sos_model_runs() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) read_sos_models() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) read_units() (smif.data_layer.DatabaseInterface method) RegionRegister (class in smif.convert.area) RegionSet (class in smif.convert.area) Register (class in smif.convert.register) (class in smif.intervention) register() (smif.convert.area.RegionRegister method) (smif.convert.interval.TimeIntervalRegister method) (smif.convert.register.Register method) (smif.intervention.AssetRegister method) (smif.intervention.InterventionRegister method) (smif.intervention.Register method) ResolutionSet (class in smif.convert.register) results (smif.model.sos_model.SosModel attribute) (smif.modelrun.ModelRun attribute) (smif.optimisation.OptimizerTemplate attribute) run() (smif.modelrun.ModelRun method) (smif.optimisation.OptimizerTemplate method)

S

scenario_models (smif.model.sos_model.SosModel attribute) ScenarioModel (class in smif.model.scenario_model) ScenarioModelBuilder (class in smif.model.scenario_model) scenarios (smif.modelrun.ModelRun attribute) sector (smif.intervention.InterventionContainer attribute) sector_models (smif.model.sos_model.SosModel attribute) SectorModel (class in smif.model.sector_model) SectorModelBuilder (class in smif.model.sector_model) SectorModelReader (class in smif.data_layer.sector_model_config) set_convergence_abs_tolerance() (smif.model.sos_model.SosModelBuilder method) set_convergence_rel_tolerance() (smif.model.sos_model.SosModelBuilder method) set_data() (smif.model.sos_model.SosModel method) set_max_iterations() (smif.model.sos_model.SosModelBuilder method) set_state() (smif.model.sos_model.SosModel method) setup_configuration() (in module smif.cli) setup_project_folder() (in module smif.cli) sha1sum() (smif.intervention.InterventionContainer method) shape (smif.convert.area.NamedShape attribute) simulate() (smif.model.Model method) (smif.model.model_set.ModelSet method) (smif.model.scenario_model.ScenarioModel method) (smif.model.sector_model.SectorModel method) (smif.model.sos_model.SosModel method) smif (module) smif.cli (module) smif.convert (module) smif.convert.area (module) smif.convert.interval (module) smif.convert.register (module)

smif.convert.unit (module) smif.data_layer (module) smif.data_layer.load (module) smif.data_layer.sector_model_config (module) smif.data_layer.sos_model_config (module) smif.data_layer.validate (module) smif.decision (module) smif.intervention (module) smif.metadata (module) smif.model (module) smif.model.dependency (module) smif.model.model_set (module) smif.model.scenario_model (module) smif.model.sector_model (module) smif.model.sos_model (module) smif.modelrun (module) smif.optimisation (module) smif.parameters (module) smif.parameters.narrative (module) solve_model() (smif.modelrun.ModelRunner method) sos_model (smif.modelrun.ModelRun attribute) SosModel (class in smif.model.sos_model) SosModelBuilder (class in smif.model.sos_model) SosModelReader (class in smif.data_layer.sos_model_config) SpaceTimeConvertor (class in smif.convert) spatial_resolutions (smif.metadata.MetadataSet attribute) start (smif.convert.interval.Interval attribute) StateData (class in smif) status (smif.modelrun.ModelRun attribute) strategies (smif.modelrun.ModelRun attribute)

T

temporal_resolutions (smif.metadata.MetadataSet attribute) TimeIntervalRegister (class in smif.convert.interval) timeperiods (smif.decision.Planning attribute) timestamp (smif.modelrun.ModelRun attribute) timestep (smif.model.model_set.ModelSet attribute)

timestep_after() (smif.model.sos_model.SosModel method) timestep_before() (smif.model.sos_model.SosModel method) timesteps (smif.model.scenario_model.ScenarioModel attribute) to_hourly_array() (smif.convert.interval.Interval method) to_hours() (smif.convert.interval.Interval method)

U

units (smif.metadata.MetadataSet attribute) update_interval_definition() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) update_narrative() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) update_narrative_set() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) update_region_definition() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) update_scenario() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method)

update_scenario_set() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) update_sector_model() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) update_sos_model() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) update_sos_model_run() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) user_data (smif.model.sector_model.SectorModel attribute)

V

validate() (smif.model.sector_model.SectorModel method) (smif.model.sector_model.SectorModelBuilder method) validate_dependency() (in module smif.data_layer.validate) validate_dependency_spec() (in module smif.data_layer.validate) validate_initial_condition() (in module smif.data_layer.validate) validate_initial_conditions() (in module smif.data_layer.validate) validate_interval_sets_config() (in module smif.data_layer.validate) validate_interventions() (in module smif.data_layer.validate) validate_path_to_timesteps() (in module smif.data_layer.validate) validate_planning_config() (in module smif.data_layer.validate) validate_region_sets_config() (in module smif.data_layer.validate)

validate_scenario() (in module smif.data_layer.validate) validate_scenario_data() (in module smif.data_layer.validate) validate_scenario_data_config() (in module smif.data_layer.validate) validate_scenario_datum() (in module smif.data_layer.validate) validate_sector_model_initial_config() (in module smif.data_layer.validate) validate_sector_models_initial_config() (in module smif.data_layer.validate) validate_sos_model_config() (in module smif.data_layer.validate) validate_time_interval() (in module smif.data_layer.validate) validate_time_intervals() (in module smif.data_layer.validate) validate_timesteps() (in module smif.data_layer.validate) ValidationError

W

write_interval() (smif.data_layer.DatabaseInterface method) write_interval_definition() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) write_narrative() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) write_narrative_set() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) write_region() (smif.data_layer.DatabaseInterface method) write_region_definition() (smif.data_layer.DatafileInterface method) (smif.data_layer.DataInterface method) write_scenario() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method)

write_scenario_set() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) write_sector_model() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) write_sos_model() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) write_sos_model_run() (smif.data_layer.DatabaseInterface method) (smif.data_layer.DataInterface method) (smif.data_layer.DatafileInterface method) write_unit() (smif.data_layer.DatabaseInterface method)