smif package

smif

Subpackages

• smif.cli package
  • Submodules
  • smif.cli.log module
    • profiling_start()
    • profiling_stop()
    • setup_logging()
    • summary()
• smif.controller package
  • Subpackages
    • smif.controller.job package
      • Submodules
      • smif.controller.job.serial_job_scheduler module
  • 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
  • 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
  • Subpackages
    • smif.data_layer.file package
      • Submodules
      • smif.data_layer.file.file_config_store module
      • smif.data_layer.file.file_data_store module
      • smif.data_layer.file.file_metadata_store module
  • Submodules
  • smif.data_layer.abstract_config_store module
  • smif.data_layer.abstract_data_store module
    • DataStore
      • DataStore.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
    • MetadataStore
      • MetadataStore.delete_dimension()
      • MetadataStore.read_dimension()
      • MetadataStore.read_dimensions()
      • MetadataStore.read_unit_definitions()
      • MetadataStore.update_dimension()
      • MetadataStore.write_dimension()
      • MetadataStore.write_unit_definitions()
  • smif.data_layer.data_array module
    • DataArray
      • DataArray.spec
      • DataArray.data
      • DataArray.as_df()
      • DataArray.as_dict()
      • DataArray.as_ndarray()
      • DataArray.as_xarray()
      • DataArray.coords
      • DataArray.description
      • DataArray.dim_coords()
      • DataArray.dim_elements()
      • DataArray.dim_names()
      • DataArray.dims
      • DataArray.from_df()
      • DataArray.from_xarray()
      • DataArray.name
      • DataArray.shape
      • DataArray.unit
      • DataArray.update()
      • DataArray.validate_as_full()
    • find_duplicate_indices()
    • show_null()
  • smif.data_layer.data_handle module
  • smif.data_layer.memory_interface module
  • smif.data_layer.model_loader module
  • smif.data_layer.results module
  • smif.data_layer.store module
  • smif.data_layer.validate module
• smif.decision package
  • Submodules
  • smif.decision.decision module
• smif.metadata package
  • Coordinates
    • Coordinates.name
    • Coordinates.dim
    • Coordinates.ids
    • Coordinates.elements
    • Coordinates.dim
    • Coordinates.elements
    • Coordinates.ids
    • Coordinates.names
  • RelativeTimestep
    • RelativeTimestep.ALL
    • RelativeTimestep.BASE
    • RelativeTimestep.CURRENT
    • RelativeTimestep.PREVIOUS
    • RelativeTimestep.from_name()
    • RelativeTimestep.resolve_relative_to()
  • Spec
    • Spec.name
    • Spec.description
    • Spec.dtype
    • Spec.abs_range
    • Spec.exp_range
    • Spec.shape
    • Spec.ndim
    • Spec.dims
    • Spec.coords
    • Spec.unit
    • Spec.abs_range
    • Spec.as_dict()
    • Spec.coords
    • Spec.description
    • Spec.dim_coords()
    • Spec.dim_elements()
    • Spec.dim_names()
    • Spec.dims
    • Spec.dtype
    • Spec.exp_range
    • Spec.from_dict()
    • Spec.name
    • Spec.ndim
    • Spec.shape
    • Spec.unit
  • Submodules
  • smif.metadata.coordinates module
    • Coordinates
      • Coordinates.name
      • Coordinates.dim
      • Coordinates.ids
      • Coordinates.elements
      • Coordinates.dim
      • Coordinates.elements
      • Coordinates.ids
      • Coordinates.names
  • smif.metadata.spec module
    • Spec
      • Spec.name
      • Spec.description
      • Spec.dtype
      • Spec.abs_range
      • Spec.exp_range
      • Spec.shape
      • Spec.ndim
      • Spec.dims
      • Spec.coords
      • Spec.unit
      • Spec.abs_range
      • Spec.as_dict()
      • Spec.coords
      • Spec.description
      • Spec.dim_coords()
      • Spec.dim_elements()
      • Spec.dim_names()
      • Spec.dims
      • Spec.dtype
      • Spec.exp_range
      • Spec.from_dict()
      • Spec.name
      • Spec.ndim
      • Spec.shape
      • Spec.unit
  • smif.metadata.timestep module
    • RelativeTimestep
      • RelativeTimestep.ALL
      • RelativeTimestep.BASE
      • RelativeTimestep.CURRENT
      • RelativeTimestep.PREVIOUS
      • RelativeTimestep.from_name()
      • RelativeTimestep.resolve_relative_to()
    • element_before()
