open-space-toolkit-astrodynamics 17.2.0__py312-none-manylinux2014_x86_64.whl

ostk/astrodynamics/converters.py

@@ -0,0 +1,130 @@
+# Apache License 2.0
+
+from __future__ import annotations
+
+import re
+
+from datetime import datetime, timezone
+
+from ostk.physics.time import Instant
+from ostk.physics.time import Interval
+from ostk.physics.time import Scale
+
+
+def coerce_to_datetime(value: Instant | datetime | str) -> datetime:
+    """
+    Return datetime from value.
+
+    Args:
+        value (Instant | datetime | str): A value to coerce.
+
+    Returns:
+        datetime: The coerced datetime.
+    """
+
+    if isinstance(value, datetime):
+        return value
+
+    if isinstance(value, Instant):
+        return value.get_date_time(Scale.UTC).replace(tzinfo=timezone.utc)
+
+    if isinstance(value, str):
+        if value.endswith("Z"):
+            value = value.replace("Z", "+00:00")
+
+        return datetime.fromisoformat(value)
+
+    raise TypeError(
+        f"Argument is of type [{type(value)}]. Must be a datetime, an Instant, or a str."
+    )
+
+
+def coerce_to_instant(value: Instant | datetime | str) -> Instant:
+    """
+    Return Instant from value.
+
+    Args:
+        value (Instant | datetime | str): A value to coerce.
+
+    Returns:
+        Instant: The coerced Instant.
+    """
+
+    if isinstance(value, Instant):
+        return value
+
+    if isinstance(value, datetime):
+        return Instant.date_time(value.astimezone(tz=timezone.utc), Scale.UTC)
+
+    if isinstance(value, str):
+        return coerce_to_instant(coerce_to_datetime(value))
+
+    raise TypeError(
+        f"Argument is of type [{type(value)}]. Must be a datetime, an Instant, or a str."
+    )
+
+
+def coerce_to_iso(value: Instant | datetime | str, timespec: str = "microseconds") -> str:
+    """
+    Return an ISO string from value.
+
+    Args:
+        value (Instant | datetime | str): A value to coerce.
+        timespec (str): A time resolution. Defaults to "microseconds".
+
+    Returns:
+        str: The coerced ISO string.
+    """
+
+    if isinstance(value, str):
+        return coerce_to_iso(coerce_to_datetime(value), timespec=timespec)
+
+    if isinstance(value, datetime):
+        return value.isoformat(timespec=timespec)
+
+    if isinstance(value, Instant):
+        return coerce_to_iso(coerce_to_datetime(value), timespec=timespec)
+
+    raise TypeError(
+        f"Argument is of type [{type(value)}]. Must be a datetime, an Instant, or a str."
+    )
+
+
+def coerce_to_interval(
+    value: (
+        Interval
+        | tuple[Instant, Instant]
+        | tuple[datetime, datetime]
+        | tuple[str, str]
+        | str
+    ),
+) -> Interval:
+    """
+    Return Interval from value.
+
+    Args:
+        value (Interval | tuple[Instant, Instant] | tuple[datetime, datetime] | tuple[str, str]): A value to coerce.
+
+    Returns:
+        Interval: The coerced Interval.
+    """
+
+    if isinstance(value, Interval):
+        return value
+
+    if isinstance(value, str):
+        regex = r"\[(.*) - (.*)\] \[UTC\]"
+        matches = re.search(regex, value)
+
+        if matches:
+            return Interval.closed(
+                start_instant=coerce_to_instant(matches.group(1)),
+                end_instant=coerce_to_instant(matches.group(2)),
+            )
+
+        raise ValueError(f"String [{value}] does not match the expected format.")
+
+    return Interval.closed(
+        start_instant=coerce_to_instant(value[0]),
+        end_instant=coerce_to_instant(value[1]),
+    )

ostk/astrodynamics/converters.pyi

@@ -0,0 +1,58 @@
+from __future__ import annotations
+from datetime import datetime
+from datetime import timezone
+from ostk.physics.time import Instant
+from ostk.physics.time import Interval
+from ostk.physics.time import Scale
+import re as re
+import typing
+__all__ = ['Instant', 'Interval', 'Scale', 'coerce_to_datetime', 'coerce_to_instant', 'coerce_to_interval', 'coerce_to_iso', 'datetime', 're', 'timezone']
+def coerce_to_datetime(value: Instant | datetime | str) -> datetime:
+    """
+    
+        Return datetime from value.
+    
+        Args:
+            value (Instant | datetime | str): A value to coerce.
+    
+        Returns:
+            datetime: The coerced datetime.
+        
+    """
+def coerce_to_instant(value: Instant | datetime | str) -> Instant:
+    """
+    
+        Return Instant from value.
+    
+        Args:
+            value (Instant | datetime | str): A value to coerce.
+    
+        Returns:
+            Instant: The coerced Instant.
+        
+    """
+def coerce_to_interval(value: Interval | tuple[Instant, Instant] | tuple[datetime, datetime] | tuple[str, str] | str) -> Interval:
+    """
+    
+        Return Interval from value.
+    
+        Args:
+            value (Interval | tuple[Instant, Instant] | tuple[datetime, datetime] | tuple[str, str]): A value to coerce.
+    
+        Returns:
+            Interval: The coerced Interval.
+        
+    """
+def coerce_to_iso(value: Instant | datetime | str, timespec: str = 'microseconds') -> str:
+    """
+    
+        Return an ISO string from value.
+    
+        Args:
+            value (Instant | datetime | str): A value to coerce.
+            timespec (str): A time resolution. Defaults to "microseconds".
+    
+        Returns:
+            str: The coerced ISO string.
+        
+    """

ostk/astrodynamics/data/__init__.pyi

@@ -0,0 +1,3 @@
+from __future__ import annotations
+from . import provider
+__all__ = ['provider']

ostk/astrodynamics/data/provider.pyi

@@ -0,0 +1,22 @@
+from __future__ import annotations
+import ostk.astrodynamics.trajectory
+import ostk.physics.coordinate
+import ostk.physics.unit
+__all__ = ['compute_off_nadir_angles']
+def compute_off_nadir_angles(state: ostk.astrodynamics.trajectory.State, target_position: ostk.physics.coordinate.Position) -> tuple[ostk.physics.unit.Angle, ostk.physics.unit.Angle, ostk.physics.unit.Angle]:
+    """
+                Compute the along-track, cross-track and total off-nadir angle between the satellite and the target.
+    
+                - The along-track angle is the angle between the nadir vector [Z] and the projection of the satellite->target vector 
+                  onto the plane defined by the satellite local horizontal (velocity vector in circular orbits) [X] and the nadir vector [Z].
+                - The cross-track angle is the angle between the nadir vector [Z] and the projection of the satellite->target vector 
+                  onto the plane defined by the negative orbital momentum vector [Y] and the nadir vector [Z].
+                - The total off-nadir angle is the angle between the nadir vector [Z] and the satellite->target vector.
+    
+                Args:
+                    state (State): The state of the satellite.
+                    target_position (Position): The position of the target.
+    
+                Returns:
+                    tuple[Angle, Angle, Angle]: The along-track, cross-track and total off-nadir angle between the satellite and the target.
+    """