File: systems.rst

package info (click to toggle)
python-pint 0.7.2-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 976 kB
  • ctags: 1,314
  • sloc: python: 8,113; makefile: 165
file content (67 lines) | stat: -rw-r--r-- 2,564 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
.. _systems:

Different Unit Systems (and default units)
==========================================

Pint Unit Registry has the concept of system, which is a group of units

    >>> import pint
    >>> ureg = pint.UnitRegistry(system='mks')
    >>> ureg.default_system
    'mks'

This has an effect in the base units. For example:

    >>> q = 3600. * ureg.meter / ureg.hour
    >>> q.to_base_units()
    <Quantity(1.0, 'meter / second')>

But if you change to cgs:

    >>> ureg.default_system = 'cgs'
    >>> q.to_base_units()
    <Quantity(100.0, 'centimeter / second')>

or more drastically to:

    >>> ureg.default_system = 'imperial'
    >>> '{:.3f}'.format(q.to_base_units())
    '1.094 yard / second'

..warning: In versions previous to 0.7 `to_base_units` returns quantities in the
           units of the definition files (which are called root units). For the definition file
           bundled with pint this is meter/gram/second. To get back this behaviour use `to_root_units`,
           set `ureg.system = None`


You can also use system to narrow down the list of compatible units:

    >>> ureg.default_system = 'mks'
    >>> ureg.get_compatible_units('meter')
    frozenset({<Unit('light_year')>, <Unit('angstrom')>})

or for imperial units:

    >>> ureg.default_system = 'imperial'
    >>> ureg.get_compatible_units('meter')
    frozenset({<Unit('thou')>, <Unit('league')>, <Unit('nautical_mile')>, <Unit('inch')>, <Unit('mile')>, <Unit('yard')>, <Unit('foot')>})


You can check which unit systems are available:

    >>> dir(ureg.sys)
    ['US', 'cgs', 'imperial', 'mks']

Or which units are available within a particular system:

    >>> dir(ureg.sys.imperial)
    ['UK_hundredweight', 'UK_ton', 'acre_foot', 'cubic_foot', 'cubic_inch', 'cubic_yard', 'drachm', 'foot', 'grain', 'imperial_barrel', 'imperial_bushel', 'imperial_cup', 'imperial_fluid_drachm', 'imperial_fluid_ounce', 'imperial_gallon', 'imperial_gill', 'imperial_peck', 'imperial_pint', 'imperial_quart', 'inch', 'long_hunderweight', 'long_ton', 'mile', 'ounce', 'pound', 'quarter', 'short_hunderdweight', 'short_ton', 'square_foot', 'square_inch', 'square_mile', 'square_yard', 'stone', 'yard']

Notice that this give you the opportunity to choose within units with colliding names:

    >>> (1 * ureg.sys.imperial.pint).to('liter')
    <Quantity(0.5682612500000002, 'liter')>
    >>> (1 * ureg.sys.US.pint).to('liter')
    <Quantity(0.47317647300000004, 'liter')>
    >>> (1 * ureg.sys.US.pint).to(ureg.sys.imperial.pint)
    <Quantity(0.8326741846289889, 'imperial_pint')>