units package

Package for physical quantity modules and classes.

class units.Acceleration(value: float, distance_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None)

The rate of change of the velocity of an object with respect to time.

__abs__() → Acceleration

Return the absolute version of the acceleration.

__add__(other: Acceleration) → Acceleration

Return the sum of two accelerations.

__divmod__(other: Acceleration) → tuple[float, float]

Return the quotient & remainder of the ratio between the accelerations.

__eq__(other: object) → bool

Return whether the objects are equal accelerations.

__floordiv__(other: Acceleration) → float

Return the floored ratio between the accelerations.

__ge__(other: Acceleration) → bool

Return whether the acceleration is greater than or equal to the other.

__gt__(other: Acceleration) → bool

Return whether the acceleration is greater than the other.

__hash__() → int

Return the hash of the acceleration.

__init__(value: float, distance_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None) → None

Initialise a new acceleration.

If a second time unit is not provided, the first time unit will be reused.

__le__(other: Acceleration) → bool

Return whether the acceleration is less than or equal to the other.

__lt__(other: Acceleration) → bool

Return whether the acceleration is less than the other.

__mod__(other: Acceleration) → float

Return the remainder of the ratio between the acceleration.

__mul__(value: float) → Acceleration

Return an acceleration scaled by the value.

__neg__() → Acceleration

Return the inverse of the acceleration.

__rmul__(value: float) → Acceleration

Return an acceleration scaled by the value.

__sub__(other: Acceleration) → Acceleration

Return the difference of two accelerations.

__truediv__(other: float | Acceleration) → Acceleration | float

Return a scaled acceleration or the ratio between the accelerations.

The behaviour depends upon the type of the argument.

• If the argument is a float, return an acceleration scaled by the inverse of the value

• If the argument is a Acceleration, return the ratio between the two accelerations

as_unit(distance_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None) → float

Return the acceleration in the specified units.

If a second time unit is not provided, the first time unit will be reused.

class units.Angle(value: float, unit: Unit)

The opening between two lines in the same plane that meet at a point.

Angle always in range [0, 2*pi) radians.

__add__(delta: AngleDelta) → Angle

Return the sum of the angle and the difference.

__eq__(other: object) → bool

Return whether the objects are equal angles.

__hash__() → int

Return the hash of the length.

__init__(value: float, unit: Unit) → None

Initialise a new angle.

Values outside of the range range [0, 2*pi) radians will be mapped into it.

Range	INITIALIZATION	EQUIVALENT TO
Within	Angle(185, Unit.DEGREE)	Angle(185, Unit.DEGREE)
Below	Angle(-3*math.pi, Unit.RADIAN)	Angle(math.pi, Unit.RADIAN)
Above	Angle(4, Unit.REVOLUTION)	Angle(0, Unit.REVOLUTION)

__radd__(delta: AngleDelta) → Angle

Return the sum of the angle and the difference.

__sub__(other: Angle | AngleDelta) → AngleDelta | Angle

Return the delta between angles or the angle less the delta.

The behaviour depends upon the type of the argument.

• If the argument is an angle, return the difference between the two angles.

• If the argument is an angle delta, return the angle less the difference.

as_unit(unit: Unit) → float

Return the angle, expressed as the unit.

class units.AngleDelta(value: float, unit: Unit)

The difference between two angles.

Angle difference always in range [-pi, pi) radians.

__add__(other: AngleDelta) → AngleDelta

Return the sum of the angle differences.

__eq__(other: object) → bool

Return whether the objects are equal angle differences.

__hash__() → int

Return the hash of the angle difference.

__init__(value: float, unit: Unit) → None

Initialise a new angle difference.

Values outside the range [-pi, pi) radians will be mapped into it.

Range	INITIALIZATION	EQUIVALENT TO
Within	AngleDelta(-40, Unit.DEGREE)	AngleDelta(-40, Unit.DEGREE)
Below	AngleDelta(-3*pi, Unit.RADIAN)	AngleDelta(pi, Unit.RADIAN)
Above	AngleDelta(3.75, Unit.REVOLUTION)	AngleDelta(-0.25, Unit.REVOLUTION)

__neg__() → AngleDelta

Return the inverse of the angle difference.

__sub__(delta: AngleDelta) → AngleDelta

Return the difference between the angle differences.

as_unit(unit: Unit) → float

Return the angle difference, expressed as the unit.

units.AngleUnit

alias of Unit

units.AngularAcceleration

alias of Acceleration

units.AngularDisplacement

alias of Displacement

units.AngularJerk

alias of Jerk

units.AngularVelocity

alias of Velocity

class units.Area(value: float, unit: Unit)

The measure of a two-dimensional space.

__add__(delta: AreaDelta) → Area

Return the sum of the area and the difference.

Raises:

NegativeAreaValueError – The sum of the area and the difference was less than 0m^2.

__eq__(other: object) → bool

Return whether the objects are equal areas.

__ge__(other: Area) → bool

Return whether the area is greater than or equal to the other.

__gt__(other: Area) → bool

Return whether the area is greater than the other.

__hash__() → int

Return the hash of the area.

__init__(value: float, unit: Unit) → None

Initialise a new area.

Raises:

NegativeAreaValueError – The negative value produced an area less than 0m^2.

__le__(other: Area) → bool

Return whether the area is less than or equal to the other.

__lt__(other: Area) → bool

Return whether the area is less than the other.

__radd__(delta: AreaDelta) → Area

Return the sum of the area and the difference.

__sub__(other: Area | AreaDelta) → AreaDelta | Area

Return the delta between two areas or the area less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Area, return the difference between the two areas.

• If the argument is a AreaDelta, return the area less the difference.

Raises:

NegativeAreaValueError – The area minus the difference was less than 0m^2. Error can only be raised when other is an AreaDelta.

as_unit(unit: Unit) → float

Return the area, expressed as the unit.

class units.AreaDelta(value: float, unit: Unit)

The difference between two areas.

__abs__() → AreaDelta

Return the absolute version of the area difference.

__add__(other: AreaDelta) → AreaDelta

Return the sum of the area differences.

__divmod__(other: AreaDelta) → tuple[float, float]

Return the quotient & remainder of the ratio between the area deltas.

__eq__(other: object) → bool

Return whether the objects are equal area differences.

__floordiv__(other: AreaDelta) → float

Return the floored ratio between the area differences.

__ge__(other: AreaDelta) → bool

Return whether the area delta is greater than or equal to the other.

__gt__(other: AreaDelta) → bool

Return whether the area difference is greater than the other.

__hash__() → int

Return the hash of the area difference.

__init__(value: float, unit: Unit) → None

Initialise a new area difference.

__le__(other: AreaDelta) → bool

Return whether the area delta is less than or equal to the other.

__lt__(other: AreaDelta) → bool

Return whether the area difference is less than the other.

__mod__(other: AreaDelta) → float

Return the remainder of the ratio between the area differences.

__mul__(value: float) → AreaDelta

Return a area difference scaled by the value.

__neg__() → AreaDelta

Return the inverse of the area difference.

__rmul__(value: float) → AreaDelta

Return a area difference scaled by the value.

__sub__(delta: AreaDelta) → AreaDelta

Return the difference between the area differences.

__truediv__(other: float | AreaDelta) → AreaDelta | float

Return a scaled area difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is float, return a area difference scaled by the inverse of the value

• If the argument is a AreaDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the area difference, expressed as the unit.

units.AreaUnit

alias of Unit

