open-space-toolkit-physics 11.2.1__py310-none-manylinux2014_x86_64.whl → 12.0.0__py310-none-manylinux2014_x86_64.whl

ostk/physics/environment/object/celestial/__init__.pyi

@@ -0,0 +1,248 @@
+from __future__ import annotations
+import ostk.core.type
+import ostk.physics.environment.object
+import ostk.physics.unit
+import typing
+from . import moon
+from . import sun
+__all__ = ['Earth', 'Moon', 'Sun', 'moon', 'sun']
+class Earth(ostk.physics.environment.object.Celestial):
+    """
+    
+                    Earth
+                
+    """
+    @staticmethod
+    def EGM2008(degree: ostk.core.type.Integer = ..., order: ostk.core.type.Integer = ...) -> Earth:
+        """
+                            Earth Gravity Model 2008 model (EGM2008).
+        
+                            Args:
+                                degree (int): Degree.
+                                order (int): Order.
+        
+                            Returns:
+                                Earth: Earth.
+        """
+    @staticmethod
+    def EGM84(degree: ostk.core.type.Integer = ..., order: ostk.core.type.Integer = ...) -> Earth:
+        """
+                            Earth Gravity Model 1984 (EGM84).
+        
+                            Args:
+                                degree (int): Degree.
+                                order (int): Order.
+        
+                            Returns:
+                                Earth: Earth.
+        """
+    @staticmethod
+    def EGM96(degree: ostk.core.type.Integer = ..., order: ostk.core.type.Integer = ...) -> Earth:
+        """
+                            Earth Gravity Model 1996 (EGM96).
+        
+                            Args:
+                                degree (int): Degree.
+                                order (int): Order.
+        
+                            Returns:
+                                Earth: Earth.
+        """
+    @staticmethod
+    def WGS84(degree: ostk.core.type.Integer = ..., order: ostk.core.type.Integer = ...) -> Earth:
+        """
+                            World Geodetic System 1984 (WGS84).
+        
+                            Args:
+                                degree (int): Degree.
+                                order (int): Order.
+        
+                            Returns:
+                                Earth: Earth.
+        """
+    @staticmethod
+    def WGS84_EGM96(degree: ostk.core.type.Integer = ..., order: ostk.core.type.Integer = ...) -> Earth:
+        """
+                            World Geodetic System 1984 (WGS84) + Earth Gravity Model 1996 (EGM96).
+        
+                            EGM96 coefficients and WGS84 shape.
+                            Gravitational parameter: 398600441800000 [m^3/s^2].
+                            Equatorial radius: 6378137.0 [m].
+        
+                            Args:
+                                degree (int): Degree.
+                                order (int): Order.
+        
+                            Returns:
+                                Earth: Earth.
+        """
+    @staticmethod
+    def _pybind11_conduit_v1_(*args, **kwargs):
+        ...
+    @staticmethod
+    def atmospheric_only(atmospheric_model: typing.Any) -> Earth:
+        """
+                            Just atmospheric model.
+        
+                            Args:
+                                atmospheric_model (EarthAtmosphericModel): Atmospheric model.
+        
+                            Returns:
+                                Earth: Earth.
+        """
+    @staticmethod
+    def default() -> Earth:
+        """
+                            Default Earth model (EGM2008).
+        
+                            Returns:
+                                Earth: Earth
+        """
+    @staticmethod
+    def from_models(gravity_model: typing.Any, magnetic_model: typing.Any, atmospheric_model: typing.Any) -> Earth:
+        """
+                            Create earth from specified models.
+        
+                            Args:
+                                gravity_model (EarthGravitationalModel): Gravitational model.
+                                magnetic_model (EarthMagneticModel): Magnetic model.
+                                atmospheric_model (EarthAtmosphericModel): Atmospheric model.
+        
+                            Returns:
+                                Earth: Earth.
+        """
+    @staticmethod
+    def gravitational_only(gravity_model: typing.Any) -> Earth:
+        """
+                            Just gravity model.
+        
+                            Args:
+                                gravity_model (EarthGravitationalModel): Gravitational model.
+        
+                            Returns:
+                                Earth: Earth.
+        """
+    @staticmethod
+    def magnetic_only(magnetic_model: typing.Any) -> Earth:
+        """
+                            Just magnetic model.
+        
+                            Args:
+                                magnetic_model (EarthMagneticModel): Magnetic model.
+        
+                            Returns:
+                                Earth: Earth.
+        """
+    @staticmethod
+    def spherical() -> Earth:
+        """
+                            Spherical model.
+        
+                            Returns:
+                                Earth: Earth.
+        """
+    @typing.overload
+    def __init__(self, gravitational_parameter: ostk.physics.unit.Derived, equatorial_radius: ostk.physics.unit.Length, flattening: ostk.core.type.Real, J2_parameter_value: ostk.core.type.Real, J4_parameter_value: ostk.core.type.Real, ephemeris: typing.Any, gravitational_model: typing.Any, magnetic_model: typing.Any, atmospheric_model: typing.Any) -> None:
+        """
+                            Constructor
+        
+                            Args:
+                                gravitational_parameter (Derived): Gravitational parameter [m³/s²].
+                                equatorial_radius (Length): Equatorial radius [m].
+                                flattening (Real): Flattening.
+                                J2_parameter_value (Real): J2 parameter value.
+                                J4_parameter_value (Real): J4 parameter value.
+                                ephemeris (Ephemeris): Ephemeris.
+                                gravitational_model (EarthGravitationalModel): Gravitational model.
+                                magnetic_model (EarthMagneticModel): Magnetic model.
+                                atmospheric_model (EarthAtmosphericModel): Atmospheric model.
+        """
+    @typing.overload
+    def __init__(self, ephemeris: typing.Any, gravitational_model: typing.Any = None, magnetic_model: typing.Any = None, atmospheric_model: typing.Any = None) -> None:
+        """
+                            Constructor
+        
+                            Args:
+                                ephemeris (Ephemeris): Ephemeris.
+                                gravitational_model (EarthGravitationalModel): Gravitational model. Defaults to None.
+                                magnetic_model (EarthMagneticModel): Magnetic model. Defaults to None.
+                                atmospheric_model (EarthAtmosphericModel): Atmospheric model. Defaults to None.
+        """
+    def __repr__(self) -> str:
+        ...
+    def __str__(self) -> str:
+        ...
+class Moon(ostk.physics.environment.object.Celestial):
+    """
+    
+                    Moon.
+                
+    """
+    @staticmethod
+    def _pybind11_conduit_v1_(*args, **kwargs):
+        ...
+    @staticmethod
+    def default() -> Moon:
+        """
+                            Create a default Moon.
+        
+                            Returns:
+                                Moon: Default Moon.
+        """
+    @staticmethod
+    def spherical() -> Moon:
+        """
+                            Spherical model.
+        
+                            Returns:
+                                Moon: Moon.
+        """
+    def __init__(self, ephemeris: typing.Any, gravitational_model: typing.Any) -> None:
+        """
+                            Constructor.
+        
+                            Args:
+                                ephemeris (Ephemeris): Ephemeris.
+                                gravitational_model (MoonGravitationalModel): Gravitational model.
+        """
+    def __repr__(self) -> str:
+        ...
+    def __str__(self) -> str:
+        ...
+class Sun(ostk.physics.environment.object.Celestial):
+    """
+    
+                    Sun.
+                
+    """
+    @staticmethod
+    def _pybind11_conduit_v1_(*args, **kwargs):
+        ...
+    @staticmethod
+    def default() -> Sun:
+        """
+                            Create a default Sun.
+        
+                            Returns:
+                                Sun: Default Sun.
+        """
+    @staticmethod
+    def spherical() -> Sun:
+        """
+                            Spherical model.
+        
+                            Returns:
+                                Sun: Sun.
+        """
+    def __init__(self, ephemeris: typing.Any, gravitational_model: typing.Any) -> None:
+        """
+                            Constructor.
+        
+                            Args:
+                                ephemeris (Ephemeris): Ephemeris.
+                                gravitational_model (SunGravitationalModel): Gravitational model.
+        """
+    def __repr__(self) -> str:
+        ...
+    def __str__(self) -> str:
+        ...

