unxt.units

Working with units.

The main features are:

• unxt.units.unit: a function to construct units.

• unxt.units.unit_of: a function to get the units of an object.

unxt.units.unit(obj: Any, /)

Construct the units from a units object.

unxt.units.unit(obj: UnitBase | Unit, /) → UnitBase | Unit | FunctionUnitBase | StructuredUnit

Parameters:

obj (Any)

Return type:

Any

Construct the units from an Astropy unit.

Examples

>>> import astropy.units as apyu
>>> import unxt as u
>>> u.unit(apyu.km)
Unit("km")

unxt.units.unit(obj: str, /) → Unit | UnitBase | CompositeUnit

Parameters:

obj (Any)

Return type:

Any

Construct units from a string.

Examples

>>> import unxt as u
>>> m = u.unit("m")
>>> m
Unit("m")

unxt.units.unit(obj: Quantity, /) → UnitBase | Unit | FunctionUnitBase | StructuredUnit

Parameters:

obj (Any)

Return type:

Any

Construct the units from an Astropy quantity.

Examples

>>> import astropy.units as apyu
>>> import unxt as u
>>> u.unit(apyu.Quantity(2, "km"))
Unit("2 km")

Parameters:

obj (Any)

Return type:

Any

unxt.units.unit_of(obj: Any, /)

Return the units of an object.

unxt.units.unit_of(obj: Any, /) → NoneType

Parameters:

obj (Any)

Return type:

Any

Return the units of an object.

Examples

>>> import unxt as u
>>> print(u.unit_of(1))
None

unxt.units.unit_of(obj: UnitBase | Unit, /) → UnitBase | Unit | FunctionUnitBase | StructuredUnit

Parameters:

obj (Any)

Return type:

Any

Return the units of an object.

Examples

>>> import astropy.units as apyu
>>> import unxt as u

>>> u.unit_of(apyu.km)
Unit("km")

unxt.units.unit_of(obj: AbstractQuantity, /) → Unit | UnitBase | CompositeUnit

Parameters:

obj (Any)

Return type:

Any

Return the units of an object.

Examples

>>> from unxt import unit_of, Quantity
>>> q = Quantity(1, "m")
>>> unit_of(q)
Unit("m")

unxt.units.unit_of(obj: Quantity, /) → UnitBase | Unit | FunctionUnitBase | StructuredUnit

Parameters:

obj (Any)

Return type:

Any

Return the units of an Astropy quantity.

Examples

>>> import astropy.units as apyu
>>> import unxt as u

>>> u.unit_of(apyu.Quantity(1, "km"))
Unit("km")

Parameters:

obj (Any)

Return type:

Any