Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: use astropy unit conversion API #208

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: use astropy unit conversion API #208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 1 addition & 44 deletions src/unxt/_interop/unxt_interop_astropy/quantity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
import astropy.units as u
from astropy.coordinates import Angle as AstropyAngle, Distance as AstropyDistance
from astropy.units import Quantity as AstropyQuantity
from jaxtyping import Array
from packaging.version import Version
from plum import conversion_method, dispatch

import quaxed.numpy as jnp
Expand All @@ -22,7 +20,6 @@
Quantity,
UncheckedQuantity,
)
from unxt._interop.optional_deps import OptDeps

# ============================================================================
# AbstractQuantity
Expand Down Expand Up @@ -243,46 +240,6 @@
AstropyUnit: TypeAlias = u.UnitBase | u.Unit | u.FunctionUnitBase | u.StructuredUnit


if Version("7.0") <= OptDeps.ASTROPY.version:

def _apy7_unit_to(self: AstropyUnit, other: AstropyUnit, value: Array, /) -> Array:
return self.to(other, value)

else:

def _apy7_unit_to(self: AstropyUnit, other: AstropyUnit, value: Array, /) -> Array:
"""Convert the value to the other unit."""
# return self.get_converter(Unit(other), equivalencies)(value)
# First see if it is just a scaling.
try:
scale = self._to(other)
except u.UnitsError:
pass
else:
return scale * value

# if that doesn't work, maybe we can do it with equivalencies?
try:
return self._apply_equivalencies(
self, other, self._normalize_equivalencies([])
)(value)
except u.UnitsError as exc:
# Last hope: maybe other knows how to do it?
# We assume the equivalencies have the unit itself as first item.
# TODO: maybe better for other to have a `_back_converter` method?
if hasattr(other, "equivalencies"):
for funit, tunit, _, b in other.equivalencies:
if other is funit:
try:
converter = self.get_converter(tunit, [])
except Exception: # noqa: BLE001, S110 # pylint: disable=W0718
pass
else:
return b(converter(value))

raise exc # noqa: TRY201


@dispatch # type: ignore[misc]
def uconvert(unit: AstropyUnit, x: AbstractQuantity, /) -> AbstractQuantity:
"""Convert the quantity to the specified units.
Expand All @@ -294,7 +251,7 @@

>>> x = Quantity(1000, "m")
>>> uconvert(units("km"), x)
Quantity['length'](Array(1., dtype=float32, ...), unit='km')

Check failure on line 254 in src/unxt/_interop/unxt_interop_astropy/quantity.py

View workflow job for this annotation

GitHub Actions / Check Python 3.10 on macos-latest 

quantity.py line=253 column=1

Check failure on line 254 in src/unxt/_interop/unxt_interop_astropy/quantity.py

View workflow job for this annotation

GitHub Actions / Check Python 3.12 on macos-latest 

quantity.py line=253 column=1

Check failure on line 254 in src/unxt/_interop/unxt_interop_astropy/quantity.py

View workflow job for this annotation

GitHub Actions / Check Python 3.10 on ubuntu-latest 

quantity.py line=253 column=1

Check failure on line 254 in src/unxt/_interop/unxt_interop_astropy/quantity.py

View workflow job for this annotation

GitHub Actions / Check Interoperability (3.12, ubuntu-latest) 

quantity.py line=253 column=1

Check failure on line 254 in src/unxt/_interop/unxt_interop_astropy/quantity.py

View workflow job for this annotation

GitHub Actions / Check Python 3.12 on ubuntu-latest 

quantity.py line=253 column=1

>>> x = Quantity([1, 2, 3], "Kelvin")
>>> with u.add_enabled_equivalencies(u.temperature()):
Expand All @@ -312,4 +269,4 @@
# if isinstance(x.value, jax.core.Tracer) and not can_convert_unit(x.unit, u):
# return x.value

return replace(x, value=_apy7_unit_to(x.unit, unit, x.value), unit=unit)
return replace(x, value=x.unit.to(unit, x.value), unit=unit)
Loading