pastas.check.guess_unit_or_dims#

pastas.check.guess_unit_or_dims(parameter: str, return_dims=True)#

Guess the unit or dimension of a parameter based on its name.

Parameters:
  • parameter (str) – Name of the parameter.

  • return_dims (bool, optional) – if True, return parameter dimensions (default). If False, return specific units where they can be determined from the parameter name

Returns:

unit or dim – Guessed unit or dimensions of the parameter.

Return type:

str