BioSimSpace.Types.Temperature

class BioSimSpace.Types.Temperature(*args)

A temperature type.

__init__(*args)

Constructor.

*args can be a magnitude and unit, or a string representation of the temperature, e.g. “298 K”.

Parameters:
  • magnitude (float) – The magnitude.
  • unit (str) – The unit.
  • string (str) – A string representation of the temperature.

Examples

Create an object representing a temperature of 298 Kelvin then print the temperature in Celsius.

>>> import BioSimSpace as BSS
>>> temperature = BSS.Types.Temperature(298, "K")
>>> print(temperature.celsius())

The same as above, except passing a string representation of the temperature to the constructor.

>>> import BioSimSpace as BSS
>>> time = BSS.Types.Temperature("298 K")
>>> print(temperature.celsius())

The string matching is extremeley flexible, so all of the following would be valid arguments: “298 K”, “298 kelvin”, “2.98e2 k”.

Methods

__init__(*args) Constructor.
celsius() Return the temperature in Celsius.
fahrenheit() Return the temperature in Fahrenheit.
kelvin() Return the temperature in Kelvin.
magnitude() Return the magnitude.
unit() Return the unit.
celsius()

Return the temperature in Celsius.

Returns:temperature – The temperature in Celsius.
Return type:Temperature
fahrenheit()

Return the temperature in Fahrenheit.

Returns:temperature – The temperature in Fahrenheit.
Return type:Temperature
kelvin()

Return the temperature in Kelvin.

Returns:temperature – The temperature in Kelvin.
Return type:Temperature
magnitude()

Return the magnitude.

Returns:magnitude – The magnitude of the type.
Return type:float
unit()

Return the unit.

Returns:unit – The unit of the type.
Return type:str