brainunit.kelvin2celsius

brainunit.kelvin2celsius(value)

Convert a kelvin Quantity to a Celsius value.

Parameters:

value (Quantity) – The temperature expressed as a Quantity with kelvin units.

Returns:

The temperature in degrees Celsius (unitless scalar or array).

Return type:

Array | ndarray | bool | number | bool | int | float | complex

Raises:

TypeError – If value is not a Quantity with kelvin units.

Examples

>>> import saiunit as u
>>> u.kelvin2celsius(273.15 * u.kelvin)
0.0
>>> u.kelvin2celsius(298.15 * u.kelvin)
25.0
>>> u.kelvin2celsius(373.15 * u.kelvin)
100.0