smif.data_layer.abstract_metadata_store module¶
A metadata store holds shared metadata for smif model scenarios, inputs, parameters and outputs: - units - dimension definitions
Summary¶
Data:
MetadataStore |
A MetaDataStore must implement each of the abstract methods defined in this interface |
Reference¶
-
class
smif.data_layer.abstract_metadata_store.
MetadataStore
[source]¶ Bases:
object
A MetaDataStore must implement each of the abstract methods defined in this interface
-
read_unit_definitions
() → List[str][source]¶ Reads custom unit definitions
Returns: Pint-compatible unit definitions Return type: list[str]
-
write_unit_definitions
(definitions: List[str])[source]¶ Reads custom unit definitions
Parameters: list[str] – Pint-compatible unit definitions
-
read_dimensions
(skip_coords=False)[source]¶ Read dimensions
Parameters: skip_coords (bool, default False) – If True, skip reading dimension elements (names and metadata) Returns: Return type: list[Coords]
-
read_dimension
(dimension_name, skip_coords=False)[source]¶ Return dimension
Parameters: Returns: A dimension definition (including elements)
Return type: Coords
-
write_dimension
(dimension)[source]¶ Write dimension to project configuration
Parameters: dimension (Coords) –
-