ostk/physics/environment/object/celestial/moon.pyi

@@ -0,0 +1,2 @@
+from __future__ import annotations
+__all__ = list()

ostk/physics/environment/object/celestial/sun.pyi

@@ -0,0 +1,2 @@
+from __future__ import annotations
+__all__ = list()

ostk/physics/test/coordinate/frame/provider/iers/conftest.py

@@ -6,11 +6,8 @@ import pathlib
 
 from ostk.core.filesystem import Path
 from ostk.core.filesystem import File
-
-import ostk.physics as physics
-
-BulletinA = physics.coordinate.frame.provider.iers.BulletinA
-Finals2000A = physics.coordinate.frame.provider.iers.Finals2000A
+from ostk.physics.coordinate.frame.provider.iers import BulletinA
+from ostk.physics.coordinate.frame.provider.iers import Finals2000A
 
 
 @pytest.fixture

ostk/physics/test/coordinate/frame/provider/iers/test_bulletin_a.py

@@ -6,10 +6,7 @@ from ostk.core.filesystem import File
 
 from ostk.physics.time import Scale
 from ostk.physics.time import Instant
-
-import ostk.physics as physics
-
-BulletinA = physics.coordinate.frame.provider.iers.BulletinA
+from ostk.physics.coordinate.frame.provider.iers import BulletinA
 
 
 class TestBulletinA:

