smif.convert.unit module¶

Handles conversion between units used in the SosModel

Summary¶

Data:

UnitAdaptor Scalar conversion of units

class smif.convert.unit.UnitAdaptor(name)[source]¶

Scalar conversion of units

simulate(data_handle: smif.data_layer.data_handle.DataHandle)[source]¶: Register unit definitions in registry for model run

convert(data_array, to_spec, coefficients)[source]¶

Convert a dataset between Spec definitions

Parameters:	data (smif.data_layer.data_array.DataArray) – to_spec (smif.metadata.spec.Spec) – coefficients (numpy.ndarray) –
Returns:
Return type:	numpy.ndarray

get_coefficients(data_handle, from_spec, to_spec)[source]¶

Read coefficients, or generate and save if necessary

Parameters:	data_handle (smif.data_layer.data_handle.DataHandle) – from_spec (smif.metadata.spec.Spec) – to_spec (smif.metadata.spec.Spec) –
Returns:
Return type:	numpy.ndarray

generate_coefficients(from_spec, to_spec)[source]¶

Generate coefficients for a pair of Spec definitions

Parameters:	from_spec (smif.metadata.spec.Spec) – to_spec (smif.metadata.spec.Spec) –
Returns:
Return type:	numpy.ndarray

parse_unit(unit_string)[source]¶

Parse a unit string (abbreviation or full) into a Unit object