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

__add__(other)	Addition operator.
__delattr__	Implement delattr(self, name).
__dir__	Default dir() implementation.
__eq__(other)	Equals to operator.
__format__	Default object formatter.
__ge__(other)	Greater than or equal to operator.
__getattribute__	Return getattr(self, name).
__gt__(other)	Gretear than operator.
__init__(*args)	Constructor.
__init_subclass__	This method is called when a class is subclassed.
__le__(other)	Less than or equal to operator.
__lt__(other)	Less than operator.
__mul__(other)	Multiplication operator.
__ne__(other)	Not equals to operator.
__neg__()	Unary - operator.
__new__	Create and return a new object.
__pos__()	Unary + operator.
__reduce__	Helper for pickle.
__reduce_ex__	Helper for pickle.
__repr__()	Return a human readable string representation of the object.
__rmul__(other)	Multiplication operator.
__setattr__	Implement setattr(self, name, value).
__sizeof__	Size of object in memory, in bytes.
__str__()	Return a human readable string representation of the object.
__sub__(other)	Subtraction operator.
__subclasshook__	Abstract classes can override this to customize issubclass().
__truediv__(other)	Division operator.
_convert_to(unit)	Return the temperature in a different unit.
_default_unit([mag])	Internal method to return an object of the same type in the default unit.
_from_string(string)	Convert a string to an object of the same type.
_kelvin()	Return the magnitude of the temperature in Kelvin.
_validate_unit(unit)	Validate that the unit are supported.
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.

Attributes

__dict__
__doc__
__hash__
__module__
__weakref__	list of weak references to the object (if defined)
_abbreviations
_doc_strings
_null_unit
_print_format
_supported_units

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