ostk/physics/test/coordinate/frame/provider/iers/test_finals_2000a.py

@@ -6,10 +6,7 @@ from ostk.core.filesystem import File
 
 from ostk.physics.time import Scale
 from ostk.physics.time import Instant
-
-import ostk.physics as physics
-
-Finals2000A = physics.coordinate.frame.provider.iers.Finals2000A
+from ostk.physics.coordinate.frame.provider.iers import Finals2000A
 
 
 class TestFinals2000A:

ostk/physics/test/coordinate/spherical/test_lla.py

@@ -8,7 +8,9 @@ from ostk.core.type import String
 from ostk.physics import Environment
 from ostk.physics.unit import Angle, Length
 from ostk.physics.coordinate.spherical import LLA
+from ostk.physics.coordinate import Frame, Position
 from ostk.physics.environment.gravitational import Earth as EarthGravitationalModel
+from ostk.physics.environment.object.celestial import Earth
 
 Spherical = EarthGravitationalModel.spherical
 WGS84_EGM96 = EarthGravitationalModel.WGS84_EGM96
@@ -488,3 +490,25 @@ class TestLLA:
         )
         assert llas is not None
         assert len(llas) == n_points
+
+    def test_from_position(self):
+        earth = Earth.WGS84()
+        frame = Frame.ITRF()
+        position = Position.meters([6378137.0, 0.0, 0.0], frame)  # Point on equator
+
+        lla = LLA.from_position(position, earth)
+        assert lla is not None
+        assert abs(float(lla.get_latitude().in_degrees())) < 1e-10  # Should be on equator
+
+        assert (
+            abs(float(lla.get_longitude().in_degrees())) < 1e-10
+        )  # Should be at prime meridian
+        assert abs(float(lla.get_altitude().in_meters())) < 1e-6  # Should be near surface
+
+        # Test with undefined position
+        with pytest.raises(RuntimeError):
+            LLA.from_position(Position.undefined())
+
+        # Test with global environment
+        lla = LLA.from_position(position)
+        assert lla is not None

ostk/physics/test/coordinate/test_position.py

@@ -4,203 +4,198 @@ import pytest
 import numpy as np
 
 from ostk.core.type import String
-import ostk.physics as physics
 
