API Reference for Enthought Tool Suite 3.0.1

Function summary

• convert(value, from_unit, to_unit)
• convert_str(value, from_unit_string, to_unit_string)
• parser()

Functions

• convert(value, from_unit, to_unit)

  Enthought has extended the original units implementation to handle temperature conversions. Temperature units are a special case because they can have a different origin.

  This causes a fundamental ambiguity. What behavior do we expect when we convert temperature?

  Option #1 When we convert 0 degrees centigrade we get 32 fahrenheit.

  Option #2 When we convert a temperature difference of 0 degrees centigrade we get a temperature difference of 0 degrees fahrenheit.

  By convention we have made the units system behave like in Option #1.

  Therefore, don't pass relative temperatures through the units system.

• convert_str(value, from_unit_string, to_unit_string)

  Convert functions to take in strings and conveniently parse them to units, to return the conversion factor

  Parameters

  from_unit_string: Str

  String representing from_unit, eg. 'm'

  to_unit_string: Str

  String representing to_unit, eg. 'ft'

  Returns:

  return_value: Float

  Conversion factor between the from_unit and the to_unit

• parser()

Imported Names

© Copyright 2002-2008 Enthought, Inc.