Module Reference

Auto-generated API reference for all public ucon modules.

For a curated overview with examples, see the API Reference.

Core

• ucon.core --- Unit, Number, Scale, UnitProduct, UnitFactor, Ratio
• ucon.dimension --- Dimension algebra and enumeration
• ucon.graph --- ConversionGraph, context scoping, exceptions
• ucon.maps --- Map hierarchy (LinearMap, AffineMap, LogMap, ExpMap)
• ucon.parsing --- String parsing to Number objects
• ucon.units --- Canonical unit definitions
• ucon.constants --- Physical constants (CODATA 2022)
• ucon.checking --- Dimension enforcement decorator
• ucon.packages --- Unit package loading from TOML
• ucon.contexts --- Cross-dimensional conversion contexts (spectroscopy, boltzmann)

Kind-of-Quantity

• ucon.kinds --- Kind, KindLattice, JoinPolicy
• ucon.formulas --- KindFormula, FormulaRegistry, tiered lookup
• ucon.aspects --- Aspect, AspectForest, family-wise resolution

Integrations

• ucon.integrations.numpy --- NumPy array support (NumberArray)
• ucon.integrations.pandas --- Pandas integration (NumberSeries)
• ucon.integrations.polars --- Polars integration (NumberColumn)
• ucon.integrations.pydantic --- Pydantic v2 integration

Basis

• ucon.basis --- Basis, BasisComponent, Vector
• ucon.basis.builtin --- Standard bases (SI, CGS, CGS_ESU, NATURAL)
• ucon.basis.transforms --- BasisTransform, standard transforms
• ucon.basis.graph --- BasisGraph, context scoping
• ucon.basis.ops --- Explicit cross-basis arithmetic (unify, multiply_via, divide_via)

System

• ucon.system --- UnitSystem value type, BaseUnits, AlgebraCache, use/active