-Scale = physics.time.Scale
-DateTime = physics.time.DateTime
-Instant = physics.time.Instant
-Frame = physics.coordinate.Frame
-Position = physics.coordinate.Position
-Unit = physics.unit.Length.Unit
+from ostk.physics import Environment
+from ostk.physics.coordinate import Frame
+from ostk.physics.coordinate import Position
+from ostk.physics.coordinate.spherical import LLA
+from ostk.physics.time import Instant
+from ostk.physics.time import Scale
+from ostk.physics.time import DateTime
+from ostk.physics.unit import Length
 
 
-def test_coordinate_position_constructors():
-    # Construct arbitrary frame
-    frame: Frame = Frame.GCRF()
-    unit: Unit = Unit.Meter
+@pytest.fixture
+def unit() -> Length.Unit:
+    return Length.Unit.Meter
 
-    # Construction with python lists
-    vector = [1000.0, 0.0, 0.0]
 
-    position: Position = Position(vector, unit, frame)
+@pytest.fixture
+def frame() -> Frame:
+    return Frame.GCRF()
 
-    assert position is not None
-    assert isinstance(position, Position)
-    assert position.is_defined()
 
-    # Construction with python tuples
-    vector = (1000.0, 0.0, 0.0)
+@pytest.fixture
+def earth():
+    return Environment.default().access_celestial_object_with_name("Earth")
 
-    position: Position = Position(vector, unit, frame)
 
-    assert position is not None
-    assert isinstance(position, Position)
-    assert position.is_defined()
+@pytest.fixture
+def lla() -> LLA:
+    return LLA.vector([0.0, 0.0, 0.0])
 
-    # Construction with python numpy arrays
-    vector = np.array((1000.0, 0.0, 0.0))
 
-    position: Position = Position(vector, unit, frame)
+class TestPosition:
 
-    assert position is not None
-    assert isinstance(position, Position)
-    assert position.is_defined()
+    def test_constructors(self, unit: Length.Unit, frame: Frame):
+        # Construction with python lists
+        vector = [1000.0, 0.0, 0.0]
 
-    # Construction with meters static constructor
-    position: Position = Position.meters(vector, frame)
+        position: Position = Position(vector, unit, frame)
 
-    assert position is not None
-    assert isinstance(position, Position)
-    assert position.is_defined()
+        assert position is not None
+        assert isinstance(position, Position)
+        assert position.is_defined()
 
-    # Construction with undefined static constructor
-    position: Position = Position.undefined()
+        # Construction with python tuples
+        vector = (1000.0, 0.0, 0.0)
 
-    assert position is not None
-    assert isinstance(position, Position)
-    assert position.is_defined() is False
+        position: Position = Position(vector, unit, frame)
 
+        assert position is not None
+        assert isinstance(position, Position)
+        assert position.is_defined()
 
-def test_coordinate_position_comparators():
-    frame: Frame = Frame.GCRF()
-    unit: Unit = Unit.Meter
-    vector_1 = [1000.0, 0.0, 0.0]
-    vector_2 = [-450.3, 234.9, -23.0]
+        # Construction with python numpy arrays
+        vector = np.array((1000.0, 0.0, 0.0))
 
-    position_1: Position = Position(vector_1, unit, frame)
-    position_2: Position = Position(vector_2, unit, frame)
+        position: Position = Position(vector, unit, frame)
 
-    assert position_1 == position_1
-    assert position_2 == position_2
-    assert position_1 != position_2
+        assert position is not None
+        assert isinstance(position, Position)
+        assert position.is_defined()
 
+        # Construction with meters static constructor
+        position: Position = Position.meters(vector, frame)
 
-def test_coordinate_position_is_defined():
-    frame: Frame = Frame.GCRF()
-    unit: Unit = Unit.Meter
-    vector = [1000.0, 0.0, 0.0]
-    position: Position = Position(vector, unit, frame)
+        assert position is not None
+        assert isinstance(position, Position)
+        assert position.is_defined()
 
-    assert position.is_defined()
-    assert Position.undefined().is_defined() is False
+        # Construction with undefined static constructor
+        position: Position = Position.undefined()
 
