summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorHernan Grecco <hernan.grecco@gmail.com>2016-02-20 15:13:58 -0300
committerHernan Grecco <hernan.grecco@gmail.com>2016-02-20 15:13:58 -0300
commit6f05a5d05b6f47243af57bd66e73f3ae9cc60895 (patch)
tree8e13fd655b603025036dc4d7e8f736c58143df84 /README.rst
parent4ad6bb1098f26306b3f20e66b7dd4e1ef17e436b (diff)
downloadpint-6f05a5d05b6f47243af57bd66e73f3ae9cc60895.tar.gz
Improved README and docs index
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst48
1 files changed, 43 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 6d96801..283d222 100644
--- a/README.rst
+++ b/README.rst
@@ -27,21 +27,59 @@
:alt: Docs
-Pint: a Python units library
-============================
+Pint: makes units easy
+======================
-Pint is Python module/package to define, operate and manipulate physical
+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 to extend (or even rewrite!)
-the complete list without changing the source code.
+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 2.6 and 3.X
with no other dependency. It is licensed under BSD.
+It is extremely easy and natural to use:
+
+.. code-block:: python
+
+ >>> 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:
+
+.. code-block:: python
+
+ >>> import numpy
+ >>> [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:
+
+.. code-block:: bash
+
+ $ pip install pint
+
+and then simply enjoy it!
+
+
+Documentation
+-------------
+
+Full documentation is available at http://pint.readthedocs.org/
+
Design principles
-----------------