Skip to main content

Physical quantities module

Project description

Latest Version Ruff Ruff-Format Documentation License Python Versions CI LINTER Coverage

Pint: makes units easy

Pint is a Python package to define, operate and manipulate physical quantities: the product of a numerical value and a unit of measurement. It allows arithmetic operations between them and conversions from and to different units.

It is distributed with a comprehensive list of physical units, prefixes and constants. Due to its modular design, you can extend (or even rewrite!) the complete list without changing the source code. It supports a lot of numpy mathematical operations without monkey patching or wrapping numpy.

It has a complete test coverage. It runs in Python 3.9+ with no other dependency. It is licensed under BSD.

It is extremely easy and natural to use:

>>> import pint
>>> ureg = pint.UnitRegistry()
>>> 3 * ureg.meter + 4 * ureg.cm
<Quantity(3.04, 'meter')>

and you can make good use of numpy if you want:

>>> import numpy as np
>>> [3, 4] * ureg.meter + [4, 3] * ureg.cm
<Quantity([ 3.04  4.03], 'meter')>
>>> np.sum(_)
<Quantity(7.07, 'meter')>

Quick Installation

To install Pint, simply:

$ pip install pint

or utilizing conda, with the conda-forge channel:

$ conda install -c conda-forge pint

and then simply enjoy it!

Documentation

Full documentation is available at http://pint.readthedocs.org/

Command-line converter

A command-line script pint-convert provides a quick way to convert between units or get conversion factors.

Design principles

Although there are already a few very good Python packages to handle physical quantities, no one was really fitting my needs. Like most developers, I programmed Pint to scratch my own itches.

Unit parsing: prefixed and pluralized forms of units are recognized without explicitly defining them. In other words: as the prefix kilo and the unit meter are defined, Pint understands kilometers. This results in a much shorter and maintainable unit definition list as compared to other packages.

Standalone unit definitions: units definitions are loaded from a text file which is simple and easy to edit. Adding and changing units and their definitions does not involve changing the code.

Advanced string formatting: a quantity can be formatted into string using PEP 3101 syntax. Extended conversion flags are given to provide symbolic, LaTeX and pretty formatting. Unit name translation is available if Babel is installed.

Free to choose the numerical type: You can use any numerical type (fraction, float, decimal, numpy.ndarray, etc). NumPy is not required but supported.

Awesome NumPy integration: When you choose to use a NumPy ndarray, its methods and ufuncs are supported including automatic conversion of units. For example numpy.arccos(q) will require a dimensionless q and the units of the output quantity will be radian.

Uncertainties integration: transparently handles calculations with quantities with uncertainties (like 3.14±0.01 meter) via the uncertainties package.

Handle temperature: conversion between units with different reference points, like positions on a map or absolute temperature scales.

Dependency free: it depends only on Python and its standard library. It interacts with other packages like numpy and uncertainties if they are installed

Pandas integration: Thanks to Pandas Extension Types it is now possible to use Pint with Pandas. Operations on DataFrames and between columns are units aware, providing even more convenience for users of Pandas DataFrames. For full details, see the pint-pandas Jupyter notebook.

Pint is maintained by a community of scientists, programmers and enthusiasts around the world. See AUTHORS for a complete list.

To review an ordered list of notable changes for each version of a project, see CHANGES

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pint-0.24rc2.tar.gz (340.3 kB view details)

Uploaded Source

Built Distribution

Pint-0.24rc2-py3-none-any.whl (300.8 kB view details)

Uploaded Python 3

File details

Details for the file pint-0.24rc2.tar.gz.

File metadata

  • Download URL: pint-0.24rc2.tar.gz
  • Upload date:
  • Size: 340.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for pint-0.24rc2.tar.gz
Algorithm Hash digest
SHA256 b66653873d83cbb46ff14bb9b3e42edaa0fe85e57ac7759944d911895e9207a0
MD5 1fe0d793435ef6ef0df38d284d418334
BLAKE2b-256 f408927931c9a737771937437a5960c13bd864c08fb0f604410e588285d59612

See more details on using hashes here.

File details

Details for the file Pint-0.24rc2-py3-none-any.whl.

File metadata

  • Download URL: Pint-0.24rc2-py3-none-any.whl
  • Upload date:
  • Size: 300.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for Pint-0.24rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 a3a0faa454e062de1d971810e708584394b35eb748307f83fe7d158210a8cb3d
MD5 4828fe3a40c4e7207ab21b82eba769fa
BLAKE2b-256 80d78b844a12985e2ca0e845446f885a4078670b4b912118c9f9c3a3bc7cce4c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page