eqiora.units

← Python API index

Shared units for input quantities and explicit presentation.

View source

Example: dimensional quantities

python

import eqiora
from eqiora import lang as q, units as u

source = eqiora.Module("units_example")
component = source.model("Speed")
speed = component.field(
    "speed", role=eqiora.FieldRole.Variable,
    value_type=eqiora.ValueType.real(eqiora.Dimension(length=1, time=-1)),
)
component.relation("given", q.equation(speed, q.quantity(3, u.m / u.s)))
print(source.to_eqi())
model = eqiora.compile(source=source)

Dimension gives the field its physical type, and quantity attaches a unit to a value, so the equation sets the speed to 3 metres per second. If you replace the unit with u.s, compilation fails with a dimension error.

API

Unit

An immutable unit expression for input and presentation quantities.

python

@final
class Unit:
    def __mul__(self, other: Unit, /) -> Unit: ...
    def __truediv__(self, other: Unit, /) -> Unit: ...
    def __pow__(self, exponent: int | Fraction, /) -> Unit: ...
    def normalize(self, value: int | float | Decimal) -> tuple[float, Dimension]: ...
    def prefixed(self, prefix: str) -> Unit: ...
    def present(self, value: float, dimension: Dimension, *, decimal_places: int=6, locale: str='C') -> PresentedQuantity: ...

kg

Input-unit symbol.

python

kg: Final[Unit]

m

Input-unit symbol.

python

m: Final[Unit]

s

Input-unit symbol.

python

s: Final[Unit]

A

Input-unit symbol.

python

A: Final[Unit]

K

Input-unit symbol.

python

K: Final[Unit]

mol

Input-unit symbol.

python

mol: Final[Unit]

cd

Input-unit symbol.

python

cd: Final[Unit]

Hz

Input-unit symbol.

python

Hz: Final[Unit]

N

Input-unit symbol.

python

N: Final[Unit]

Pa

Input-unit symbol.

python

Pa: Final[Unit]

J

Input-unit symbol.

python

J: Final[Unit]

W

Input-unit symbol.

python

W: Final[Unit]

C

Input-unit symbol.

python

C: Final[Unit]

V

Input-unit symbol.

python

V: Final[Unit]

Ohm

Input-unit symbol.

python

Ohm: Final[Unit]

S

Input-unit symbol.

python

S: Final[Unit]

F

Input-unit symbol.

python

F: Final[Unit]

H

Input-unit symbol.

python

H: Final[Unit]

Wb

Input-unit symbol.

python

Wb: Final[Unit]

T

Input-unit symbol.

python

T: Final[Unit]

g

Input-unit symbol.

python

g: Final[Unit]

one

Input-unit symbol.

python

one: Final[Unit]