units
Description
Runtime support module for quantities and units.
Based on mp-units library licensed under MIT.
Warning
Work in progress, features are missing and are subject to changes.
Index
Submodules
IEC declarations |
||
Imperial units declarations. |
||
ISQ declarations |
||
SI declarations |
||
Typographic units declarations. |
||
United States customary units declarations. |
||
International yard and pound units declarations. |
Classes
A simple wrapper for a short-named base dimension. |
||
A marker type for tagging any type as producing a delta quantity. |
||
A kind of specification. |
||
A marker type for tagging any type as producing a quantity point. |
||
Marker type for quantity origins. |
||
A unit prefix. |
||
A unit that can be prefixed. |
||
A concrete absolute quantity value. |
||
A concrete quantity delta value. |
||
A concrete quantity point value. |
||
Structure containing dimensions of a unit or quantity. |
||
A concrete amount of quantity to measure the values of quantities of the same kind. |
Attributes
|
Functions
Convenience function to create a |
||
Convenience function to create a |
Enumerations
Level of convertibility between quantities. |
Attributes
Functions
- delta(arg0: float, arg1: syside.experimental.units.Unit, /) syside.experimental.units.QuantityDelta
Convenience function to create a
QuantityDelta.
- point(arg0: float, arg1: syside.experimental.units.Unit, /) syside.experimental.units.QuantityPoint
Convenience function to create a
QuantityPointrelative to the natural zero.
Enumerations
- class Convertible
Level of convertibility between quantities.
No¶Quantities are not interconvertible.
For example,
timeandmass.Cast¶Quantities require casting between different branches of the same kind.
For example,
widthandheight.ExplicitKind¶Quantities require explicit conversion across different kinds. Expect this to be removed in the future.
For example,
solid_angular_measureandangular_measure.Explicit¶Quantity to be converted requires an explicit conversion, i.e. a downcast.
For example,
lengthtowidth.Yes¶Quantity is implicitly convertible to another quantity.
For example,
widthtolength.