• smif.model package
  • Model
    • Model.add_input()
    • Model.add_output()
    • Model.add_parameter()
    • Model.as_dict()
    • Model.from_dict()
    • Model.inputs
    • Model.outputs
    • Model.parameters
    • Model.simulate()
  • ModelOperation
    • ModelOperation.BEFORE_MODEL_RUN
    • ModelOperation.SIMULATE
  • ScenarioModel
    • ScenarioModel.name
    • ScenarioModel.scenario
    • ScenarioModel.as_dict()
    • ScenarioModel.from_dict()
    • ScenarioModel.simulate()
  • SectorModel
    • SectorModel.before_model_run()
    • SectorModel.simulate()
  • SosModel
    • SosModel.add_dependency()
    • SosModel.add_model()
    • SosModel.add_narrative()
    • SosModel.as_dict()
    • SosModel.check_dependencies()
    • SosModel.dependencies
    • SosModel.free_inputs
    • SosModel.from_dict()
    • SosModel.get_model()
    • SosModel.model_dependencies
    • SosModel.models
    • SosModel.outputs
    • SosModel.scenario_dependencies
    • SosModel.scenario_models
    • SosModel.sector_models
  • Submodules
  • smif.model.dependency module
    • Dependency
      • Dependency.as_dict()
  • smif.model.model module
    • Model
      • Model.add_input()
      • Model.add_output()
      • Model.add_parameter()
      • Model.as_dict()
      • Model.from_dict()
      • Model.inputs
      • Model.outputs
      • Model.parameters
      • Model.simulate()
    • ModelOperation
      • ModelOperation.BEFORE_MODEL_RUN
      • ModelOperation.SIMULATE
    • ScenarioModel
      • ScenarioModel.name
      • ScenarioModel.scenario
      • ScenarioModel.as_dict()
      • ScenarioModel.from_dict()
      • ScenarioModel.simulate()
  • smif.model.sector_model module
    • Key Functions
    • SectorModel
      • SectorModel.before_model_run()
      • SectorModel.simulate()
  • smif.model.sos_model module
    • SosModel
      • SosModel.add_dependency()
      • SosModel.add_model()
      • SosModel.add_narrative()
      • SosModel.as_dict()
      • SosModel.check_dependencies()
      • SosModel.dependencies
      • SosModel.free_inputs
      • SosModel.from_dict()
      • SosModel.get_model()
      • SosModel.model_dependencies
      • SosModel.models
      • SosModel.outputs
      • SosModel.scenario_dependencies
      • SosModel.scenario_models
      • SosModel.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

Bases: SmifException

Errors raised by the Store

exception smif.exception.SmifDataExistsError

Bases: SmifDataError

Raise when some data is found unexpectedly

exception smif.exception.SmifDataInputError(component, error, message)

Bases: SmifDataError

Raise 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

Bases: SmifDataError

Raise 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

Bases: SmifDataError

Raise when some data is not found

exception smif.exception.SmifDataReadError

Bases: SmifDataError

Raise when unable to read data

E.g. unable to handle file type

exception smif.exception.SmifException

Bases: Exception

The base class for all errors raised in smif

exception smif.exception.SmifModelRunError

Bases: SmifException

Raise when model run requirements are not satisfied

exception smif.exception.SmifTimestepResolutionError

Bases: SmifException

Raise when timestep cannot be resolved

exception smif.exception.SmifValidationError

Bases: SmifException

Custom exception to use for parsing validation.