Skip to main content

Manipulate physical quantities in Python

Project description

physipy

Binder PyPI version

This python package allows you to manipulate physical quantities, basically considering in the association of a value (scalar, numpy.ndarray and more) and a physical unit (like meter or joule).

>>> from physipy.quickstart import nm, hp, c, J
>>> E_ph = hp * c / (500 * nm)
>>> print(E_ph)
3.9728916483435158e-19 kg*m**2/s**2
>>> E_ph.favunit = J
>>> print(E_ph)
3.9728916483435158e-19 J

For a quickstart, check the quickstart notebook on the homepage Get a live session at Binder

Installation

pip install physipy

Goals

  • Few LOC
  • Simple architecture, with only 2 classes (namely Dimension and Quantity)
  • High numpy compatibility
  • Human-readable syntax (fast syntax !)

Use case

  • Define scalar and arrays of physical quantities
  • Compute operation between them : add, sub, mul, div, pow, and so on
  • Display physical quantities in various “units”

Implementation approach

The implementation is pretty simple :

  • a Dimension object represents a physical dimension. For now, these dimension are based on the SI unit. It is basically a dictionary where the keys represent the base dimensions, and the values are the exponent these dimensions.
  • a Quantity object is simply the association of a value, scalar or array (or more!), and a Dimension object. Note that this Quantity classe does not sub-class numpy.ndarray (although Quantity objects are compatible with numpy's ufuncs). Most of the work is done by this class.
  • By default, a Quantity is displayed in term of SI untis. To express a Quantity in another unit, just set the "favunit", which stands for "favourite unit" of the Quantity : my_toe_length.favunit = mm.
  • Plenty of common units (ex : Watt) and constants (ex : speed of light) are packed in. Your physical quantities (my_toe_length), units (kg), and constants (kB) are all Quantity objects.

Numpy's support

See NEP35.

Known issues

numpy.full

import numpy as np
from physipy import m
np.full((3,3), 2*m)

About angles and units

See : https://www.bipm.org/en/CGPM/db/20/8/. Astropy's base units : https://docs.astropy.org/en/stable/units/standard_units.html#enabling-other-units

Alternative packages

There are plenty of python packages that handle physical quantities computation. Some of them are full packages while some are just plain python module. Here is a list of those I could find (approximately sorted by guessed-popularity) :

If you know another package that is not in this list yet, feel free to contribute ! Also, if you are interested in the subject of physical quantities packages in python, check this quantities-comparison repo and this talk. Also check this comparison table.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgment

Thumbs up to phicem and his pysics package, on which this package was highly inspired. Check it out !

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

physipy-0.2.2.tar.gz (54.2 kB view details)

Uploaded Source

Built Distribution

physipy-0.2.2-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

Details for the file physipy-0.2.2.tar.gz.

File metadata

  • Download URL: physipy-0.2.2.tar.gz
  • Upload date:
  • Size: 54.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.50.1 CPython/3.7.4

File hashes

Hashes for physipy-0.2.2.tar.gz
Algorithm Hash digest
SHA256 847bf963d372112ad0e6f42b6da6d9711d5b069b5a0d95b8e958fea9c5c67fb2
MD5 69b8f0999328fadd9f9a2c38016e9cea
BLAKE2b-256 6fba1fb30b069b10926f63abeb692abffa0ed79fa1fdbb0310cd470bb4cf2bdb

See more details on using hashes here.

File details

Details for the file physipy-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: physipy-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 36.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.50.1 CPython/3.7.4

File hashes

Hashes for physipy-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ee18fe0040518b8ad95925116b898e9c316de1af91bacce1bfa31901c3f91c90
MD5 ac3e1813913ffae88ad49379c04ee224
BLAKE2b-256 a67f9b73bf3abe75159b16a8c02314af13d6753a01018d0bbddc8d09e2077b32

See more details on using hashes here.

Supported by

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