Reference#

Descriptions of what unxt contains: classes, functions, options and their defaults. Consult these while you work; they do not explain or instruct.

For instructions see the How-to guides; for the reasoning behind the design see Discussion.

Core types#

  • Quantity โ€” Quantity, Angle, StaticQuantity, StaticValue.

  • Dimensions โ€” dimension and dimension_of, and the expression syntax.

  • Units โ€” unit and unit_of.

  • Unit systems โ€” built-in realizations, natural unit systems, unitsystem.

Settings and interop#

  • Configuration โ€” every display option, its type and its default, including the pyproject.toml keys.

  • dataclassish support โ€” what each dataclassish function returns for each unxt type.

Vocabulary and generated API#

  • ๐Ÿ“‡ Glossary โ€” the terms used throughout these docs.

  • unxt API โ€” the generated API documentation, module by module.

Not yet written#

There is no error reference keyed by message text. unxt raises mostly through astropyโ€™s UnitConversionError, so error strings currently appear only inline in the guides that provoke them.