scuq 1.0.6

Real and complex physical quantities with units with numpy support.

scuq

This is scuq. Scuq provides scalar (real) and complex physical quantities with units.

This software is distributed unter GPL-3 or higher. See LICENSE for details.

Installation

pip3 install scuq

Command line

The package installs a small diagnostic command:

scuq-info

It prints the installed scuq version, Python and NumPy versions, the package path, the current strict-mode setting, and a few quick smoke-check results. Use scuq-info --json for machine-readable output.

Quick examples

Create quantities and combine them in calculations:

from scuq.quantities import Quantity
from scuq.si import AMPERE, METER, SECOND, VOLT

voltage = Quantity(VOLT, 12.0)
current = Quantity(AMPERE, 0.25)
resistance = voltage / current

speed = Quantity(METER, 10.0) / Quantity(SECOND, 2.0)

print(resistance)  # 48.0 V*A^(-1)
print(speed)       # 5.0 m*s^(-1)

Use compatible units with automatic conversion by disabling strict mode:

from scuq.quantities import Quantity, set_strict
from scuq.si import VOLT
from scuq.units import AlternateUnit

mV = AlternateUnit("mV", VOLT / 1000)

set_strict(False)
signal = Quantity(VOLT, 2.0) + Quantity(mV, 500.0)

print(signal)                 # 2.5 V
print(signal.get_value(mV))   # 2500.0

Propagate uncertainties through a measurement model:

from scuq.quantities import Quantity
from scuq.si import METER
from scuq.ucomponents import Context, UncertainInput

length = Quantity(METER, UncertainInput(2.0, 0.02))
width = Quantity(METER, UncertainInput(3.0, 0.03))

area = length * width
area_uncertainty = Context().uncertainty(area)

print(area)              # 6.0 +/- 0.08485281374238571 [NC] m^(2)
print(area_uncertainty)  # 0.08485281374238571 m^(2)

[NC] means "no context" in the string representation. It appears when an uncertain expression is printed without an assigned uncertainty Context; the explicit Context().uncertainty(...) call uses the provided context and does not include this marker.

License

GPL-3 or higher

Repository

https://gitlab.hrz.tu-chemnitz.de/chair-of-electromagnetic-theory-and-compatibility-at-tu-dresden/mpylab/scuq.git

The documentation is also available from the gitlab server of TU Chemnitz:

https://scuq-b5d96a.gp.hrz.tu-chemnitz.de/

Contact

Prof. Dr. Hans Georg Krauthäuser ([e-mail])
Chair for Electromagnetic Theory and Compatibility
Technische Universität Dresden, Dresden, Germany