make matlab engine code reusable

Author: scivision

.github/workflows/ci.yml

@@ -6,6 +6,7 @@ on:
     - "**.py"
     - .github/workflows/ci.yml
     - "!scripts/**"
+    - "!examples/**"
 
 jobs:
 

.github/workflows/ci_stdlib_only.yml

@@ -6,6 +6,7 @@ on:
     - "**.py"
     - .github/workflows/ci_stdlib_only.yml
     - "!scripts/**"
+    - "!examples/**"
 
 jobs:
 

Examples/astropy_geodetic2ecef.py

@@ -9,8 +9,15 @@
 
 from astropy.time import Time
 import astropy
+import numpy as np
+
 import pymap3d as pm
 
+try:
+    from pymap3d.tests.matlab_engine import matlab_ecef2eci, matlab_engine, has_matmap3d
+except ImportError:
+    matlab_engine = None
+
 print("Python version:", sys.version)
 print("AstroPy version:", astropy.__version__)
 
@@ -28,12 +35,44 @@
 print("Julian Date (TT):", astropy_time.tt.jd)
 print("GMST:", astropy_time.sidereal_time("mean", "greenwich"))
 
+np.set_printoptions(precision=3, suppress=True)
+
 # %% 1. Geodetic to ECEF
 ecef = pm.geodetic2ecef(lat, lon, alt)
 print("\nECEF Coordinates (meters):")
-print(f"X: {ecef[0]:.8f}, Y: {ecef[1]:.8f}, Z: {ecef[2]:.8f}")
+print(np.array(ecef))
+
+# %% AstroPy ECEF to ECI (J2000)
+astropy_eci = pm.ecef2eci(ecef[0], ecef[1], ecef[2], dt)
+astropy_eci = np.array(astropy_eci)
+print("\nAstroPy: ECI Coordinates (meters):")
+print(astropy_eci)
+
+numpy_eci = pm.ecef2eci(ecef[0], ecef[1], ecef[2], dt, force_non_astropy=True)
+numpy_eci = np.array(numpy_eci)
+print("\nNumpy: ECI Coordinates (meters):")
+print(numpy_eci)
+
+print("\nAstroPy - Numpy Difference (ECI meters):", astropy_eci - numpy_eci)
+
+# %% Matlab comparison
+if matlab_engine is not None:
+    eng = matlab_engine()
+    eci_matlab_aerospace = matlab_ecef2eci(eng, False, dt, ecef)
+    print("\nMatlab Aerospace Toolbox: ECI Coordinates (meters):")
+    print(np.array(eci_matlab_aerospace))
+    print(
+        "\nAstroPy - Matlab Aerospace Toolbox Difference (ECI meters):",
+        astropy_eci - eci_matlab_aerospace,
+    )
+    print(
+        "Numpy - Matlab Aerospace Toolbox Difference (ECI meters):",
+        numpy_eci - eci_matlab_aerospace,
+    )
 
-# %% 2. ECEF to ECI (J2000)
-eci = pm.ecef2eci(ecef[0], ecef[1], ecef[2], dt)
-print("\nECI Coordinates (meters):")
-print(f"X: {eci[0]}, Y: {eci[1]}, Z: {eci[2]}")
+    if has_matmap3d(eng):
+        eci_matmap3d = matlab_ecef2eci(eng, True, dt, ecef)
+        print("\nMatlab Matmap3D: ECI Coordinates (meters):")
+        print(np.array(eci_matmap3d))
+        print("\nAstroPy - Matlab Matmap3D Difference (ECI meters):", astropy_eci - eci_matmap3d)
+        print("Numpy - Matlab Matmap3D Difference (ECI meters):", numpy_eci - eci_matmap3d)

src/pymap3d/tests/matlab_engine.py

@@ -1,5 +1,8 @@
 import functools
 from pathlib import Path
+from datetime import datetime
+
+import numpy as np
 
 import matlab.engine
 
@@ -36,3 +39,17 @@ def has_aerospace(eng) -> bool:
 @functools.cache
 def has_mapping(eng) -> bool:
     return eng.get_matlab_toolboxes()["mapping"]
+
+
+def matlab_ecef2eci(eng, matmap3d: bool, utc: datetime, ecef):
+    if matmap3d:
+        return eng.matmap3d.ecef2eci(utc, *ecef, nargout=3)
+
+    return np.array(eng.ecef2eci(utc, np.asarray(ecef), nargout=1)).squeeze()
+
+
+def matlab_eci2ecef(eng, matmap3d: bool, utc: datetime, eci):
+    if matmap3d:
+        return eng.matmap3d.eci2ecef(utc, *eci, nargout=3)
+
+    return np.array(eng.eci2ecef(utc, np.asarray(eci), nargout=1)).squeeze()

src/pymap3d/tests/test_matlab_ecef2eci.py

@@ -11,28 +11,19 @@
 import pymap3d
 
 try:
-    import numpy as np
-    from .matlab_engine import matlab_engine, has_aerospace, has_matmap3d
+    from .matlab_engine import (
+        matlab_engine,
+        has_aerospace,
+        has_matmap3d,
+        matlab_ecef2eci,
+        matlab_eci2ecef,
+    )
 except ImportError:
     pytest.skip("Matlab Engine not found", allow_module_level=True)
 except RuntimeError:
     pytest.skip("Matlab Engine configuration error", allow_module_level=True)
 
 
-def ecef2eci(eng, matmap3d: bool, utc: datetime, ecef):
-    if matmap3d:
-        return eng.matmap3d.ecef2eci(utc, *ecef, nargout=3)
-
-    return np.array(eng.ecef2eci(utc, np.asarray(ecef), nargout=1)).squeeze()
-
-
-def eci2ecef(eng, matmap3d: bool, utc_m, eci):
-    if matmap3d:
-        return eng.matmap3d.eci2ecef(utc_m, *eci, nargout=3)
-
-    return np.array(eng.eci2ecef(utc_m, np.asarray(eci), nargout=1)).squeeze()
-
-
 @pytest.mark.parametrize("matmap3d", [False, True])
 def test_compare_ecef2eci(matmap3d):
     eng = matlab_engine()
@@ -52,7 +43,7 @@ def test_compare_ecef2eci(matmap3d):
 
     eci_py = pymap3d.ecef2eci(ecef[0], ecef[1], ecef[2], utc)
 
-    eci_m = ecef2eci(eng, matmap3d, utc, ecef)
+    eci_m = matlab_ecef2eci(eng, matmap3d, utc, ecef)
 
     assert eci_py == approx(eci_m, rel=rtol)
 
@@ -76,6 +67,6 @@ def test_compare_eci2ecef(matmap3d):
 
     ecef_py = pymap3d.eci2ecef(eci[0], eci[1], eci[2], utc)
 
-    ecef_m = eci2ecef(eng, matmap3d, utc, eci)
+    ecef_m = matlab_eci2ecef(eng, matmap3d, utc, eci)
 
     assert ecef_py == approx(ecef_m, rel=rtol)