💥 boom(astro): move space frames to coordinax_astro

Signed-off-by: Nathaniel Starkman <[email protected]>

Author: nstarman

docs/guides/coordinates_and_frames.md

@@ -7,15 +7,29 @@ frame metadata to your data.
 
 ## Built-in Frames
 
-{mod}`coordinax.frames` includes several standard astronomical frames:
+`coordinax.frames` includes several standard frames:
 
 ```{code-block} python
 >>> import coordinax.frames as cxf
->>> icrs = cxf.ICRS()
+
+>>> alice = cxf.Alice()
+>>> alice
+Alice()
+
+>>> bob = cxf.Bob()
+>>> bob
+Bob()
+```
+
+`coordinax_astro` includes several standard astronomical frames:
+
+```{code-block} python
+>>> from coordinax_astro import ICRS, Galactocentric
+>>> icrs = ICRS()
 >>> icrs
 ICRS()
 
->>> gc = cxf.Galactocentric()
+>>> gc = Galactocentric()
 >>> gc
 Galactocentric(
   galcen=LonLatSphericalPos(...),

packages/coordinax-astro/src/coordinax_astro/__init__.py

@@ -1,7 +1,30 @@
-"""Coordinax for Astronomy."""
+"""Coordinax for Astronomy.
 
-__all__ = [
-    "FourVector",
-]
+>>> import unxt as u
+>>> import coordinax as cx
+>>> import coordinax_astro as cxa
 
-from ._src import FourVector
+>>> icrs = cxa.ICRS()
+>>> gcf = cxa.Galactocentric()
+
+>>> op = cx.frames.frame_transform_op(icrs, gcf)
+>>> op
+Pipe(( ... ))
+
+>>> q = cx.vecs.CartesianPos3D.from_([1, 2, 3], "kpc")
+>>> print(op(q))
+<CartesianPos3D: (x, y, z) [kpc]
+    [-11.375   1.845   0.133]>
+
+"""
+
+__all__ = ["FourVector", "AbstractSpaceFrame", "ICRS", "Galactocentric"]
+
+from ._src import ICRS, AbstractSpaceFrame, FourVector, Galactocentric
+
+# Interoperability. Importing this module will register interop frameworks.
+# isort: split
+from . import _interop
+
+# clean up namespace
+del _interop

…rdinax_space_frames/_interop/__init__.py …src/coordinax_astro/_interop/__init__.pysrc/coordinax/_coordinax_space_frames/_interop/__init__.py renamed to packages/coordinax-astro/src/coordinax_astro/_interop/__init__.py src/coordinax/_coordinax_space_frames/_interop/__init__.py renamed to packages/coordinax-astro/src/coordinax_astro/_interop/__init__.py

@@ -5,7 +5,8 @@
 import astropy.coordinates as apyc
 import equinox as eqx
 
-from coordinax._coordinax_space_frames import ICRS, Galactocentric
+from coordinax_astro._src.frames import ICRS, Galactocentric
+
 from coordinax._src.frames.base import AbstractReferenceFrame
 from coordinax._src.vectors.d3 import LonLatSphericalPos
 
@@ -17,10 +18,10 @@ def from_(cls: type[ICRS], obj: apyc.ICRS, /) -> ICRS:
     Examples
     --------
     >>> import astropy.coordinates as apyc
-    >>> import coordinax.frames as cxf
+    >>> from coordinax_astro import ICRS
 
     >>> apy_icrs = apyc.ICRS()
-    >>> cxf.ICRS.from_(apy_icrs)
+    >>> ICRS.from_(apy_icrs)
     ICRS()
 
     """
@@ -35,14 +36,14 @@ def from_(cls: type[Galactocentric], obj: apyc.Galactocentric, /) -> Galactocent
     Examples
     --------
     >>> import astropy.coordinates as apyc
-    >>> import coordinax.frames as cxf
+    >>> from coordinax_astro import Galactocentric
 
     >>> apy_gcf = apyc.Galactocentric()
     >>> apy_gcf
     <Galactocentric Frame (galcen_coord=<ICRS Coordinate: (ra, dec) in deg
     (266.4051, -28.936175)>, galcen_distance=8.122 kpc, galcen_v_sun=(12.9, 245.6, 7.78) km / s, z_sun=20.8 pc, roll=0.0 deg)>
 
-    >>> gcf = cxf.Galactocentric.from_(apy_gcf)
+    >>> gcf = Galactocentric.from_(apy_gcf)
     >>> gcf
     Galactocentric(
         galcen=LonLatSphericalPos( ... ),
@@ -58,7 +59,6 @@ def from_(cls: type[Galactocentric], obj: apyc.Galactocentric, /) -> Galactocent
     ...  and gcf.galcen.distance.ustrip("kpc") == apy_gcf.galcen_distance.to_value("kpc") )
     Array(True, dtype=bool)
 
-
     """  # noqa: E501
     obj = eqx.error_if(obj, obj.has_data, "Astropy frame must not have data.")
     galcen = LonLatSphericalPos(

…rames/_interop/interop_astropy/frames.py …rdinax_astro/_interop/interop_astropy.pysrc/coordinax/_coordinax_space_frames/_interop/interop_astropy/frames.py renamed to packages/coordinax-astro/src/coordinax_astro/_interop/interop_astropy.py src/coordinax/_coordinax_space_frames/_interop/interop_astropy/frames.py renamed to packages/coordinax-astro/src/coordinax_astro/_interop/interop_astropy.py

@@ -1,7 +1,6 @@
-"""Frames for Astronomy."""
+"""Coordinax for Astronomy."""
 
-__all__ = [
-    "FourVector",
-]
+__all__ = ["FourVector", "AbstractSpaceFrame", "ICRS", "Galactocentric"]
 
+from .frames import ICRS, AbstractSpaceFrame, Galactocentric
 from .vecs import FourVector

…x_space_frames/_interop/optional_deps.py …oordinax_astro/_interop/optional_deps.pysrc/coordinax/_coordinax_space_frames/_interop/optional_deps.py renamed to packages/coordinax-astro/src/coordinax_astro/_interop/optional_deps.py src/coordinax/_coordinax_space_frames/_interop/optional_deps.py renamed to packages/coordinax-astro/src/coordinax_astro/_interop/optional_deps.py

@@ -6,10 +6,3 @@
 from .frame_transforms import *
 from .galactocentric import Galactocentric
 from .icrs import ICRS
-
-# Interoperability. Importing this module will register interop frameworks.
-# isort: split
-from . import _interop
-
-# clean up namespace
-del _interop

packages/coordinax-astro/src/coordinax_astro/_src/__init__.py

@@ -49,8 +49,9 @@ def frame_transform_op(
     >>> from plum import dispatch
     >>> import unxt as u
     >>> import coordinax as cx
+    >>> from coordinax_astro import AbstractSpaceFrame, ICRS, Galactocentric
 
-    >>> class MySpaceFrame(cx.frames.AbstractSpaceFrame):
+    >>> class MySpaceFrame(AbstractSpaceFrame):
     ...     pass
 
     >>> @dispatch
@@ -61,7 +62,7 @@ def frame_transform_op(
     we don't have a direct transformation defined:
 
     >>> my_frame = MySpaceFrame()
-    >>> gcf_frame = cx.frames.Galactocentric()
+    >>> gcf_frame = Galactocentric()
 
     >>> op = cx.frames.frame_transform_op(my_frame, gcf_frame)
     >>> op
@@ -87,8 +88,8 @@ def frame_transform_op(from_frame: ICRS, to_frame: ICRS, /) -> Identity:
     Examples
     --------
     >>> import coordinax.frames as cxf
-    >>> icrs_frame = cxf.ICRS()
-    >>> frame_op = cxf.frame_transform_op(icrs_frame, icrs_frame)
+    >>> alice = cxf.Alice()
+    >>> frame_op = cxf.frame_transform_op(alice, alice)
     >>> frame_op
     Identity()
 
@@ -107,13 +108,14 @@ def frame_transform_op(from_frame: Galactocentric, to_frame: Galactocentric, /)
     --------
     >>> import unxt as u
     >>> import coordinax.frames as cxf
+    >>> from coordinax_astro import Galactocentric
 
-    >>> gcf_frame = cxf.Galactocentric()
+    >>> gcf_frame = Galactocentric()
     >>> frame_op = cxf.frame_transform_op(gcf_frame, gcf_frame)
     >>> frame_op
     Pipe(Identity())
 
-    >>> gcf_frame2 = cxf.Galactocentric(roll=u.Quantity(10, "deg"))
+    >>> gcf_frame2 = Galactocentric(roll=u.Quantity(10, "deg"))
     >>> frame_op2 = cxf.frame_transform_op(gcf_frame, gcf_frame2)
     >>> frame_op2
     Pipe((
@@ -151,6 +153,7 @@ def frame_transform_op(from_frame: ICRS, to_frame: Galactocentric, /) -> Pipe:
 
     >>> import unxt as u
     >>> import coordinax as cx
+    >>> from coordinax_astro import Galactocentric, ICRS
     >>> import astropy.coordinates as apyc
 
     The location of Vega in ICRS coordinates:
@@ -186,8 +189,8 @@ def frame_transform_op(from_frame: ICRS, to_frame: Galactocentric, /) -> Pipe:
     >>> vega_q = cx.vecs.LonLatSphericalPos.from_(vega.icrs.data)
     >>> vega_p = cx.vecs.LonCosLatSphericalVel.from_(vega.icrs.data.differentials["s"])
 
-    >>> icrs_frame = cx.frames.ICRS()
-    >>> gcf_frame = cx.frames.Galactocentric.from_(apy_gcf)
+    >>> icrs_frame = ICRS()
+    >>> gcf_frame = Galactocentric.from_(apy_gcf)
 
     Define the transformation operator:
 
@@ -277,6 +280,7 @@ def frame_transform_op(from_frame: Galactocentric, to_frame: ICRS, /) -> Pipe:
 
     >>> import unxt as u
     >>> import coordinax as cx
+    >>> from coordinax_astro import Galactocentric, ICRS
     >>> import astropy.coordinates as apyc
 
     The location of Vega in Galactocentric coordinates:
@@ -313,8 +317,8 @@ def frame_transform_op(from_frame: Galactocentric, to_frame: ICRS, /) -> Pipe:
     >>> vega_q = cx.CartesianPos3D.from_(vega.galactocentric.data)
     >>> vega_p = cx.CartesianVel3D.from_(vega.galactocentric.data.differentials["s"])
 
-    >>> icrs_frame = cx.frames.ICRS()
-    >>> gcf_frame = cx.frames.Galactocentric.from_(apy_gcf)
+    >>> icrs_frame = ICRS()
+    >>> gcf_frame = Galactocentric.from_(apy_gcf)
 
     Define the transformation operator:
 

…inax/_coordinax_space_frames/__init__.py …/coordinax_astro/_src/frames/__init__.pysrc/coordinax/_coordinax_space_frames/__init__.py renamed to packages/coordinax-astro/src/coordinax_astro/_src/frames/__init__.py src/coordinax/_coordinax_space_frames/__init__.py renamed to packages/coordinax-astro/src/coordinax_astro/_src/frames/__init__.py

@@ -30,9 +30,8 @@ class Galactocentric(AbstractSpaceFrame):
 
     Examples
     --------
-    >>> import coordinax as cx
-    >>> frame = cx.frames.Galactocentric()
-    >>> frame
+    >>> from coordinax_astro import Galactocentric
+    >>> Galactocentric()
     Galactocentric(
       galcen=LonLatSphericalPos( ... ),
       roll=Quantity(weak_i32[], unit='deg'),