+        assert position is not None
+        assert isinstance(position, Position)
+        assert position.is_defined() is False
 
-@pytest.mark.skip
-def test_coordinate_position_is_near():
-    frame: Frame = Frame.GCRF()
-    unit: Unit = Unit.Meter
+    def test_comparators(self, unit: Length.Unit, frame: Frame):
+        vector_1 = [1000.0, 0.0, 0.0]
+        vector_2 = [-450.3, 234.9, -23.0]
 
-    vector_1 = [1000.0, 0.0, 0.0]
-    vector_2 = [1000.00001, 0.0001, 0.0]
+        position_1: Position = Position(vector_1, unit, frame)
+        position_2: Position = Position(vector_2, unit, frame)
 
-    position_1: Position = Position(vector_1, unit, frame)
-    position_2: Position = Position(vector_2, unit, frame)
+        assert position_1 == position_1
+        assert position_2 == position_2
+        assert position_1 != position_2
 
-    assert position_1.is_near(position_2, Unit.Meter)
-    assert position_2.is_near(position_1, Unit.Meter)
+    def test_is_defined(self, unit: Length.Unit, frame: Frame):
+        vector = [1000.0, 0.0, 0.0]
+        position: Position = Position(vector, unit, frame)
 
+        assert position.is_defined()
+        assert Position.undefined().is_defined() is False
 
-def test_coordinate_position_access_frame():
-    frame: Frame = Frame.GCRF()
-    unit: Unit = Unit.Meter
-    vector = [1000.0, 0.0, 0.0]
+    @pytest.mark.skip
+    def test_is_near(self, unit: Length.Unit, frame: Frame):
 
-    position: Position = Position(vector, unit, frame)
+        vector_1 = [1000.0, 0.0, 0.0]
+        vector_2 = [1000.00001, 0.0001, 0.0]
 
-    ans_frame = position.access_frame()
+        position_1: Position = Position(vector_1, unit, frame)
+        position_2: Position = Position(vector_2, unit, frame)
 
-    assert ans_frame is not None
-    assert isinstance(ans_frame, Frame)
-    assert ans_frame == frame
+        assert position_1.is_near(position_2, Length.Unit.Meter)
+        assert position_2.is_near(position_1, Length.Unit.Meter)
 
+    def test_access_frame(self, unit: Length.Unit, frame: Frame):
+        vector = [1000.0, 0.0, 0.0]
 
-def test_coordinate_position_get_coordinates():
-    frame: Frame = Frame.GCRF()
-    unit: Unit = Unit.Meter
-    vector = [1000.0, 0.0, 0.0]
+        position: Position = Position(vector, unit, frame)
 
-    position: Position = Position(vector, unit, frame)
+        ans_frame = position.access_frame()
 
-    coordinates = position.get_coordinates()
+        assert ans_frame is not None
+        assert isinstance(ans_frame, Frame)
+        assert ans_frame == frame
 
-    assert coordinates is not None
-    assert isinstance(coordinates, np.ndarray)
-    assert np.array_equal(coordinates, vector)
+    def test_get_coordinates(self, unit: Length.Unit, frame: Frame):
+        vector = [1000.0, 0.0, 0.0]
 
+        position: Position = Position(vector, unit, frame)
 
-def test_coordinate_position_get_unit():
-    frame: Frame = Frame.GCRF()
-    unit: Unit = Unit.Meter
-    vector = [1000.0, 0.0, 0.0]
+        coordinates = position.get_coordinates()
 
-    position: Position = Position(vector, unit, frame)
+        assert coordinates is not None
+        assert isinstance(coordinates, np.ndarray)
+        assert np.array_equal(coordinates, vector)
 
-    ans_unit = position.get_unit()
+    def test_get_unit(self, unit: Length.Unit, frame: Frame):
+        vector = [1000.0, 0.0, 0.0]
 
-    assert ans_unit is not None
-    assert isinstance(ans_unit, Unit)
-    assert ans_unit == unit
+        position: Position = Position(vector, unit, frame)
 