exception units.BelowAbsoluteZeroError(value: float, unit: Unit, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the temperature would be less than absolute zero.

The minimum temperature that can exist is absolute zero (0 K), so a temperature less than this is impossible.

__init__(value: float, unit: Unit, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new below-absolute-zero exception.

property unit: Unit

The temperature unit that caused the error.

property value: float

The temperature value that caused the error.

class units.Current(value: float, unit: Unit)

The flow of charged particles through an electrical conductor.

__abs__() → Current

Return the absolute version of the current.

__add__(other: Current) → Current

Return the sum of the currents.

__divmod__(other: Current) → tuple[float, float]

Return the quotient & remainder of the ratio between the currents.

__eq__(other: object) → bool

Return whether the objects are equal currents.

__floordiv__(other: Current) → float

Return the floored ratio between the currents.

__ge__(other: Current) → bool

Return whether the current is greater than or equal to the other.

__gt__(other: Current) → bool

Return whether the current is greater than the other.

__hash__() → int

Return the hash of the current.

__init__(value: float, unit: Unit) → None

Initialise a new current.

__le__(other: Current) → bool

Return whether the current is less than or equal to the other.

__lt__(other: Current) → bool

Return whether the current is less than the other.

__mod__(other: Current) → float

Return the remainder of the ratio between the currents.

__mul__(value: float) → Current

Return a current scaled by the value.

__neg__() → Current

Return the inverse of the current.

__rmul__(value: float) → Current

Return a current scaled by the value.

__sub__(delta: Current) → Current

Return the difference between the currents.

__truediv__(other: float | Current) → Current | float

Return a scaled current or the ratio between the currents.

The behaviour depends upon the type of the argument.

• If the argument is float, return a current scaled by the inverse of the value

• If the argument is a Current, return the ratio between the two currents

as_unit(unit: Unit) → float

Return the current, expressed as the unit.

units.CurrentUnit

alias of Unit

class units.Displacement(value: float, unit: Unit)

The difference between the final and initial position of a trajectory.

__abs__() → Displacement

Return the absolute version of the displacement.

__add__(other: Displacement) → Displacement

Return the sum of the displacements.

__divmod__(other: Displacement) → tuple[float, float]

Return the quotient & remainder of the ratio between the displacements.

__eq__(other: object) → bool

Return whether the objects are equal displacements.

__floordiv__(other: Displacement) → float

Return the floored ratio between the displacements.

__ge__(other: Displacement) → bool

Return whether the displacement is greater than or equal to the other.

__gt__(other: Displacement) → bool

Return whether the displacement is greater than the other.

__hash__() → int

Return the hash of the displacement.

__init__(value: float, unit: Unit) → None

Initialise a new displacement.

__le__(other: Displacement) → bool

Return whether the displacement is less than or equal to the other.

__lt__(other: Displacement) → bool

Return whether the displacement is less than the other.

__mod__(other: Displacement) → float

Return the remainder of the ratio between the displacements.

__mul__(value: float) → Displacement

Return a displacement scaled by the value.

__neg__() → Displacement

Return the inverse of the displacement.

__rmul__(value: float) → Displacement

Return a displacement scaled by the value.

__sub__(delta: Displacement) → Displacement

Return the difference between the displacements.

__truediv__(other: float | Displacement) → Displacement | float

Return a scaled displacement or the ratio between the displacements.

The behaviour depends upon the type of the argument.

• If the argument is a float, return a displacement scaled by the inverse of the value

• If the argument is a Displacement, return the ratio between the two displacements

as_unit(unit: Unit) → float

Return the displacement, expressed as the unit.

units.DistanceUnit

alias of Unit

class units.Jerk(value: float, distance_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None, third_time_unit: Unit | None = None)

The rate of change of the jerk of an object with respect to time.

__abs__() → Jerk

Return the absolute version of the jerk.

__add__(other: Jerk) → Jerk

Return the sum of two jerks.

__divmod__(other: Jerk) → tuple[float, float]

Return the quotient & remainder of the ratio between the jerks.

__eq__(other: object) → bool

Return whether the objects are equal jerks.

__floordiv__(other: Jerk) → float

Return the floored ratio between the jerks.

__ge__(other: Jerk) → bool

Return whether the jerk is greater than or equal to the other.

__gt__(other: Jerk) → bool

Return whether the jerk is greater than the other.

__hash__() → int

Return the hash of the jerk.

__init__(value: float, distance_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None, third_time_unit: Unit | None = None) → None

Initialise a new jerk.

If a second time unit is not provided, the first time unit will be reused. If the third time unit is not provided, the second time unit will be reused (or the first, if the second is also not provided).

__le__(other: Jerk) → bool

Return whether the jerk is less than or equal to the other.

__lt__(other: Jerk) → bool

Return whether the jerk is less than the other.

__mod__(other: Jerk) → float

Return the remainder of the ratio between the jerk.

__mul__(value: float) → Jerk

Return an jerk scaled by the value.

__neg__() → Jerk

Return the inverse of the jerk.

__rmul__(value: float) → Jerk

Return an jerk scaled by the value.

__sub__(other: Jerk) → Jerk

Return the difference of two jerks.

__truediv__(other: float | Jerk) → Jerk | float

Return a scaled jerk or the ratio between the jerks.

The behaviour depends upon the type of the argument.

• If the argument is a float, return an jerk scaled by the inverse of the value

• If the argument is a Jerk, return the ratio between the two jerks

as_unit(distance_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None, third_time_unit: Unit | None = None) → float

Return the jerk in the specified units.

If a second time unit is not provided, the first time unit will be reused. If the third time unit is not provided, the second time unit will be reused (or the first, if the second is also not provided).

class units.Length(value: float, unit: Unit)

The measure of distance.

__add__(delta: LengthDelta) → Length

Return the sum of the length and the difference.

Raises:

NegativeLengthValueError – The sum of the length and the difference was less than 0m.

__eq__(other: object) → bool

Return whether the objects are equal lengths.

__ge__(other: Length) → bool

Return whether the length is greater than or equal to the other.

__gt__(other: Length) → bool

Return whether the length is greater than the other.

__hash__() → int

Return the hash of the length.

__init__(value: float, unit: Unit) → None

Initialise a new length.

Raises:

NegativeLengthValueError – The negative value produced a length less than 0m.

__le__(other: Length) → bool

Return whether the length is less than or equal to the other.

__lt__(other: Length) → bool

Return whether the length is less than the other.

__radd__(delta: LengthDelta) → Length

Return the sum of the length and the difference.

__sub__(other: Length | LengthDelta) → LengthDelta | Length

Return the delta between lengths or the length less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Length, return the difference between the two lengths.

• If the argument is a LengthDelta, return the length less the difference.

Raises:

NegativeLengthValueError – The length minus the difference was less than 0m. Error can only be raised when other is a LengthDelta.

as_unit(unit: Unit) → float

Return the length, expressed as the unit.

class units.LengthDelta(value: float, unit: Unit)

The difference between two lengths.

__abs__() → LengthDelta

Return the absolute version of the length difference.

__add__(other: LengthDelta) → LengthDelta

Return the sum of the length differences.

__divmod__(other: LengthDelta) → tuple[float, float]

Return the quotient & remainder of the ratio between the length deltas.

__eq__(other: object) → bool

Return whether the objects are equal length differences.

__floordiv__(other: LengthDelta) → float

Return the floored ratio between the length differences.

__ge__(other: LengthDelta) → bool

Return whether the length delta is greater than or equal to the other.

__gt__(other: LengthDelta) → bool

Return whether the length difference is greater than the other.

__hash__() → int

Return the hash of the length difference.

__init__(value: float, unit: Unit) → None

Initialise a new length difference.

__le__(other: LengthDelta) → bool

Return whether the length difference is less than or equal to the other.

__lt__(other: LengthDelta) → bool

Return whether the length difference is less than the other.

__mod__(other: LengthDelta) → float

Return the remainder of the ratio between the length differences.

__mul__(value: float) → LengthDelta

Return a length difference scaled by the value.

__neg__() → LengthDelta

Return the inverse of the length difference.

__rmul__(value: float) → LengthDelta

Return a length difference scaled by the value.

__sub__(delta: LengthDelta) → LengthDelta

Return the difference between the length differences.

__truediv__(other: float | LengthDelta) → LengthDelta | float

Return a scaled length difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is float, return a length difference scaled by the inverse of the value

• If the argument is a LengthDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the length difference, expressed as the unit.

class units.Mass(value: float, unit: Unit)

The force applied per unit area over which that force is distributed.

__add__(delta: MassDelta) → Mass

Return the sum of the mass and the difference.

Raises:

NegativeMassValueError – The sum of the mass and the difference was less than 0kg.

__eq__(other: object) → bool

Return whether the objects are equal masses.

__ge__(other: Mass) → bool

Return whether the mass is greater than or equal to the other.

__gt__(other: Mass) → bool

Return whether the mass is greater than the other.

__hash__() → int

Return the hash of the mass.

__init__(value: float, unit: Unit) → None

Initialise a new mass.

Raises:

NegativeMassValueError – The negative value produced a mass less than 0kg.

__le__(other: Mass) → bool

Return whether the mass is less than or equal to the other.

__lt__(other: Mass) → bool

Return whether the mass is less than the other.

__radd__(delta: MassDelta) → Mass

Return the sum of the mass and the difference.

__sub__(other: Mass | MassDelta) → MassDelta | Mass

Return the delta between mass or the mass less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Mass, return the difference between the two masses.

• If the argument is a MassDelta, return the mass less the difference.

Raises:

NegativeMassValueError – The mass minus the difference was less than 0kg. Only possible when other is a MassDelta.

as_unit(unit: Unit) → float

Return the mass, expressed as the unit.

class units.MassDelta(value: float, unit: Unit)

The difference between two masses.

__abs__() → MassDelta

Return the absolute version of the mass difference.

__add__(other: MassDelta) → MassDelta

Return the sum of the mass differences.

__divmod__(other: MassDelta) → tuple[float, float]

Return the quotient & remainder of the ratio between the mass deltas.

__eq__(other: object) → bool

Return whether the objects are equal mass differences.

__floordiv__(other: MassDelta) → float

Return the floored ratio between the mass differences.

__ge__(other: MassDelta) → bool

Return whether the mass delta is greater than or equal to the other.

__gt__(other: MassDelta) → bool

Return whether the mass difference is greater than the other.

__hash__() → int

Return the hash of the mass difference.

__init__(value: float, unit: Unit) → None

Initialise a new mass difference.

__le__(other: MassDelta) → bool

Return whether the mass delta is less than or equal to the other.

__lt__(other: MassDelta) → bool

Return whether the mass difference is less than the other.

__mod__(other: MassDelta) → float

Return the remainder of the ratio between the mass differences.

__mul__(value: float) → MassDelta

Return a mass difference scaled by the value.

__neg__() → MassDelta

Return the inverse of the mass difference.

__rmul__(value: float) → MassDelta

Return a mass difference scaled by the value.

__sub__(delta: MassDelta) → MassDelta

Return the difference between the mass differences.

__truediv__(other: float | MassDelta) → MassDelta | float

Return a scaled mass difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is a float, return a mass difference scaled by the inverse of the value

• If the argument is a MassDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the mass difference, expressed as the unit.

class units.MassFlowRate(value: float, mass_unit: Unit, time_unit: Unit)

The mass of a gas or liquid that flows in a certain amount of time.

__abs__() → MassFlowRate

Return the absolute version of the flow rate.

__add__(other: MassFlowRate) → MassFlowRate

Return the sum of two flow rates.

__divmod__(other: MassFlowRate) → tuple[float, float]

Return the quotient & remainder of the ratio between the flow rates.

__eq__(other: object) → bool

Return whether the objects are equal flow rates.

__floordiv__(other: MassFlowRate) → float

Return the floored ratio between the flow rates.

__ge__(other: MassFlowRate) → bool

Return whether the flow rate is greater than or equal to the other.

__gt__(other: MassFlowRate) → bool

Return whether the flow rate is greater than the other.

__hash__() → int

Return the hash of the flow rate.

__init__(value: float, mass_unit: Unit, time_unit: Unit) → None

Initialise a new flow rate.

__le__(other: MassFlowRate) → bool

Return whether the flow rate is less than or equal to the other.

__lt__(other: MassFlowRate) → bool

Return whether the flow rate is less than the other.

__mod__(other: MassFlowRate) → float

Return the remainder of the ratio between the flow rate.

__mul__(value: float) → MassFlowRate

Return a flow rate scaled by the value.

__neg__() → MassFlowRate

Return the inverse of the flow rate.

__rmul__(value: float) → MassFlowRate

Return a flow rate scaled by the value.

__sub__(other: MassFlowRate) → MassFlowRate

Return the difference of two flow rates.

__truediv__(other: float | MassFlowRate) → MassFlowRate | float

Return a scaled flow rate or the ratio between the flow rates.

The behaviour depends upon the type of the argument.

• If the argument is a float, return a flow rate scaled by the inverse of the value

• If the argument is a MassFlowRate, return the ratio between the two flow rates

as_unit(mass_unit: Unit, time_unit: Unit) → float

Return the flow rate in the specified units.

units.MassUnit

alias of Unit

exception units.NegativeAreaValueError(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the area value is negative.

The minimum area that can exist is 0 m^2, so an area with a negative value, regardless of the unit, is impossible.

__init__(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new negative-area exception.

property value: float

The area value that caused the error.

exception units.NegativeLengthValueError(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the length value is negative.

The minimum length that can exist is 0m, so a length with a negative value, regardless of the unit, is impossible.

__init__(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new negative-length exception.

property value: float

The length value that caused the error.

exception units.NegativeMassValueError(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the mass value is negative.

The minimum mass that can exist is 0 kg, so a mass with a negative value, regardless of the unit, is impossible.

__init__(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new negative-mass exception.

property value: float

The mass value that caused the error.

exception units.NegativePressureValueError(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the pressure value is negative.

The minimum pressure that can exist is a perfect vacuum (0 Pa), so a pressure with a negative value, regardless of the unit, is impossible.

__init__(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new negative-pressure exception.

property value: float

The pressure value that caused the error.

exception units.NegativeTimeValueError(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the time value is negative.

The minimum time that can exist is 0s, so a time with a negative value, regardless of the unit, is impossible.

__init__(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new negative-time exception.

property value: float

The time value that caused the error.

exception units.NegativeVolumeValueError(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the volume value is negative.

The minimum volume that can exist is 0 m^3, so a volume with a negative value, regardless of the unit, is impossible.

__init__(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new negative-volume exception.

property value: float

The volume value that caused the error.

class units.Pressure(value: float, unit: Unit)

The force applied per unit area over which that force is distributed.

__add__(delta: PressureDelta) → Pressure

Return the sum of the pressure and the difference.

Raises:

NegativePressureValueError – The sum of the pressure and the difference was less than 0Pa.

__eq__(other: object) → bool

Return whether the objects are equal pressures.

__ge__(other: Pressure) → bool

Return whether the pressure is greater than or equal to the other.

__gt__(other: Pressure) → bool

Return whether the pressure is greater than the other.

__hash__() → int

Return the hash of the pressure.

__init__(value: float, unit: Unit) → None

Initialise a new pressure.

Raises:

NegativePressureValueError – The negative value produced a pressure less than 0Pa.

__le__(other: Pressure) → bool

Return whether the pressure is less than or equal to the other.

__lt__(other: Pressure) → bool

Return whether the pressure is less than the other.

__radd__(delta: PressureDelta) → Pressure

Return the sum of the pressure and the difference.

__sub__(other: Pressure | PressureDelta) → PressureDelta | Pressure

Return the delta between pressures or the pressure less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Pressure, return the difference between the two pressures.

• If the argument is a PressureDelta, return the pressure less the difference.

Raises:

NegativePressureValueError – The pressure minus the difference was less than 0Pa. Error can only be raised when other is a PressureDelta.

as_unit(unit: Unit) → float

Return the pressure, expressed as the unit.

class units.PressureDelta(value: float, unit: Unit)

The difference between two pressures.

__abs__() → PressureDelta

Return the absolute version of the pressure difference.

__add__(other: PressureDelta) → PressureDelta

Return the sum of the pressure differences.

__divmod__(other: PressureDelta) → tuple[float, float]

Return the quotient & remainder of the ratio between the pressure deltas.

__eq__(other: object) → bool

Return whether the objects are equal pressure differences.

__floordiv__(other: PressureDelta) → float

Return the floored ratio between the pressure differences.

__ge__(other: PressureDelta) → bool

Return whether the pressure delta is greater than or equal to the other.

__gt__(other: PressureDelta) → bool

Return whether the pressure difference is greater than the other.

__hash__() → int

Return the hash of the pressure difference.

__init__(value: float, unit: Unit) → None

Initialise a new pressure difference.

__le__(other: PressureDelta) → bool

Return whether the pressure delta is less than or equal to the other.

__lt__(other: PressureDelta) → bool

Return whether the pressure difference is less than the other.

__mod__(other: PressureDelta) → float

Return the remainder of the ratio between the pressure differences.

__mul__(value: float) → PressureDelta

Return a pressure difference scaled by the value.

__neg__() → PressureDelta

Return the inverse of the pressure difference.

__rmul__(value: float) → PressureDelta

Return a pressure difference scaled by the value.

__sub__(delta: PressureDelta) → PressureDelta

Return the difference between the pressure differences.

__truediv__(other: float | PressureDelta) → PressureDelta | float

Return a scaled pressure difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is float, return a pressure difference scaled by the inverse of the value

• If the argument is a PressureDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the pressure difference, expressed as the unit.

units.PressureUnit

alias of Unit

class units.Temperature(value: float, unit: Unit)

Quantitatively expresses the attribute of hotness or coldness.

__add__(delta: TemperatureDelta) → Temperature

Return the sum of the temperature and the difference.

Raises:

BelowAbsoluteZeroError – The sum of the temperature and the difference was less than absolute zero.

__eq__(other: object) → bool

Return whether the objects are equal temperatures.

__ge__(other: Temperature) → bool

Return whether the temperature is greater than or equal to the other.

__gt__(other: Temperature) → bool

Return whether the temperature is greater than the other.

__hash__() → int

Return the hash of the temperature.

__init__(value: float, unit: Unit) → None

Initialise a new temperature.

Raises:

BelowAbsoluteZeroError – The value and unit produced an invalid temperature less than absolute zero.

__le__(other: Temperature) → bool

Return whether the temperature is less than or equal to the other.

__lt__(other: Temperature) → bool

Return whether the temperature is less than the other.

__radd__(delta: TemperatureDelta) → Temperature

Return the sum of the temperature and the difference.

__sub__(other: Temperature | TemperatureDelta) → TemperatureDelta | Temperature

Return the delta between temperatures or the temperature less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Temperature, return the difference between the two temperatures.

• If the argument is a TemperatureDelta, return the temperature less the difference.

Raises:

BelowAbsoluteZeroError – The temperature minus the difference was less than absolute zero.Error can only be raised when other is a TemperatureDelta.

as_unit(unit: Unit) → float

Return the temperature, expressed as the unit.

class units.TemperatureDelta(value: float, unit: Unit)

The difference between two temperatures.

__abs__() → TemperatureDelta

Return the absolute version of the temperature difference.

__add__(other: TemperatureDelta) → TemperatureDelta

Return the sum of the temperature differences.

__divmod__(other: TemperatureDelta) → tuple[float, float]

Return the quotient and remainder of the ratio between the temp deltas.

__eq__(other: object) → bool

Return whether the objects are equal temperature differences.

__floordiv__(other: TemperatureDelta) → float

Return the floored ratio between the temperature differences.

__ge__(other: TemperatureDelta) → bool

Return whether the temperature delta is greater than or equal to other.

__gt__(other: TemperatureDelta) → bool

Return whether the temperature difference is greater than the other.

__hash__() → int

Return the hash of the temperature difference.

__init__(value: float, unit: Unit) → None

Initialise a new temperature difference.

__le__(other: TemperatureDelta) → bool

Return whether the temperature delta is less than or equal to the other.

__lt__(other: TemperatureDelta) → bool

Return whether the temperature difference is less than the other.

__mod__(other: TemperatureDelta) → float

Return the remainder of the ratio between the temperature differences.

__mul__(value: float) → TemperatureDelta

Return a temperature difference scaled by the value.

__neg__() → TemperatureDelta

Return the inverse of the temperature difference.

__rmul__(value: float) → TemperatureDelta

Return a temperature difference scaled by the value.

__sub__(delta: TemperatureDelta) → TemperatureDelta

Return the difference between the temperature differences.

__truediv__(other: float | TemperatureDelta) → TemperatureDelta | float

Return a scaled temperature difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is float, return a temperature difference scaled by the inverse of the value

• If the argument is a TemperatureDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the temperature difference, expressed as the unit.

units.TemperatureUnit

alias of Unit

class units.Time(value: float, unit: Unit)

The measure in which events can be ordered from the past into the future.

__add__(delta: TimeDelta) → Time

Return the sum of the time and the difference.

Raises:

NegativeTimeValueError – The sum of the time and the difference was less than 0s.

__eq__(other: object) → bool

Return whether the objects are equal times.

__ge__(other: Time) → bool

Return whether the time is greater than or equal to the other.

__gt__(other: Time) → bool

Return whether the time is greater than the other.

__hash__() → int

Return the hash of the time.

__init__(value: float, unit: Unit) → None

Initialise a new time.

Raises:

NegativeTimeValueError – The negative value produced a time less than 0s.

__le__(other: Time) → bool

Return whether the time is less than or equal to the other.

__lt__(other: Time) → bool

Return whether the time is less than the other.

__radd__(delta: TimeDelta) → Time

Return the sum of the time and the difference.

__sub__(other: Time | TimeDelta) → TimeDelta | Time

Return the delta between times or the time less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Time, return the difference between the two times.

• If the argument is a TimeDelta, return the time less the difference.

Raises:

NegativeTimeValueError – The time minus the difference was less than 0s. Error can only be raised when other is a TimeDelta.

as_unit(unit: Unit) → float

Return the time, expressed as the unit.

class units.TimeDelta(value: float, unit: Unit)

The difference between two times.

__abs__() → TimeDelta

Return the absolute version of the time difference.

__add__(other: TimeDelta) → TimeDelta

Return the sum of the time differences.

__divmod__(other: TimeDelta) → tuple[float, float]

Return the quotient & remainder of the ratio between the time deltas.

__eq__(other: object) → bool

Return whether the objects are equal time differences.

__floordiv__(other: TimeDelta) → float

Return the floored ratio between the time differences.

__ge__(other: TimeDelta) → bool

Return whether the time delta is greater than or equal to the other.

__gt__(other: TimeDelta) → bool

Return whether the time difference is greater than the other.

__hash__() → int

Return the hash of the time difference.

__init__(value: float, unit: Unit) → None

Initialise a new time difference.

__le__(other: TimeDelta) → bool

Return whether the time delta is less than or equal to the other.

__lt__(other: TimeDelta) → bool

Return whether the time difference is less than the other.

__mod__(other: TimeDelta) → float

Return the remainder of the ratio between the time differences.

__mul__(value: float) → TimeDelta

Return a time difference scaled by the value.

__neg__() → TimeDelta

Return the inverse of the time difference.

__rmul__(value: float) → TimeDelta

Return a time difference scaled by the value.

__sub__(delta: TimeDelta) → TimeDelta

Return the difference between the time differences.

__truediv__(other: float | TimeDelta) → TimeDelta | float

Return a scaled time difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is float, return a time difference scaled by the inverse of the value

• If the argument is a TimeDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the time difference, expressed as the unit.

units.TimeUnit

alias of Unit

class units.Velocity(value: float, distance_unit: Unit, time_unit: Unit)

The rate of change of the displacement of an object wrt time.

__abs__() → Velocity

Return the absolute version of the velocity.

__add__(other: Velocity) → Velocity

Return the sum of two velocities.

__divmod__(other: Velocity) → tuple[float, float]

Return the quotient & remainder of the ratio between the velocities.

__eq__(other: object) → bool

Return whether the objects are equal velocities.

__floordiv__(other: Velocity) → float

Return the floored ratio between the velocities.

__ge__(other: Velocity) → bool

Return whether the velocity is greater than or equal to the other.

__gt__(other: Velocity) → bool

Return whether the velocity is greater than the other.

__hash__() → int

Return the hash of the velocity.

__init__(value: float, distance_unit: Unit, time_unit: Unit) → None

Initialise a new velocity.

__le__(other: Velocity) → bool

Return whether the velocity is less than or equal to the other.

__lt__(other: Velocity) → bool

Return whether the velocity is less than the other.

__mod__(other: Velocity) → float

Return the remainder of the ratio between the velocity.

__mul__(value: float) → Velocity

Return a velocity scaled by the value.

__neg__() → Velocity

Return the inverse of the velocity.

__rmul__(value: float) → Velocity

Return a velocity scaled by the value.

__sub__(other: Velocity) → Velocity

Return the difference of two velocities.

__truediv__(other: float | Velocity) → Velocity | float

Return a scaled velocity or the ratio between the velocities.

The behaviour depends upon the type of the argument.

• If the argument is a float, return a velocity scaled by the inverse of the value

• If the argument is a Velocity, return the ratio between the two velocities

as_unit(distance_unit: Unit, time_unit: Unit) → float

Return the velocity in the specified units.

class units.Voltage(value: float, unit: Unit)

The difference in electric potential between two points.

__abs__() → Voltage

Return the absolute version of the voltage.

__add__(other: Voltage) → Voltage

Return the sum of the voltages.

__divmod__(other: Voltage) → tuple[float, float]

Return the quotient & remainder of the ratio between the voltages.

__eq__(other: object) → bool

Return whether the objects are equal voltages.

__floordiv__(other: Voltage) → float

Return the floored ratio between the voltages.

__ge__(other: Voltage) → bool

Return whether the voltage is greater than or equal to the other.

__gt__(other: Voltage) → bool

Return whether the voltage is greater than the other.

__hash__() → int

Return the hash of the voltage.

__init__(value: float, unit: Unit) → None

Initialise a new voltage.

__le__(other: Voltage) → bool

Return whether the voltage is less than or equal to the other.

__lt__(other: Voltage) → bool

Return whether the voltage is less than the other.

__mod__(other: Voltage) → float

Return the remainder of the ratio between the voltages.

__mul__(value: float) → Voltage

Return a voltage scaled by the value.

__neg__() → Voltage

Return the inverse of the voltage.

__rmul__(value: float) → Voltage

Return a voltage scaled by the value.

__sub__(delta: Voltage) → Voltage

Return the difference between the voltages.

__truediv__(other: float | Voltage) → Voltage | float

Return a scaled voltage or the ratio between the voltages.

The behaviour depends upon the type of the argument.

• If the argument is float, return a voltage scaled by the inverse of the value

• If the argument is a Voltage, return the ratio between the two voltages

as_unit(unit: Unit) → float

Return the voltage, expressed as the unit.

units.VoltageUnit

alias of Unit

class units.Volume(value: float, unit: Unit)

The measure of a three-dimensional space.

__add__(delta: VolumeDelta) → Volume

Return the sum of the volume and the difference.

Raises:

NegativeVolumeValueError – The sum of the volume and the difference was less than 0m^3.

__eq__(other: object) → bool

Return whether the objects are equal volumes.

__ge__(other: Volume) → bool

Return whether the volume is greater than or equal to the other.

__gt__(other: Volume) → bool

Return whether the volume is greater than the other.

__hash__() → int

Return the hash of the volume.

__init__(value: float, unit: Unit) → None

Initialise a new volume.

Raises:

NegativeVolumeValueError – The negative value produced a volume less than 0m^3.

__le__(other: Volume) → bool

Return whether the volume is less than or equal to the other.

__lt__(other: Volume) → bool

Return whether the volume is less than the other.

__radd__(delta: VolumeDelta) → Volume

Return the sum of the volume and the difference.

__sub__(other: Volume | VolumeDelta) → VolumeDelta | Volume

Return the delta between volumes or the volume less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Volume, return the difference between the two volumes.

• If the argument is a VolumeDelta, return the volume less the difference.

Raises:

NegativeVolumeValueError – The volume minus the difference was less than 0m^3. Error can only be raised when other is a VolumeDelta.

as_unit(unit: Unit) → float

Return the volume, expressed as the unit.

class units.VolumeDelta(value: float, unit: Unit)

The difference between two volumes.

__abs__() → VolumeDelta

Return the absolute version of the volume difference.

__add__(other: VolumeDelta) → VolumeDelta

Return the sum of the volume differences.

__divmod__(other: VolumeDelta) → tuple[float, float]

Return the quotient & remainder of the ratio between the volume deltas.

__eq__(other: object) → bool

Return whether the objects are equal volume differences.

__floordiv__(other: VolumeDelta) → float

Return the floored ratio between the volume differences.

__ge__(other: VolumeDelta) → bool

Return whether the volume delta is greater than or equal to the other.

__gt__(other: VolumeDelta) → bool

Return whether the volume difference is greater than the other.

__hash__() → int

Return the hash of the volume difference.

__init__(value: float, unit: Unit) → None

Initialise a new volume difference.

__le__(other: VolumeDelta) → bool

Return whether the volume delta is less than or equal to the other.

__lt__(other: VolumeDelta) → bool

Return whether the volume difference is less than the other.

__mod__(other: VolumeDelta) → float

Return the remainder of the ratio between the volume differences.

__mul__(value: float) → VolumeDelta

Return a volume difference scaled by the value.

__neg__() → VolumeDelta

Return the inverse of the volume difference.

__rmul__(value: float) → VolumeDelta

Return a volume difference scaled by the value.

__sub__(delta: VolumeDelta) → VolumeDelta

Return the difference between the volume differences.

__truediv__(other: float | VolumeDelta) → VolumeDelta | float

Return a scaled volume difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is float, return a volume difference scaled by the inverse of the value

• If the argument is a VolumeDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the volume difference, expressed as the unit.

units.VolumeUnit

alias of Unit

class units.VolumetricFlowRate(value: float, volume_unit: Unit, time_unit: Unit)

The volume of a gas or liquid that flows in a certain amount of time.

__abs__() → VolumetricFlowRate

Return the absolute version of the flow rate.

__add__(other: VolumetricFlowRate) → VolumetricFlowRate

Return the sum of two flow rates.

__divmod__(other: VolumetricFlowRate) → tuple[float, float]

Return the quotient & remainder of the ratio between the flow rates.

__eq__(other: object) → bool

Return whether the objects are equal flow rates.

__floordiv__(other: VolumetricFlowRate) → float

Return the floored ratio between the flow rates.

__ge__(other: VolumetricFlowRate) → bool

Return whether the flow rate is greater than or equal to the other.

__gt__(other: VolumetricFlowRate) → bool

Return whether the flow rate is greater than the other.

__hash__() → int

Return the hash of the flow rate.

__init__(value: float, volume_unit: Unit, time_unit: Unit) → None

Initialise a new flow rate.

__le__(other: VolumetricFlowRate) → bool

Return whether the flow rate is less than or equal to the other.

__lt__(other: VolumetricFlowRate) → bool

Return whether the flow rate is less than the other.

__mod__(other: VolumetricFlowRate) → float

Return the remainder of the ratio between the flow rate.

__mul__(value: float) → VolumetricFlowRate

Return a flow rate scaled by the value.

__neg__() → VolumetricFlowRate

Return the inverse of the flow rate.

__rmul__(value: float) → VolumetricFlowRate

Return a flow rate scaled by the value.

__sub__(other: VolumetricFlowRate) → VolumetricFlowRate

Return the difference of two flow rates.

__truediv__(other: float | VolumetricFlowRate) → VolumetricFlowRate | float

Return a scaled flow rate or the ratio between the flow rates.

The behaviour depends upon the type of the argument.

• If the argument is float, return a flow rate scaled by the inverse of the value

• If the argument is a VolumetricFlowRate, return the ratio between the two flow rates

as_unit(volume_unit: Unit, time_unit: Unit) → float

Return the flow rate in the specified units.

Submodules

angle

Module for grouping angle-related classes.

class units.angle.Angle(value: float, unit: Unit)

The opening between two lines in the same plane that meet at a point.

Angle always in range [0, 2*pi) radians.

__add__(delta: AngleDelta) → Angle

Return the sum of the angle and the difference.

__eq__(other: object) → bool

Return whether the objects are equal angles.

__hash__() → int

Return the hash of the length.

__init__(value: float, unit: Unit) → None

Initialise a new angle.

Values outside of the range range [0, 2*pi) radians will be mapped into it.

Range	INITIALIZATION	EQUIVALENT TO
Within	Angle(185, Unit.DEGREE)	Angle(185, Unit.DEGREE)
Below	Angle(-3*math.pi, Unit.RADIAN)	Angle(math.pi, Unit.RADIAN)
Above	Angle(4, Unit.REVOLUTION)	Angle(0, Unit.REVOLUTION)

__radd__(delta: AngleDelta) → Angle

Return the sum of the angle and the difference.

__sub__(other: Angle | AngleDelta) → AngleDelta | Angle

Return the delta between angles or the angle less the delta.

The behaviour depends upon the type of the argument.

• If the argument is an angle, return the difference between the two angles.

• If the argument is an angle delta, return the angle less the difference.

as_unit(unit: Unit) → float

Return the angle, expressed as the unit.

class units.angle.AngleDelta(value: float, unit: Unit)

The difference between two angles.

Angle difference always in range [-pi, pi) radians.

__add__(other: AngleDelta) → AngleDelta

Return the sum of the angle differences.

__eq__(other: object) → bool

Return whether the objects are equal angle differences.

__hash__() → int

Return the hash of the angle difference.

__init__(value: float, unit: Unit) → None

Initialise a new angle difference.

Values outside the range [-pi, pi) radians will be mapped into it.

Range	INITIALIZATION	EQUIVALENT TO
Within	AngleDelta(-40, Unit.DEGREE)	AngleDelta(-40, Unit.DEGREE)
Below	AngleDelta(-3*pi, Unit.RADIAN)	AngleDelta(pi, Unit.RADIAN)
Above	AngleDelta(3.75, Unit.REVOLUTION)	AngleDelta(-0.25, Unit.REVOLUTION)

__neg__() → AngleDelta

Return the inverse of the angle difference.

__sub__(delta: AngleDelta) → AngleDelta

Return the difference between the angle differences.

as_unit(unit: Unit) → float

Return the angle difference, expressed as the unit.

class units.angle.Unit

A angle unit.

NB: Micropython does not yet support enums. The desired behaviour (enumerated options embedded in the type system) can be mostly replicated by substituting IntEnum for object at runtime, which is what has been done here.

DEGREE = 2

RADIAN = 1

REVOLUTION = 3

angular_motion

Module for grouping angular-motion-related classes and constants.

class units.angular_motion.Acceleration(value: float, angle_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None)

The rate of change of the angular velocity of an object wrt time.

__abs__() → Acceleration

Return the absolute version of the angular acceleration.

__add__(other: Acceleration) → Acceleration

Return the sum of two angular accelerations.

__divmod__(other: Acceleration) → tuple[float, float]

Return the quotient & remainder of the ratio tbwn angular accelerations.

__eq__(other: object) → bool

Return whether the objects are equal angular accelerations.

__floordiv__(other: Acceleration) → float

Return the floored ratio between the angular accelerations.

__ge__(other: Acceleration) → bool

Return whether the angular acceleration is greater than or equal to other.

__gt__(other: Acceleration) → bool

Return whether the angular acceleration is greater than the other.

__hash__() → int

Return the hash of the angular acceleration.

__init__(value: float, angle_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None) → None

Initialise a new angular acceleration.

If a second time unit is not provided, the first time unit will be reused.

__le__(other: Acceleration) → bool

Return whether the angular acceleration is less than or equal to other.

__lt__(other: Acceleration) → bool

Return whether the angular acceleration is less than the other.

__mod__(other: Acceleration) → float

Return the remainder of the ratio between the angular acceleration.

__mul__(value: float) → Acceleration

Return an angular acceleration scaled by the value.

__neg__() → Acceleration

Return the inverse of the angular acceleration.

__rmul__(value: float) → Acceleration

Return an angular acceleration scaled by the value.

__sub__(other: Acceleration) → Acceleration

Return the difference of two angular accelerations.

__truediv__(other: float | Acceleration) → Acceleration | float

Return a scaled angular acceleration or the ratio between the accelerations.

The behaviour depends upon the type of the argument.

• If the argument is a float, return an angular acceleration scaled by the inverse of the value

• If the argument is a Acceleration, return the ratio between the two angular accelerations

as_unit(angle_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None) → float

Return the angular acceleration in the specified units.

If a second time unit is not provided, the first time unit will be reused.

units.angular_motion.AngleUnit

alias of Unit

class units.angular_motion.Displacement(value: float, unit: Unit)

The difference between the final & initial position of an angular trajectory.

__abs__() → Displacement

Return the absolute version of the angular displacement.

__add__(other: Displacement) → Displacement

Return the sum of the angular displacements.

__divmod__(other: Displacement) → tuple[float, float]

Return the quotient & remainder of the ratio btwn the displacements.

__eq__(other: object) → bool

Return whether the objects are equal angular displacements.

__floordiv__(other: Displacement) → float

Return the floored ratio between the angular displacements.

__ge__(other: Displacement) → bool

Return whether the angular displacement is greater than or equal to other.

__gt__(other: Displacement) → bool

Return whether the angular displacement is greater than the other.

__hash__() → int

Return the hash of the angular displacement.

__init__(value: float, unit: Unit) → None

Initialise a new angular displacement.

__le__(other: Displacement) → bool

Return whether the angular displacement is less than or equal to other.

__lt__(other: Displacement) → bool

Return whether the angular displacement is less than the other.

__mod__(other: Displacement) → float

Return the remainder of the ratio between the angular displacements.

__mul__(value: float) → Displacement

Return a angular displacement scaled by the value.

__neg__() → Displacement

Return the inverse of the angular displacement.

__rmul__(value: float) → Displacement

Return a angular displacement scaled by the value.

__sub__(delta: Displacement) → Displacement

Return the difference between the angular displacements.

__truediv__(other: float | Displacement) → Displacement | float

Return a scaled angular displacement or the ratio between the displacements.

The behaviour depends upon the type of the argument.

• If the argument is scalar, return a angular displacement scaled by the inverse of the value

• If the argument is a angular displacement, return the ratio between the two angular displacements

as_unit(unit: Unit) → float

Return the angular displacement, expressed as the unit.

class units.angular_motion.Jerk(value: float, angle_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None, third_time_unit: Unit | None = None)

The rate of change of the angular jerk of an object with respect to time.

__abs__() → Jerk

Return the absolute version of the angular jerk.

__add__(other: Jerk) → Jerk

Return the sum of two angular jerks.

__divmod__(other: Jerk) → tuple[float, float]

Return the quotient & remainder of the ratio between the angular jerks.

__eq__(other: object) → bool

Return whether the objects are equal angular jerks.

__floordiv__(other: Jerk) → float

Return the floored ratio between the angular jerks.

__ge__(other: Jerk) → bool

Return whether the angular jerk is greater than or equal to the other.

__gt__(other: Jerk) → bool

Return whether the angular jerk is greater than the other.

__hash__() → int

Return the hash of the angular jerk.

__init__(value: float, angle_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None, third_time_unit: Unit | None = None) → None

Initialise a new angular jerk.

If a second time unit is not provided, the first time unit will be reused. If the third time unit is not provided, the second time unit will be reused (or the first, if the second is also not provided).

__le__(other: Jerk) → bool

Return whether the angular jerk is less than or equal to the other.

__lt__(other: Jerk) → bool

Return whether the angular jerk is less than the other.

__mod__(other: Jerk) → float

Return the remainder of the ratio between the angular jerk.

__mul__(value: float) → Jerk

Return an angular jerk scaled by the value.

__neg__() → Jerk

Return the inverse of the angular jerk.

__rmul__(value: float) → Jerk

Return an angular jerk scaled by the value.

__sub__(other: Jerk) → Jerk

Return the difference of two angular jerks.

__truediv__(other: float | Jerk) → Jerk | float

Return a scaled angular jerk or the ratio between the angular jerks.

The behaviour depends upon the type of the argument.

• If the argument is a float, return an angular jerk scaled by the inverse of the value

• If the argument is a Jerk, return the ratio between the two angular jerks

as_unit(angle_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None, third_time_unit: Unit | None = None) → float

Return the angular jerk in the specified units.

If a second time unit is not provided, the first time unit will be reused. If the third time unit is not provided, the second time unit will be reused (or the first, if the second is also not provided).

units.angular_motion.TimeUnit

alias of Unit

class units.angular_motion.Velocity(value: float, angle_unit: Unit, time_unit: Unit)

The rate of change of the angular displacement of an object wrt time.

__abs__() → Velocity

Return the absolute version of the angular velocity.

__add__(other: Velocity) → Velocity

Return the sum of two angular velocities.

__divmod__(other: Velocity) → tuple[float, float]

Return the quotient & remainder of the ratio between the velocities.

__eq__(other: object) → bool

Return whether the objects are equal angular velocities.

__floordiv__(other: Velocity) → float

Return the floored ratio between the angular velocities.

__ge__(other: Velocity) → bool

Return whether the angular velocity is greater than or equal to the other.

__gt__(other: Velocity) → bool

Return whether the angular velocity is greater than the other.

__hash__() → int

Return the hash of the angular velocity.

__init__(value: float, angle_unit: Unit, time_unit: Unit) → None

Initialise a new angular velocity.

__le__(other: Velocity) → bool

Return whether the angular velocity is less than or equal to the other.

__lt__(other: Velocity) → bool

Return whether the angular velocity is less than the other.

__mod__(other: Velocity) → float

Return the remainder of the ratio between the angular velocity.

__mul__(value: float) → Velocity

Return a angular velocity scaled by the value.

__neg__() → Velocity

Return the inverse of the angular velocity.

__rmul__(value: float) → Velocity

Return a angular velocity scaled by the value.

__sub__(other: Velocity) → Velocity

Return the difference of two angular velocities.

__truediv__(other: float | Velocity) → Velocity | float

Return a scaled angular velocity or the ratio between the angular velocities.

The behaviour depends upon the type of the argument.

• If the argument is float, return a angular velocity scaled by the inverse of the value

• If the argument is a Velocity, return the ratio between the two angular velocities

as_unit(angle_unit: Unit, time_unit: Unit) → float

Return the angular velocity in the specified units.

area

Module for grouping area-related classes and constants.

class units.area.Area(value: float, unit: Unit)

The measure of a two-dimensional space.

__add__(delta: AreaDelta) → Area

Return the sum of the area and the difference.

Raises:

NegativeAreaValueError – The sum of the area and the difference was less than 0m^2.

__eq__(other: object) → bool

Return whether the objects are equal areas.

__ge__(other: Area) → bool

Return whether the area is greater than or equal to the other.

__gt__(other: Area) → bool

Return whether the area is greater than the other.

__hash__() → int

Return the hash of the area.

__init__(value: float, unit: Unit) → None

Initialise a new area.

Raises:

NegativeAreaValueError – The negative value produced an area less than 0m^2.

__le__(other: Area) → bool

Return whether the area is less than or equal to the other.

__lt__(other: Area) → bool

Return whether the area is less than the other.

__radd__(delta: AreaDelta) → Area

Return the sum of the area and the difference.

__sub__(other: Area | AreaDelta) → AreaDelta | Area

Return the delta between two areas or the area less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Area, return the difference between the two areas.

• If the argument is a AreaDelta, return the area less the difference.

Raises:

NegativeAreaValueError – The area minus the difference was less than 0m^2. Error can only be raised when other is an AreaDelta.

as_unit(unit: Unit) → float

Return the area, expressed as the unit.

class units.area.AreaDelta(value: float, unit: Unit)

The difference between two areas.

__abs__() → AreaDelta

Return the absolute version of the area difference.

__add__(other: AreaDelta) → AreaDelta

Return the sum of the area differences.

__divmod__(other: AreaDelta) → tuple[float, float]

Return the quotient & remainder of the ratio between the area deltas.

__eq__(other: object) → bool

Return whether the objects are equal area differences.

__floordiv__(other: AreaDelta) → float

Return the floored ratio between the area differences.

__ge__(other: AreaDelta) → bool

Return whether the area delta is greater than or equal to the other.

__gt__(other: AreaDelta) → bool

Return whether the area difference is greater than the other.

__hash__() → int

Return the hash of the area difference.

__init__(value: float, unit: Unit) → None

Initialise a new area difference.

__le__(other: AreaDelta) → bool

Return whether the area delta is less than or equal to the other.

__lt__(other: AreaDelta) → bool

Return whether the area difference is less than the other.

__mod__(other: AreaDelta) → float

Return the remainder of the ratio between the area differences.

__mul__(value: float) → AreaDelta

Return a area difference scaled by the value.

__neg__() → AreaDelta

Return the inverse of the area difference.

__rmul__(value: float) → AreaDelta

Return a area difference scaled by the value.

__sub__(delta: AreaDelta) → AreaDelta

Return the difference between the area differences.

__truediv__(other: float | AreaDelta) → AreaDelta | float

Return a scaled area difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is float, return a area difference scaled by the inverse of the value

• If the argument is a AreaDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the area difference, expressed as the unit.

exception units.area.NegativeAreaValueError(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the area value is negative.

The minimum area that can exist is 0 m^2, so an area with a negative value, regardless of the unit, is impossible.

__init__(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new negative-area exception.

property value: float

The area value that caused the error.

class units.area.Unit

An area unit.

NB: Micropython does not yet support enums. The desired behaviour (enumerated options embedded in the type system) can be mostly replicated by substituting IntEnum for object at runtime, which is what has been done here.

SQUARE_CENTIMETRE = 2

SQUARE_FOOT = 5

SQUARE_INCH = 6

SQUARE_METRE = 1

SQUARE_MILLIMETRE = 3

SQUARE_YARD = 4

units.area.ZERO = Area(0, Unit.SQUARE_METRE)

Zero area constant.

current

Module for grouping current-related classes.

class units.current.Current(value: float, unit: Unit)

The flow of charged particles through an electrical conductor.

__abs__() → Current

Return the absolute version of the current.

__add__(other: Current) → Current

Return the sum of the currents.

__divmod__(other: Current) → tuple[float, float]

Return the quotient & remainder of the ratio between the currents.

__eq__(other: object) → bool

Return whether the objects are equal currents.

__floordiv__(other: Current) → float

Return the floored ratio between the currents.

__ge__(other: Current) → bool

Return whether the current is greater than or equal to the other.

__gt__(other: Current) → bool

Return whether the current is greater than the other.

__hash__() → int

Return the hash of the current.

__init__(value: float, unit: Unit) → None

Initialise a new current.

__le__(other: Current) → bool

Return whether the current is less than or equal to the other.

__lt__(other: Current) → bool

Return whether the current is less than the other.

__mod__(other: Current) → float

Return the remainder of the ratio between the currents.

__mul__(value: float) → Current

Return a current scaled by the value.

__neg__() → Current

Return the inverse of the current.

__rmul__(value: float) → Current

Return a current scaled by the value.

__sub__(delta: Current) → Current

Return the difference between the currents.

__truediv__(other: float | Current) → Current | float

Return a scaled current or the ratio between the currents.

The behaviour depends upon the type of the argument.

• If the argument is float, return a current scaled by the inverse of the value

• If the argument is a Current, return the ratio between the two currents

as_unit(unit: Unit) → float

Return the current, expressed as the unit.

class units.current.Unit

A current unit.

NB: Micropython does not yet support enums. The desired behaviour (enumerated options embedded in the type system) can be mostly replicated by substituting IntEnum for object at runtime, which is what has been done here.

AMPERE = 1

MICROAMPERE = 3

MILLIAMPERE = 2

flow_rate

Module for grouping flow-rate-related classes and constants.

class units.flow_rate.MassFlowRate(value: float, mass_unit: Unit, time_unit: Unit)

The mass of a gas or liquid that flows in a certain amount of time.

__abs__() → MassFlowRate

Return the absolute version of the flow rate.

__add__(other: MassFlowRate) → MassFlowRate

Return the sum of two flow rates.

__divmod__(other: MassFlowRate) → tuple[float, float]

Return the quotient & remainder of the ratio between the flow rates.

__eq__(other: object) → bool

Return whether the objects are equal flow rates.

__floordiv__(other: MassFlowRate) → float

Return the floored ratio between the flow rates.

__ge__(other: MassFlowRate) → bool

Return whether the flow rate is greater than or equal to the other.

__gt__(other: MassFlowRate) → bool

Return whether the flow rate is greater than the other.

__hash__() → int

Return the hash of the flow rate.

__init__(value: float, mass_unit: Unit, time_unit: Unit) → None

Initialise a new flow rate.

__le__(other: MassFlowRate) → bool

Return whether the flow rate is less than or equal to the other.

__lt__(other: MassFlowRate) → bool

Return whether the flow rate is less than the other.

__mod__(other: MassFlowRate) → float

Return the remainder of the ratio between the flow rate.

__mul__(value: float) → MassFlowRate

Return a flow rate scaled by the value.

__neg__() → MassFlowRate

Return the inverse of the flow rate.

__rmul__(value: float) → MassFlowRate

Return a flow rate scaled by the value.

__sub__(other: MassFlowRate) → MassFlowRate

Return the difference of two flow rates.

__truediv__(other: float | MassFlowRate) → MassFlowRate | float

Return a scaled flow rate or the ratio between the flow rates.

The behaviour depends upon the type of the argument.

• If the argument is a float, return a flow rate scaled by the inverse of the value

• If the argument is a MassFlowRate, return the ratio between the two flow rates

as_unit(mass_unit: Unit, time_unit: Unit) → float

Return the flow rate in the specified units.

units.flow_rate.MassUnit

alias of Unit

units.flow_rate.TimeUnit

alias of Unit

units.flow_rate.VolumeUnit

alias of Unit

class units.flow_rate.VolumetricFlowRate(value: float, volume_unit: Unit, time_unit: Unit)

The volume of a gas or liquid that flows in a certain amount of time.

__abs__() → VolumetricFlowRate

Return the absolute version of the flow rate.

__add__(other: VolumetricFlowRate) → VolumetricFlowRate

Return the sum of two flow rates.

__divmod__(other: VolumetricFlowRate) → tuple[float, float]

Return the quotient & remainder of the ratio between the flow rates.

__eq__(other: object) → bool

Return whether the objects are equal flow rates.

__floordiv__(other: VolumetricFlowRate) → float

Return the floored ratio between the flow rates.

__ge__(other: VolumetricFlowRate) → bool

Return whether the flow rate is greater than or equal to the other.

__gt__(other: VolumetricFlowRate) → bool

Return whether the flow rate is greater than the other.

__hash__() → int

Return the hash of the flow rate.

__init__(value: float, volume_unit: Unit, time_unit: Unit) → None

Initialise a new flow rate.

__le__(other: VolumetricFlowRate) → bool

Return whether the flow rate is less than or equal to the other.

__lt__(other: VolumetricFlowRate) → bool

Return whether the flow rate is less than the other.

__mod__(other: VolumetricFlowRate) → float

Return the remainder of the ratio between the flow rate.

__mul__(value: float) → VolumetricFlowRate

Return a flow rate scaled by the value.

__neg__() → VolumetricFlowRate

Return the inverse of the flow rate.

__rmul__(value: float) → VolumetricFlowRate

Return a flow rate scaled by the value.

__sub__(other: VolumetricFlowRate) → VolumetricFlowRate

Return the difference of two flow rates.

__truediv__(other: float | VolumetricFlowRate) → VolumetricFlowRate | float

Return a scaled flow rate or the ratio between the flow rates.

The behaviour depends upon the type of the argument.

• If the argument is float, return a flow rate scaled by the inverse of the value

• If the argument is a VolumetricFlowRate, return the ratio between the two flow rates

as_unit(volume_unit: Unit, time_unit: Unit) → float

Return the flow rate in the specified units.

length

Module for grouping length-related classes and constants.

class units.length.Length(value: float, unit: Unit)

The measure of distance.

__add__(delta: LengthDelta) → Length

Return the sum of the length and the difference.

Raises:

NegativeLengthValueError – The sum of the length and the difference was less than 0m.

__eq__(other: object) → bool

Return whether the objects are equal lengths.

__ge__(other: Length) → bool

Return whether the length is greater than or equal to the other.

__gt__(other: Length) → bool

Return whether the length is greater than the other.

__hash__() → int

Return the hash of the length.

__init__(value: float, unit: Unit) → None

Initialise a new length.

Raises:

NegativeLengthValueError – The negative value produced a length less than 0m.

__le__(other: Length) → bool

Return whether the length is less than or equal to the other.

__lt__(other: Length) → bool

Return whether the length is less than the other.

__radd__(delta: LengthDelta) → Length

Return the sum of the length and the difference.

__sub__(other: Length | LengthDelta) → LengthDelta | Length

Return the delta between lengths or the length less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Length, return the difference between the two lengths.

• If the argument is a LengthDelta, return the length less the difference.

Raises:

NegativeLengthValueError – The length minus the difference was less than 0m. Error can only be raised when other is a LengthDelta.

as_unit(unit: Unit) → float

Return the length, expressed as the unit.

class units.length.LengthDelta(value: float, unit: Unit)

The difference between two lengths.

__abs__() → LengthDelta

Return the absolute version of the length difference.

__add__(other: LengthDelta) → LengthDelta

Return the sum of the length differences.

__divmod__(other: LengthDelta) → tuple[float, float]

Return the quotient & remainder of the ratio between the length deltas.

__eq__(other: object) → bool

Return whether the objects are equal length differences.

__floordiv__(other: LengthDelta) → float

Return the floored ratio between the length differences.

__ge__(other: LengthDelta) → bool

Return whether the length delta is greater than or equal to the other.

__gt__(other: LengthDelta) → bool

Return whether the length difference is greater than the other.

__hash__() → int

Return the hash of the length difference.

__init__(value: float, unit: Unit) → None

Initialise a new length difference.

__le__(other: LengthDelta) → bool

Return whether the length difference is less than or equal to the other.

__lt__(other: LengthDelta) → bool

Return whether the length difference is less than the other.

__mod__(other: LengthDelta) → float

Return the remainder of the ratio between the length differences.

__mul__(value: float) → LengthDelta

Return a length difference scaled by the value.

__neg__() → LengthDelta

Return the inverse of the length difference.

__rmul__(value: float) → LengthDelta

Return a length difference scaled by the value.

__sub__(delta: LengthDelta) → LengthDelta

Return the difference between the length differences.

__truediv__(other: float | LengthDelta) → LengthDelta | float

Return a scaled length difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is float, return a length difference scaled by the inverse of the value

• If the argument is a LengthDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the length difference, expressed as the unit.

exception units.length.NegativeLengthValueError(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the length value is negative.

The minimum length that can exist is 0m, so a length with a negative value, regardless of the unit, is impossible.

__init__(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new negative-length exception.

property value: float

The length value that caused the error.

class units.length.Unit

A distance unit.

NB: Micropython does not yet support enums. The desired behaviour (enumerated options embedded in the type system) can be mostly replicated by substituting IntEnum for object at runtime, which is what has been done here.

CENTIMETRE = 2

FOOT = 5

INCH = 6

METRE = 1

MILLIMETRE = 3

YARD = 4

units.length.ZERO = Length(0, Unit.METRE)

Zero length constant.

linear_motion

Module for grouping linear-motion-related classes and constants.

class units.linear_motion.Acceleration(value: float, distance_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None)

The rate of change of the velocity of an object with respect to time.

__abs__() → Acceleration

Return the absolute version of the acceleration.

__add__(other: Acceleration) → Acceleration

Return the sum of two accelerations.

__divmod__(other: Acceleration) → tuple[float, float]

Return the quotient & remainder of the ratio between the accelerations.

__eq__(other: object) → bool

Return whether the objects are equal accelerations.

__floordiv__(other: Acceleration) → float

Return the floored ratio between the accelerations.

__ge__(other: Acceleration) → bool

Return whether the acceleration is greater than or equal to the other.

__gt__(other: Acceleration) → bool

Return whether the acceleration is greater than the other.

__hash__() → int

Return the hash of the acceleration.

__init__(value: float, distance_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None) → None

Initialise a new acceleration.

If a second time unit is not provided, the first time unit will be reused.

__le__(other: Acceleration) → bool

Return whether the acceleration is less than or equal to the other.

__lt__(other: Acceleration) → bool

Return whether the acceleration is less than the other.

__mod__(other: Acceleration) → float

Return the remainder of the ratio between the acceleration.

__mul__(value: float) → Acceleration

Return an acceleration scaled by the value.

__neg__() → Acceleration

Return the inverse of the acceleration.

__rmul__(value: float) → Acceleration

Return an acceleration scaled by the value.

__sub__(other: Acceleration) → Acceleration

Return the difference of two accelerations.

__truediv__(other: float | Acceleration) → Acceleration | float

Return a scaled acceleration or the ratio between the accelerations.

The behaviour depends upon the type of the argument.

• If the argument is a float, return an acceleration scaled by the inverse of the value

• If the argument is a Acceleration, return the ratio between the two accelerations

as_unit(distance_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None) → float

Return the acceleration in the specified units.

If a second time unit is not provided, the first time unit will be reused.

class units.linear_motion.Displacement(value: float, unit: Unit)

The difference between the final and initial position of a trajectory.

__abs__() → Displacement

Return the absolute version of the displacement.

__add__(other: Displacement) → Displacement

Return the sum of the displacements.

__divmod__(other: Displacement) → tuple[float, float]

Return the quotient & remainder of the ratio between the displacements.

__eq__(other: object) → bool

Return whether the objects are equal displacements.

__floordiv__(other: Displacement) → float

Return the floored ratio between the displacements.

__ge__(other: Displacement) → bool

Return whether the displacement is greater than or equal to the other.

__gt__(other: Displacement) → bool

Return whether the displacement is greater than the other.

__hash__() → int

Return the hash of the displacement.

__init__(value: float, unit: Unit) → None

Initialise a new displacement.

__le__(other: Displacement) → bool

Return whether the displacement is less than or equal to the other.

__lt__(other: Displacement) → bool

Return whether the displacement is less than the other.

__mod__(other: Displacement) → float

Return the remainder of the ratio between the displacements.

__mul__(value: float) → Displacement

Return a displacement scaled by the value.

__neg__() → Displacement

Return the inverse of the displacement.

__rmul__(value: float) → Displacement

Return a displacement scaled by the value.

__sub__(delta: Displacement) → Displacement

Return the difference between the displacements.

__truediv__(other: float | Displacement) → Displacement | float

Return a scaled displacement or the ratio between the displacements.

The behaviour depends upon the type of the argument.

• If the argument is a float, return a displacement scaled by the inverse of the value

• If the argument is a Displacement, return the ratio between the two displacements

as_unit(unit: Unit) → float

Return the displacement, expressed as the unit.

units.linear_motion.DistanceUnit

alias of Unit

class units.linear_motion.Jerk(value: float, distance_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None, third_time_unit: Unit | None = None)

The rate of change of the jerk of an object with respect to time.

__abs__() → Jerk

Return the absolute version of the jerk.

__add__(other: Jerk) → Jerk

Return the sum of two jerks.

__divmod__(other: Jerk) → tuple[float, float]

Return the quotient & remainder of the ratio between the jerks.

__eq__(other: object) → bool

Return whether the objects are equal jerks.

__floordiv__(other: Jerk) → float

Return the floored ratio between the jerks.

__ge__(other: Jerk) → bool

Return whether the jerk is greater than or equal to the other.

__gt__(other: Jerk) → bool

Return whether the jerk is greater than the other.

__hash__() → int

Return the hash of the jerk.

__init__(value: float, distance_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None, third_time_unit: Unit | None = None) → None

Initialise a new jerk.

If a second time unit is not provided, the first time unit will be reused. If the third time unit is not provided, the second time unit will be reused (or the first, if the second is also not provided).

__le__(other: Jerk) → bool

Return whether the jerk is less than or equal to the other.

__lt__(other: Jerk) → bool

Return whether the jerk is less than the other.

__mod__(other: Jerk) → float

Return the remainder of the ratio between the jerk.

__mul__(value: float) → Jerk

Return an jerk scaled by the value.

__neg__() → Jerk

Return the inverse of the jerk.

__rmul__(value: float) → Jerk

Return an jerk scaled by the value.

__sub__(other: Jerk) → Jerk

Return the difference of two jerks.

__truediv__(other: float | Jerk) → Jerk | float

Return a scaled jerk or the ratio between the jerks.

The behaviour depends upon the type of the argument.

• If the argument is a float, return an jerk scaled by the inverse of the value

• If the argument is a Jerk, return the ratio between the two jerks

as_unit(distance_unit: Unit, first_time_unit: Unit, second_time_unit: Unit | None = None, third_time_unit: Unit | None = None) → float

Return the jerk in the specified units.

If a second time unit is not provided, the first time unit will be reused. If the third time unit is not provided, the second time unit will be reused (or the first, if the second is also not provided).

units.linear_motion.TimeUnit

alias of Unit

class units.linear_motion.Velocity(value: float, distance_unit: Unit, time_unit: Unit)

The rate of change of the displacement of an object wrt time.

__abs__() → Velocity

Return the absolute version of the velocity.

__add__(other: Velocity) → Velocity

Return the sum of two velocities.

__divmod__(other: Velocity) → tuple[float, float]

Return the quotient & remainder of the ratio between the velocities.

__eq__(other: object) → bool

Return whether the objects are equal velocities.

__floordiv__(other: Velocity) → float

Return the floored ratio between the velocities.

__ge__(other: Velocity) → bool

Return whether the velocity is greater than or equal to the other.

__gt__(other: Velocity) → bool

Return whether the velocity is greater than the other.

__hash__() → int

Return the hash of the velocity.

__init__(value: float, distance_unit: Unit, time_unit: Unit) → None

Initialise a new velocity.

__le__(other: Velocity) → bool

Return whether the velocity is less than or equal to the other.

__lt__(other: Velocity) → bool

Return whether the velocity is less than the other.

__mod__(other: Velocity) → float

Return the remainder of the ratio between the velocity.

__mul__(value: float) → Velocity

Return a velocity scaled by the value.

__neg__() → Velocity

Return the inverse of the velocity.

__rmul__(value: float) → Velocity

Return a velocity scaled by the value.

__sub__(other: Velocity) → Velocity

Return the difference of two velocities.

__truediv__(other: float | Velocity) → Velocity | float

Return a scaled velocity or the ratio between the velocities.

The behaviour depends upon the type of the argument.

• If the argument is a float, return a velocity scaled by the inverse of the value

• If the argument is a Velocity, return the ratio between the two velocities

as_unit(distance_unit: Unit, time_unit: Unit) → float

Return the velocity in the specified units.

mass

Module for grouping mass-related classes and constants.

class units.mass.Mass(value: float, unit: Unit)

The force applied per unit area over which that force is distributed.

__add__(delta: MassDelta) → Mass

Return the sum of the mass and the difference.

Raises:

NegativeMassValueError – The sum of the mass and the difference was less than 0kg.

__eq__(other: object) → bool

Return whether the objects are equal masses.

__ge__(other: Mass) → bool

Return whether the mass is greater than or equal to the other.

__gt__(other: Mass) → bool

Return whether the mass is greater than the other.

__hash__() → int

Return the hash of the mass.

__init__(value: float, unit: Unit) → None

Initialise a new mass.

Raises:

NegativeMassValueError – The negative value produced a mass less than 0kg.

__le__(other: Mass) → bool

Return whether the mass is less than or equal to the other.

__lt__(other: Mass) → bool

Return whether the mass is less than the other.

__radd__(delta: MassDelta) → Mass

Return the sum of the mass and the difference.

__sub__(other: Mass | MassDelta) → MassDelta | Mass

Return the delta between mass or the mass less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Mass, return the difference between the two masses.

• If the argument is a MassDelta, return the mass less the difference.

Raises:

NegativeMassValueError – The mass minus the difference was less than 0kg. Only possible when other is a MassDelta.

as_unit(unit: Unit) → float

Return the mass, expressed as the unit.

class units.mass.MassDelta(value: float, unit: Unit)

The difference between two masses.

__abs__() → MassDelta

Return the absolute version of the mass difference.

__add__(other: MassDelta) → MassDelta

Return the sum of the mass differences.

__divmod__(other: MassDelta) → tuple[float, float]

Return the quotient & remainder of the ratio between the mass deltas.

__eq__(other: object) → bool

Return whether the objects are equal mass differences.

__floordiv__(other: MassDelta) → float

Return the floored ratio between the mass differences.

__ge__(other: MassDelta) → bool

Return whether the mass delta is greater than or equal to the other.

__gt__(other: MassDelta) → bool

Return whether the mass difference is greater than the other.

__hash__() → int

Return the hash of the mass difference.

__init__(value: float, unit: Unit) → None

Initialise a new mass difference.

__le__(other: MassDelta) → bool

Return whether the mass delta is less than or equal to the other.

__lt__(other: MassDelta) → bool

Return whether the mass difference is less than the other.

__mod__(other: MassDelta) → float

Return the remainder of the ratio between the mass differences.

__mul__(value: float) → MassDelta

Return a mass difference scaled by the value.

__neg__() → MassDelta

Return the inverse of the mass difference.

__rmul__(value: float) → MassDelta

Return a mass difference scaled by the value.

__sub__(delta: MassDelta) → MassDelta

Return the difference between the mass differences.

__truediv__(other: float | MassDelta) → MassDelta | float

Return a scaled mass difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is a float, return a mass difference scaled by the inverse of the value

• If the argument is a MassDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the mass difference, expressed as the unit.

exception units.mass.NegativeMassValueError(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the mass value is negative.

The minimum mass that can exist is 0 kg, so a mass with a negative value, regardless of the unit, is impossible.

__init__(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new negative-mass exception.

property value: float

The mass value that caused the error.

class units.mass.Unit

A mass unit.

NB: Micropython does not yet support enums. The desired behaviour (enumerated options embedded in the type system) can be mostly replicated by substituting IntEnum for object at runtime, which is what has been done here.

GRAM = 2

KILOGRAM = 1

MILLIGRAM = 3

OUNCE = 5

POUND = 4

units.mass.ZERO = Mass(0, Unit.KILOGRAM)

Zero mass constant.

pressure

Module for grouping pressure-related classes and constants.

exception units.pressure.NegativePressureValueError(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the pressure value is negative.

The minimum pressure that can exist is a perfect vacuum (0 Pa), so a pressure with a negative value, regardless of the unit, is impossible.

__init__(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new negative-pressure exception.

property value: float

The pressure value that caused the error.

class units.pressure.Pressure(value: float, unit: Unit)

The force applied per unit area over which that force is distributed.

__add__(delta: PressureDelta) → Pressure

Return the sum of the pressure and the difference.

Raises:

NegativePressureValueError – The sum of the pressure and the difference was less than 0Pa.

__eq__(other: object) → bool

Return whether the objects are equal pressures.

__ge__(other: Pressure) → bool

Return whether the pressure is greater than or equal to the other.

__gt__(other: Pressure) → bool

Return whether the pressure is greater than the other.

__hash__() → int

Return the hash of the pressure.

__init__(value: float, unit: Unit) → None

Initialise a new pressure.

Raises:

NegativePressureValueError – The negative value produced a pressure less than 0Pa.

__le__(other: Pressure) → bool

Return whether the pressure is less than or equal to the other.

__lt__(other: Pressure) → bool

Return whether the pressure is less than the other.

__radd__(delta: PressureDelta) → Pressure

Return the sum of the pressure and the difference.

__sub__(other: Pressure | PressureDelta) → PressureDelta | Pressure

Return the delta between pressures or the pressure less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Pressure, return the difference between the two pressures.

• If the argument is a PressureDelta, return the pressure less the difference.

Raises:

NegativePressureValueError – The pressure minus the difference was less than 0Pa. Error can only be raised when other is a PressureDelta.

as_unit(unit: Unit) → float

Return the pressure, expressed as the unit.

class units.pressure.PressureDelta(value: float, unit: Unit)

The difference between two pressures.

__abs__() → PressureDelta

Return the absolute version of the pressure difference.

__add__(other: PressureDelta) → PressureDelta

Return the sum of the pressure differences.

__divmod__(other: PressureDelta) → tuple[float, float]

Return the quotient & remainder of the ratio between the pressure deltas.

__eq__(other: object) → bool

Return whether the objects are equal pressure differences.

__floordiv__(other: PressureDelta) → float

Return the floored ratio between the pressure differences.

__ge__(other: PressureDelta) → bool

Return whether the pressure delta is greater than or equal to the other.

__gt__(other: PressureDelta) → bool

Return whether the pressure difference is greater than the other.

__hash__() → int

Return the hash of the pressure difference.

__init__(value: float, unit: Unit) → None

Initialise a new pressure difference.

__le__(other: PressureDelta) → bool

Return whether the pressure delta is less than or equal to the other.

__lt__(other: PressureDelta) → bool

Return whether the pressure difference is less than the other.

__mod__(other: PressureDelta) → float

Return the remainder of the ratio between the pressure differences.

__mul__(value: float) → PressureDelta

Return a pressure difference scaled by the value.

__neg__() → PressureDelta

Return the inverse of the pressure difference.

__rmul__(value: float) → PressureDelta

Return a pressure difference scaled by the value.

__sub__(delta: PressureDelta) → PressureDelta

Return the difference between the pressure differences.

__truediv__(other: float | PressureDelta) → PressureDelta | float

Return a scaled pressure difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is float, return a pressure difference scaled by the inverse of the value

• If the argument is a PressureDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the pressure difference, expressed as the unit.

class units.pressure.Unit

A pressure unit.

NB: Micropython does not yet support enums. The desired behaviour (enumerated options embedded in the type system) can be mostly replicated by substituting IntEnum for object at runtime, which is what has been done here.

ATMOSPHERE = 4

BAR = 3

KILOPASCAL = 6

MILLIBAR = 7

MILLIMETRE_OF_MERCURY = 5

PASCAL = 1

POUND_PER_SQUARE_INCH = 2

units.pressure.PERFECT_VACUUM = Pressure(0, Unit.PASCAL)

Perfect vacuum pressure constant.

units.pressure.STANDARD_ATMOSPHERE = Pressure(101325, Unit.PASCAL)

Standard atmospheric pressure constant.

temperature

Module for grouping temperature-related classes and constants.

exception units.temperature.BelowAbsoluteZeroError(value: float, unit: Unit, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the temperature would be less than absolute zero.

The minimum temperature that can exist is absolute zero (0 K), so a temperature less than this is impossible.

__init__(value: float, unit: Unit, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new below-absolute-zero exception.

property unit: Unit

The temperature unit that caused the error.

property value: float

The temperature value that caused the error.

class units.temperature.Temperature(value: float, unit: Unit)

Quantitatively expresses the attribute of hotness or coldness.

__add__(delta: TemperatureDelta) → Temperature

Return the sum of the temperature and the difference.

Raises:

BelowAbsoluteZeroError – The sum of the temperature and the difference was less than absolute zero.

__eq__(other: object) → bool

Return whether the objects are equal temperatures.

__ge__(other: Temperature) → bool

Return whether the temperature is greater than or equal to the other.

__gt__(other: Temperature) → bool

Return whether the temperature is greater than the other.

__hash__() → int

Return the hash of the temperature.

__init__(value: float, unit: Unit) → None

Initialise a new temperature.

Raises:

BelowAbsoluteZeroError – The value and unit produced an invalid temperature less than absolute zero.

__le__(other: Temperature) → bool

Return whether the temperature is less than or equal to the other.

__lt__(other: Temperature) → bool

Return whether the temperature is less than the other.

__radd__(delta: TemperatureDelta) → Temperature

Return the sum of the temperature and the difference.

__sub__(other: Temperature | TemperatureDelta) → TemperatureDelta | Temperature

Return the delta between temperatures or the temperature less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Temperature, return the difference between the two temperatures.

• If the argument is a TemperatureDelta, return the temperature less the difference.

Raises:

BelowAbsoluteZeroError – The temperature minus the difference was less than absolute zero.Error can only be raised when other is a TemperatureDelta.

as_unit(unit: Unit) → float

Return the temperature, expressed as the unit.

class units.temperature.TemperatureDelta(value: float, unit: Unit)

The difference between two temperatures.

__abs__() → TemperatureDelta

Return the absolute version of the temperature difference.

__add__(other: TemperatureDelta) → TemperatureDelta

Return the sum of the temperature differences.

__divmod__(other: TemperatureDelta) → tuple[float, float]

Return the quotient and remainder of the ratio between the temp deltas.

__eq__(other: object) → bool

Return whether the objects are equal temperature differences.

__floordiv__(other: TemperatureDelta) → float

Return the floored ratio between the temperature differences.

__ge__(other: TemperatureDelta) → bool

Return whether the temperature delta is greater than or equal to other.

__gt__(other: TemperatureDelta) → bool

Return whether the temperature difference is greater than the other.

__hash__() → int

Return the hash of the temperature difference.

__init__(value: float, unit: Unit) → None

Initialise a new temperature difference.

__le__(other: TemperatureDelta) → bool

Return whether the temperature delta is less than or equal to the other.

__lt__(other: TemperatureDelta) → bool

Return whether the temperature difference is less than the other.

__mod__(other: TemperatureDelta) → float

Return the remainder of the ratio between the temperature differences.

__mul__(value: float) → TemperatureDelta

Return a temperature difference scaled by the value.

__neg__() → TemperatureDelta

Return the inverse of the temperature difference.

__rmul__(value: float) → TemperatureDelta

Return a temperature difference scaled by the value.

__sub__(delta: TemperatureDelta) → TemperatureDelta

Return the difference between the temperature differences.

__truediv__(other: float | TemperatureDelta) → TemperatureDelta | float

Return a scaled temperature difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is float, return a temperature difference scaled by the inverse of the value

• If the argument is a TemperatureDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the temperature difference, expressed as the unit.

class units.temperature.Unit

A temperature unit.

NB: Micropython does not yet support enums. The desired behaviour (enumerated options embedded in the type system) can be mostly replicated by substituting IntEnum for object at runtime, which is what has been done here.

CELSIUS = 1

FAHRENHEIT = 3

KELVIN = 2

units.temperature.ABSOLUTE_ZERO = Temperature(0, Unit.KELVIN)

Absolute zero temperature constant.

time

Module for grouping time-related classes and constants.

exception units.time.NegativeTimeValueError(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the time value is negative.

The minimum time that can exist is 0s, so a time with a negative value, regardless of the unit, is impossible.

__init__(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new negative-time exception.

property value: float

The time value that caused the error.

class units.time.Time(value: float, unit: Unit)

The measure in which events can be ordered from the past into the future.

__add__(delta: TimeDelta) → Time

Return the sum of the time and the difference.

Raises:

NegativeTimeValueError – The sum of the time and the difference was less than 0s.

__eq__(other: object) → bool

Return whether the objects are equal times.

__ge__(other: Time) → bool

Return whether the time is greater than or equal to the other.

__gt__(other: Time) → bool

Return whether the time is greater than the other.

__hash__() → int

Return the hash of the time.

__init__(value: float, unit: Unit) → None

Initialise a new time.

Raises:

NegativeTimeValueError – The negative value produced a time less than 0s.

__le__(other: Time) → bool

Return whether the time is less than or equal to the other.

__lt__(other: Time) → bool

Return whether the time is less than the other.

__radd__(delta: TimeDelta) → Time

Return the sum of the time and the difference.

__sub__(other: Time | TimeDelta) → TimeDelta | Time

Return the delta between times or the time less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Time, return the difference between the two times.

• If the argument is a TimeDelta, return the time less the difference.

Raises:

NegativeTimeValueError – The time minus the difference was less than 0s. Error can only be raised when other is a TimeDelta.

as_unit(unit: Unit) → float

Return the time, expressed as the unit.

class units.time.TimeDelta(value: float, unit: Unit)

The difference between two times.

__abs__() → TimeDelta

Return the absolute version of the time difference.

__add__(other: TimeDelta) → TimeDelta

Return the sum of the time differences.

__divmod__(other: TimeDelta) → tuple[float, float]

Return the quotient & remainder of the ratio between the time deltas.

__eq__(other: object) → bool

Return whether the objects are equal time differences.

__floordiv__(other: TimeDelta) → float

Return the floored ratio between the time differences.

__ge__(other: TimeDelta) → bool

Return whether the time delta is greater than or equal to the other.

__gt__(other: TimeDelta) → bool

Return whether the time difference is greater than the other.

__hash__() → int

Return the hash of the time difference.

__init__(value: float, unit: Unit) → None

Initialise a new time difference.

__le__(other: TimeDelta) → bool

Return whether the time delta is less than or equal to the other.

__lt__(other: TimeDelta) → bool

Return whether the time difference is less than the other.

__mod__(other: TimeDelta) → float

Return the remainder of the ratio between the time differences.

__mul__(value: float) → TimeDelta

Return a time difference scaled by the value.

__neg__() → TimeDelta

Return the inverse of the time difference.

__rmul__(value: float) → TimeDelta

Return a time difference scaled by the value.

__sub__(delta: TimeDelta) → TimeDelta

Return the difference between the time differences.

__truediv__(other: float | TimeDelta) → TimeDelta | float

Return a scaled time difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is float, return a time difference scaled by the inverse of the value

• If the argument is a TimeDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the time difference, expressed as the unit.

class units.time.Unit

A time unit.

NB: Micropython does not yet support enums. The desired behaviour (enumerated options embedded in the type system) can be mostly replicated by substituting IntEnum for object at runtime, which is what has been done here.

HOUR = 3

MICROSECOND = 4

MILLISECOND = 5

MINUTE = 2

SECOND = 1

units.time.ZERO = Time(0, Unit.SECOND)

Zero elapsed time constant.

voltage

Module for grouping voltage-related classes.

class units.voltage.Unit

A voltage unit.

NB: Micropython does not yet support enums. The desired behaviour (enumerated options embedded in the type system) can be mostly replicated by substituting IntEnum for object at runtime, which is what has been done here.

MICROVOLT = 3

MILLIVOLT = 2

VOLT = 1

class units.voltage.Voltage(value: float, unit: Unit)

The difference in electric potential between two points.

__abs__() → Voltage

Return the absolute version of the voltage.

__add__(other: Voltage) → Voltage

Return the sum of the voltages.

__divmod__(other: Voltage) → tuple[float, float]

Return the quotient & remainder of the ratio between the voltages.

__eq__(other: object) → bool

Return whether the objects are equal voltages.

__floordiv__(other: Voltage) → float

Return the floored ratio between the voltages.

__ge__(other: Voltage) → bool

Return whether the voltage is greater than or equal to the other.

__gt__(other: Voltage) → bool

Return whether the voltage is greater than the other.

__hash__() → int

Return the hash of the voltage.

__init__(value: float, unit: Unit) → None

Initialise a new voltage.

__le__(other: Voltage) → bool

Return whether the voltage is less than or equal to the other.

__lt__(other: Voltage) → bool

Return whether the voltage is less than the other.

__mod__(other: Voltage) → float

Return the remainder of the ratio between the voltages.

__mul__(value: float) → Voltage

Return a voltage scaled by the value.

__neg__() → Voltage

Return the inverse of the voltage.

__rmul__(value: float) → Voltage

Return a voltage scaled by the value.

__sub__(delta: Voltage) → Voltage

Return the difference between the voltages.

__truediv__(other: float | Voltage) → Voltage | float

Return a scaled voltage or the ratio between the voltages.

The behaviour depends upon the type of the argument.

• If the argument is float, return a voltage scaled by the inverse of the value

• If the argument is a Voltage, return the ratio between the two voltages

as_unit(unit: Unit) → float

Return the voltage, expressed as the unit.

volume

Module for grouping volume-related classes and constants.

exception units.volume.NegativeVolumeValueError(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any])

Raised when the volume value is negative.

The minimum volume that can exist is 0 m^3, so a volume with a negative value, regardless of the unit, is impossible.

__init__(value: float, *args: tuple[Any, ...], **kwargs: dict[str, Any]) → None

Initialise a new negative-volume exception.

property value: float

The volume value that caused the error.

class units.volume.Unit

A volume unit.

NB: Micropython does not yet support enums. The desired behaviour (enumerated options embedded in the type system) can be mostly replicated by substituting IntEnum for object at runtime, which is what has been done here.

CUBIC_METRE = 1

LITRE = 2

MICROLITRE = 4

MILLILITRE = 3

class units.volume.Volume(value: float, unit: Unit)

The measure of a three-dimensional space.

__add__(delta: VolumeDelta) → Volume

Return the sum of the volume and the difference.

Raises:

NegativeVolumeValueError – The sum of the volume and the difference was less than 0m^3.

__eq__(other: object) → bool

Return whether the objects are equal volumes.

__ge__(other: Volume) → bool

Return whether the volume is greater than or equal to the other.

__gt__(other: Volume) → bool

Return whether the volume is greater than the other.

__hash__() → int

Return the hash of the volume.

__init__(value: float, unit: Unit) → None

Initialise a new volume.

Raises:

NegativeVolumeValueError – The negative value produced a volume less than 0m^3.

__le__(other: Volume) → bool

Return whether the volume is less than or equal to the other.

__lt__(other: Volume) → bool

Return whether the volume is less than the other.

__radd__(delta: VolumeDelta) → Volume

Return the sum of the volume and the difference.

__sub__(other: Volume | VolumeDelta) → VolumeDelta | Volume

Return the delta between volumes or the volume less the delta.

The behaviour depends upon the type of the argument.

• If the argument is a Volume, return the difference between the two volumes.

• If the argument is a VolumeDelta, return the volume less the difference.

Raises:

NegativeVolumeValueError – The volume minus the difference was less than 0m^3. Error can only be raised when other is a VolumeDelta.

as_unit(unit: Unit) → float

Return the volume, expressed as the unit.

class units.volume.VolumeDelta(value: float, unit: Unit)

The difference between two volumes.

__abs__() → VolumeDelta

Return the absolute version of the volume difference.

__add__(other: VolumeDelta) → VolumeDelta

Return the sum of the volume differences.

__divmod__(other: VolumeDelta) → tuple[float, float]

Return the quotient & remainder of the ratio between the volume deltas.

__eq__(other: object) → bool

Return whether the objects are equal volume differences.

__floordiv__(other: VolumeDelta) → float

Return the floored ratio between the volume differences.

__ge__(other: VolumeDelta) → bool

Return whether the volume delta is greater than or equal to the other.

__gt__(other: VolumeDelta) → bool

Return whether the volume difference is greater than the other.

__hash__() → int

Return the hash of the volume difference.

__init__(value: float, unit: Unit) → None

Initialise a new volume difference.

__le__(other: VolumeDelta) → bool

Return whether the volume delta is less than or equal to the other.

__lt__(other: VolumeDelta) → bool

Return whether the volume difference is less than the other.

__mod__(other: VolumeDelta) → float

Return the remainder of the ratio between the volume differences.

__mul__(value: float) → VolumeDelta

Return a volume difference scaled by the value.

__neg__() → VolumeDelta

Return the inverse of the volume difference.

__rmul__(value: float) → VolumeDelta

Return a volume difference scaled by the value.

__sub__(delta: VolumeDelta) → VolumeDelta

Return the difference between the volume differences.

__truediv__(other: float | VolumeDelta) → VolumeDelta | float

Return a scaled volume difference or the ratio between the differences.

The behaviour depends upon the type of the argument.

• If the argument is float, return a volume difference scaled by the inverse of the value

• If the argument is a VolumeDelta, return the ratio between the two differences

as_unit(unit: Unit) → float

Return the volume difference, expressed as the unit.

units.volume.ZERO = Volume(0, Unit.CUBIC_METRE)

Zero volume constant.