RETIRED, further work has moved to Debian project infrastructure
Go to file
Hernan Grecco 297dae0e40 Updated CHANGES and CHANGES_DEV 2014-11-03 16:51:11 -03:00
bench Moved benchmarks to its own folder. 2014-05-06 22:21:51 -03:00
docs Merge branch 'FAQ' of git://github.com/kdavies4/pint into kdavies4-FAQ 2014-10-30 16:57:36 -03:00
pint Fixed chemistry context 2014-10-30 18:11:01 -03:00
.gitignore Fix for Issue #46, calling 'to_base_units' on Quality with Decimal magnitudes no longer throws a TypeError caused by attempting to multiply a float with Decimal. Further edge cases for other magnitude types might be required. 2013-08-16 15:28:28 -04:00
.travis.yml Changed name of travis conda env 2014-08-01 01:24:41 -03:00
AUTHORS Added my name to authors & removed one duplicate 2014-06-09 22:37:03 +02:00
CHANGES Updated CHANGES and CHANGES_DEV 2014-11-03 16:51:11 -03:00
CHANGES_DEV Updated CHANGES and CHANGES_DEV 2014-11-03 16:51:11 -03:00
LICENSE Docs and license 2012-05-03 02:21:14 +02:00
MANIFEST.in Added CHANGES_DEV to MANIFEST.in 2014-08-01 01:30:53 -03:00
README Fixed typos in comments and docs 2014-05-26 18:44:58 +02:00
setup.cfg Removed some zest entry points for setup.cfg 2014-11-03 16:39:20 -03:00
setup.py Removed some zest entry points for setup.cfg 2014-11-03 16:39:20 -03:00
tox.ini Add 3.4 to tox 2014-06-11 08:12:27 -03:00

README

Pint: a Python units library
============================

Pint is Python module/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 to extend (or even rewrite!)
the complete list without changing the source code.

It has a complete test coverage. It runs in Python 2.7 and 3.X
with no other dependency. It licensed under BSD.


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 programed
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 simple and
  easy to edit text file. 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 latex and pretty
  formatting.

- Small codebase: small and easy to maintain with a flat hierarchy.

- Dependency free: it depends only on Python and its standard library.

- Python 2 and 3: A single codebase that runs unchanged in Python 2.7+ and Python 3.0+.

- Advanced NumPy support: While NumPy is not a requirement for Pint,
  when available ndarray methods and ufuncs can be used in Quantity objects.