+        ans_unit = position.get_unit()
 
-def test_coordinate_position_in_unit():
-    frame: Frame = Frame.GCRF()
-    unit: Unit = Unit.Meter
-    vector = [1000.0, 0.0, 0.0]
+        assert ans_unit is not None
+        assert isinstance(ans_unit, Length.Unit)
+        assert ans_unit == unit
 
-    position: Position = Position(vector, unit, frame)
+    def test_in_unit(self, unit: Length.Unit, frame: Frame):
+        vector = [1000.0, 0.0, 0.0]
 
-    new_position: Position = position.in_unit(Unit.Meter)
+        position: Position = Position(vector, unit, frame)
 
-    assert new_position is not None
-    assert isinstance(new_position, Position)
-    assert new_position == position
+        new_position: Position = position.in_unit(Length.Unit.Meter)
 
-    new_position: Position = position.in_unit(Unit.TerrestrialMile)
+        assert new_position is not None
+        assert isinstance(new_position, Position)
+        assert new_position == position
 
-    assert new_position is not None
-    assert isinstance(new_position, Position)
-    # assert new_position == position
+        new_position: Position = position.in_unit(Length.Unit.TerrestrialMile)
 
+        assert new_position is not None
+        assert isinstance(new_position, Position)
+        # assert new_position == position
 
-def test_coordinate_position_in_meters():
-    frame: Frame = Frame.GCRF()
-    unit: Unit = Unit.Meter
-    vector = [1000.0, 0.0, 0.0]
+    def test_in_meters(self, unit: Length.Unit, frame: Frame):
+        vector = [1000.0, 0.0, 0.0]
 
-    position: Position = Position(vector, unit, frame)
+        position: Position = Position(vector, unit, frame)
 
-    new_position: Position = position.in_meters()
+        new_position: Position = position.in_meters()
 
-    assert new_position is not None
-    assert isinstance(new_position, Position)
-    assert new_position == position
+        assert new_position is not None
+        assert isinstance(new_position, Position)
+        assert new_position == position
 
+    def test_in_frame(self, unit: Length.Unit, frame: Frame):
+        vector = [1000.0, 0.0, 0.0]
 
-def test_coordinate_position_in_frame():
-    frame: Frame = Frame.GCRF()
-    unit: Unit = Unit.Meter
-    vector = [1000.0, 0.0, 0.0]
+        instant: Instant = Instant.date_time(DateTime(2020, 1, 1, 0, 0, 0), Scale.UTC)
 
-    instant: Instant = Instant.date_time(DateTime(2020, 1, 1, 0, 0, 0), Scale.UTC)
+        position: Position = Position(vector, unit, frame)
 
-    position: Position = Position(vector, unit, frame)
+        new_position: Position = position.in_frame(frame, instant)
 
-    new_position: Position = position.in_frame(frame, instant)
+        assert new_position is not None
+        assert isinstance(new_position, Position)
+        assert new_position == position
 
-    assert new_position is not None
-    assert isinstance(new_position, Position)
-    assert new_position == position
+    def test_to_string(self, unit: Length.Unit, frame: Frame):
+        vector = [1000.0, 0.0, 0.0]
 
+        position: Position = Position(vector, unit, frame)
 
-def test_coordinate_position_to_string():
-    frame: Frame = Frame.GCRF()
-    unit: Unit = Unit.Meter
-    vector = [1000.0, 0.0, 0.0]
+        string: String = position.to_string()
 
-    position: Position = Position(vector, unit, frame)
+        assert string is not None
+        assert isinstance(string, String)
+        assert string == "[1000.0, 0.0, 0.0] [m] @ GCRF"
 
-    string: String = position.to_string()
+    def test_from_lla(self, lla: LLA, earth):
+        assert Position.from_lla(lla, earth) is not None
 
-    assert string is not None
-    assert isinstance(string, String)
-    assert string == "[1000.0, 0.0, 0.0] [m] @ GCRF"
+        Environment.default(True)
+        assert Position.from_lla(lla) is not None