smif package¶
smif
Subpackages¶
- smif.cli package
- smif.controller package
ModelRunnercopy_project_folder()execute_decision_step()execute_model_before_step()execute_model_run()execute_model_step()- Subpackages
- Submodules
- smif.controller.build module
- smif.controller.execute_run module
- smif.controller.execute_step module
- smif.controller.modelrun module
- smif.controller.setup module
- smif.convert package
AdaptorIntervalAdaptorRegionAdaptorUnitAdaptor- Submodules
- smif.convert.adaptor module
- smif.convert.interval module
- smif.convert.region module
- smif.convert.register module
- smif.convert.unit module
- smif.data_layer package
DataArrayDataArray.specDataArray.dataDataArray.as_df()DataArray.as_dict()DataArray.as_ndarray()DataArray.as_xarray()DataArray.coordsDataArray.descriptionDataArray.dim_coords()DataArray.dim_elements()DataArray.dim_names()DataArray.dimsDataArray.from_df()DataArray.from_xarray()DataArray.nameDataArray.shapeDataArray.unitDataArray.update()DataArray.validate_as_full()
DataHandleDataHandle.base_timestepDataHandle.current_timestepDataHandle.decision_iterationDataHandle.derive_for()DataHandle.get_base_timestep_data()DataHandle.get_current_interventions()DataHandle.get_data()DataHandle.get_parameter()DataHandle.get_parameters()DataHandle.get_previous_timestep_data()DataHandle.get_results()DataHandle.get_state()DataHandle.previous_timestepDataHandle.read_coefficients()DataHandle.read_unit_definitions()DataHandle.set_results()DataHandle.timestepsDataHandle.write_coefficients()
ResultsStoreStore.available_results()Store.canonical_available_results()Store.canonical_expected_results()Store.canonical_missing_results()Store.clear_results()Store.completed_jobs()Store.convert_initial_conditions_data()Store.convert_interventions_data()Store.convert_model_parameter_default_data()Store.convert_narrative_data()Store.convert_scenario_data()Store.convert_strategies_data()Store.delete_dimension()Store.delete_model()Store.delete_model_run()Store.delete_results()Store.delete_scenario()Store.delete_scenario_variant()Store.delete_sos_model()Store.expected_model_outputs()Store.filter_complete_available_results()Store.from_dict()Store.get_result_darray()Store.get_results()Store.prepare_model_runs()Store.prepare_scenario()Store.prepare_warm_start()Store.read_all_initial_conditions()Store.read_coefficients()Store.read_dimension()Store.read_dimensions()Store.read_initial_conditions()Store.read_initial_conditions_file()Store.read_interventions()Store.read_interventions_file()Store.read_model()Store.read_model_parameter_default()Store.read_model_run()Store.read_model_runs()Store.read_models()Store.read_narrative()Store.read_narrative_variant_data()Store.read_results()Store.read_scenario()Store.read_scenario_variant()Store.read_scenario_variant_data()Store.read_scenario_variants()Store.read_scenarios()Store.read_sos_model()Store.read_sos_models()Store.read_state()Store.read_strategies()Store.read_strategy_interventions()Store.read_unit_definitions()Store.update_dimension()Store.update_model()Store.update_model_run()Store.update_scenario()Store.update_scenario_variant()Store.update_sos_model()Store.write_coefficients()Store.write_dimension()Store.write_initial_conditions()Store.write_initial_conditions_file()Store.write_interventions()Store.write_interventions_file()Store.write_model()Store.write_model_parameter_default()Store.write_model_run()Store.write_narrative_variant_data()Store.write_results()Store.write_scenario()Store.write_scenario_variant()Store.write_scenario_variant_data()Store.write_sos_model()Store.write_state()Store.write_strategies()Store.write_strategy_interventions()Store.write_unit_definitions()
- Subpackages
- Submodules
- smif.data_layer.abstract_config_store module
ConfigStoreConfigStore.delete_model()ConfigStore.delete_model_run()ConfigStore.delete_scenario()ConfigStore.delete_scenario_variant()ConfigStore.delete_sos_model()ConfigStore.read_model()ConfigStore.read_model_run()ConfigStore.read_model_runs()ConfigStore.read_models()ConfigStore.read_narrative()ConfigStore.read_scenario()ConfigStore.read_scenario_variant()ConfigStore.read_scenario_variants()ConfigStore.read_scenarios()ConfigStore.read_sos_model()ConfigStore.read_sos_models()ConfigStore.read_strategies()ConfigStore.update_model()ConfigStore.update_model_run()ConfigStore.update_scenario()ConfigStore.update_scenario_variant()ConfigStore.update_sos_model()ConfigStore.write_model()ConfigStore.write_model_run()ConfigStore.write_scenario()ConfigStore.write_scenario_variant()ConfigStore.write_sos_model()ConfigStore.write_strategies()
- smif.data_layer.abstract_data_store module
DataStoreDataStore.available_results()DataStore.dataframe_to_data_array()DataStore.delete_results()DataStore.filter_on_timesteps()DataStore.read_coefficients()DataStore.read_initial_conditions()DataStore.read_interventions()DataStore.read_model_parameter_default()DataStore.read_narrative_variant_data()DataStore.read_results()DataStore.read_scenario_variant_data()DataStore.read_state()DataStore.scenario_variant_data_exists()DataStore.write_coefficients()DataStore.write_initial_conditions()DataStore.write_interventions()DataStore.write_model_parameter_default()DataStore.write_narrative_variant_data()DataStore.write_results()DataStore.write_scenario_variant_data()DataStore.write_state()
- smif.data_layer.abstract_metadata_store module
- smif.data_layer.data_array module
DataArrayDataArray.specDataArray.dataDataArray.as_df()DataArray.as_dict()DataArray.as_ndarray()DataArray.as_xarray()DataArray.coordsDataArray.descriptionDataArray.dim_coords()DataArray.dim_elements()DataArray.dim_names()DataArray.dimsDataArray.from_df()DataArray.from_xarray()DataArray.nameDataArray.shapeDataArray.unitDataArray.update()DataArray.validate_as_full()
find_duplicate_indices()show_null()
- smif.data_layer.data_handle module
DataHandleDataHandle.base_timestepDataHandle.current_timestepDataHandle.decision_iterationDataHandle.derive_for()DataHandle.get_base_timestep_data()DataHandle.get_current_interventions()DataHandle.get_data()DataHandle.get_parameter()DataHandle.get_parameters()DataHandle.get_previous_timestep_data()DataHandle.get_results()DataHandle.get_state()DataHandle.previous_timestepDataHandle.read_coefficients()DataHandle.read_unit_definitions()DataHandle.set_results()DataHandle.timestepsDataHandle.write_coefficients()
ResultsHandle
- smif.data_layer.database_interface module
- smif.data_layer.memory_interface module
MemoryConfigStoreMemoryConfigStore.delete_model()MemoryConfigStore.delete_model_run()MemoryConfigStore.delete_scenario()MemoryConfigStore.delete_scenario_variant()MemoryConfigStore.delete_sos_model()MemoryConfigStore.read_interventions_index()MemoryConfigStore.read_model()MemoryConfigStore.read_model_run()MemoryConfigStore.read_model_runs()MemoryConfigStore.read_models()MemoryConfigStore.read_narrative()MemoryConfigStore.read_scenario()MemoryConfigStore.read_scenario_variant()MemoryConfigStore.read_scenario_variants()MemoryConfigStore.read_scenarios()MemoryConfigStore.read_sos_model()MemoryConfigStore.read_sos_models()MemoryConfigStore.read_strategies()MemoryConfigStore.update_interventions_index()MemoryConfigStore.update_model()MemoryConfigStore.update_model_run()MemoryConfigStore.update_scenario()MemoryConfigStore.update_scenario_variant()MemoryConfigStore.update_sos_model()MemoryConfigStore.write_model()MemoryConfigStore.write_model_run()MemoryConfigStore.write_scenario()MemoryConfigStore.write_scenario_variant()MemoryConfigStore.write_sos_model()MemoryConfigStore.write_strategies()
MemoryDataStoreMemoryDataStore.available_results()MemoryDataStore.delete_results()MemoryDataStore.initial_conditions_data_exists()MemoryDataStore.interventions_data_exists()MemoryDataStore.model_parameter_default_data_exists()MemoryDataStore.narrative_variant_data_exists()MemoryDataStore.read_coefficients()MemoryDataStore.read_initial_conditions()MemoryDataStore.read_interventions()MemoryDataStore.read_model_parameter_default()MemoryDataStore.read_narrative_variant_data()MemoryDataStore.read_results()MemoryDataStore.read_scenario_variant_data()MemoryDataStore.read_state()MemoryDataStore.read_strategy_interventions()MemoryDataStore.scenario_variant_data_exists()MemoryDataStore.strategy_data_exists()MemoryDataStore.write_coefficients()MemoryDataStore.write_initial_conditions()MemoryDataStore.write_interventions()MemoryDataStore.write_model_parameter_default()MemoryDataStore.write_narrative_variant_data()MemoryDataStore.write_results()MemoryDataStore.write_scenario_variant_data()MemoryDataStore.write_state()MemoryDataStore.write_strategy_interventions()
MemoryMetadataStore
- smif.data_layer.model_loader module
- smif.data_layer.results module
- smif.data_layer.store module
StoreStore.available_results()Store.canonical_available_results()Store.canonical_expected_results()Store.canonical_missing_results()Store.clear_results()Store.completed_jobs()Store.convert_initial_conditions_data()Store.convert_interventions_data()Store.convert_model_parameter_default_data()Store.convert_narrative_data()Store.convert_scenario_data()Store.convert_strategies_data()Store.delete_dimension()Store.delete_model()Store.delete_model_run()Store.delete_results()Store.delete_scenario()Store.delete_scenario_variant()Store.delete_sos_model()Store.expected_model_outputs()Store.filter_complete_available_results()Store.from_dict()Store.get_result_darray()Store.get_results()Store.prepare_model_runs()Store.prepare_scenario()Store.prepare_warm_start()Store.read_all_initial_conditions()Store.read_coefficients()Store.read_dimension()Store.read_dimensions()Store.read_initial_conditions()Store.read_initial_conditions_file()Store.read_interventions()Store.read_interventions_file()Store.read_model()Store.read_model_parameter_default()Store.read_model_run()Store.read_model_runs()Store.read_models()Store.read_narrative()Store.read_narrative_variant_data()Store.read_results()Store.read_scenario()Store.read_scenario_variant()Store.read_scenario_variant_data()Store.read_scenario_variants()Store.read_scenarios()Store.read_sos_model()Store.read_sos_models()Store.read_state()Store.read_strategies()Store.read_strategy_interventions()Store.read_unit_definitions()Store.update_dimension()Store.update_model()Store.update_model_run()Store.update_scenario()Store.update_scenario_variant()Store.update_sos_model()Store.write_coefficients()Store.write_dimension()Store.write_initial_conditions()Store.write_initial_conditions_file()Store.write_interventions()Store.write_interventions_file()Store.write_model()Store.write_model_parameter_default()Store.write_model_run()Store.write_narrative_variant_data()Store.write_results()Store.write_scenario()Store.write_scenario_variant()Store.write_scenario_variant_data()Store.write_sos_model()Store.write_state()Store.write_strategies()Store.write_strategy_interventions()Store.write_unit_definitions()
- smif.data_layer.validate module
validate_dependency()validate_dependency_spec()validate_initial_condition()validate_initial_conditions()validate_interval_sets_config()validate_interventions()validate_path_to_timesteps()validate_planning_config()validate_region_sets_config()validate_scenario()validate_scenario_data()validate_scenario_data_config()validate_scenario_datum()validate_sector_model_initial_config()validate_sector_models_initial_config()validate_sos_model_config()validate_sos_model_format()validate_time_interval()validate_time_intervals()validate_timesteps()
- smif.decision package
- smif.http_api package
- smif.metadata package
CoordinatesRelativeTimestepSpecSpec.nameSpec.descriptionSpec.dtypeSpec.abs_rangeSpec.exp_rangeSpec.shapeSpec.ndimSpec.dimsSpec.coordsSpec.unitSpec.abs_rangeSpec.as_dict()Spec.coordsSpec.descriptionSpec.dim_coords()Spec.dim_elements()Spec.dim_names()Spec.dimsSpec.dtypeSpec.exp_rangeSpec.from_dict()Spec.nameSpec.ndimSpec.shapeSpec.unit
- Submodules
- smif.metadata.coordinates module
- smif.metadata.spec module
SpecSpec.nameSpec.descriptionSpec.dtypeSpec.abs_rangeSpec.exp_rangeSpec.shapeSpec.ndimSpec.dimsSpec.coordsSpec.unitSpec.abs_rangeSpec.as_dict()Spec.coordsSpec.descriptionSpec.dim_coords()Spec.dim_elements()Spec.dim_names()Spec.dimsSpec.dtypeSpec.exp_rangeSpec.from_dict()Spec.nameSpec.ndimSpec.shapeSpec.unit
- smif.metadata.timestep module
- smif.model package
ModelModelOperationScenarioModelSectorModelSosModelSosModel.add_dependency()SosModel.add_model()SosModel.add_narrative()SosModel.as_dict()SosModel.check_dependencies()SosModel.dependenciesSosModel.free_inputsSosModel.from_dict()SosModel.get_model()SosModel.model_dependenciesSosModel.modelsSosModel.outputsSosModel.scenario_dependenciesSosModel.scenario_modelsSosModel.sector_models
- Submodules
- smif.model.dependency module
- smif.model.model module
- smif.model.sector_model module
- smif.model.sos_model module
SosModelSosModel.add_dependency()SosModel.add_model()SosModel.add_narrative()SosModel.as_dict()SosModel.check_dependencies()SosModel.dependenciesSosModel.free_inputsSosModel.from_dict()SosModel.get_model()SosModel.model_dependenciesSosModel.modelsSosModel.outputsSosModel.scenario_dependenciesSosModel.scenario_modelsSosModel.sector_models
Submodules¶
smif.exception module¶
Holds custom smif exception hierarchy
- Exception
- +– SmifException
- +– SmifDataError
+– SmifDataNotFoundError +– SmifDataExistsError +– SmifDataMismatchError +– SmifDataReadError +– SmifDataInputError
+– SmifModelRunError +– SmifValidationError
- exception smif.exception.SmifDataError[source]¶
Bases:
SmifExceptionErrors raised by the Store
- exception smif.exception.SmifDataExistsError[source]¶
Bases:
SmifDataErrorRaise when some data is found unexpectedly
- exception smif.exception.SmifDataInputError(component, error, message)[source]¶
Bases:
SmifDataErrorRaise when unable to write data because it does not meet specification and can be addressed to a specific (user-interface) input field
E.g. - component: description - unable to write a description shorter than 5 characters - We require a description so you can identify your system-of-systems
configuration throughout your project.
- exception smif.exception.SmifDataMismatchError[source]¶
Bases:
SmifDataErrorRaise when some data doesn’t match the context
E.g. when updating an object by id, the updated object’s id must match the id provided separately.
- exception smif.exception.SmifDataNotFoundError[source]¶
Bases:
SmifDataErrorRaise when some data is not found
- exception smif.exception.SmifDataReadError[source]¶
Bases:
SmifDataErrorRaise when unable to read data
E.g. unable to handle file type or connect to database
- exception smif.exception.SmifException[source]¶
Bases:
ExceptionThe base class for all errors raised in smif
- exception smif.exception.SmifModelRunError[source]¶
Bases:
SmifExceptionRaise when model run requirements are not satisfied
- exception smif.exception.SmifTimestepResolutionError[source]¶
Bases:
SmifExceptionRaise when timestep cannot be resolved
- exception smif.exception.SmifValidationError[source]¶
Bases:
SmifExceptionCustom exception to use for parsing validation.