satkit 0.24.0__cp315-cp315-win_amd64.whl

satkit/__init__.py

@@ -0,0 +1,9 @@
+from .satkit import *  # type: ignore
+from ._types import OMMDict
+from .satkit import __version__
+
+# The core data (IERS nutation tables, public-domain gravity models to degree 70) is
+# compiled into the extension, so satkit works with no data directory at all.
+# The JPL ephemeris is downloaded (SHA-256 verified) on first use into
+# `satkit.utils.datadir()`, and the Earth-orientation / space-weather files
+# are refreshed by `satkit.utils.update_datafiles()`.

satkit/__init__.pyi

@@ -0,0 +1,59 @@
+from .satkit import *
+from ._types import OMMDict
+
+from . import jplephem
+from . import frametransform
+from . import moon
+from . import sun
+from . import density
+from . import utils
+from . import planets
+from . import spaceweather
+
+__version__: str
+
+__all__ = [
+    "time",
+    "duration",
+    "timescale",
+    "weekday",
+    "quaternion",
+    "frame",
+    "sgp4",
+    "sgp4_error",
+    "sgp4_gravconst",
+    "sgp4_opsmode",
+    "gravmodel",
+    "gravity",
+    "gravity_and_partials",
+    "nrlmsise00",
+    "density",
+    "solarsystem",
+    "TLE",
+    "itrfcoord",
+    "geodetic",
+    "kepler",
+    "consts",
+    "frametransform",
+    "jplephem",
+    "utils",
+    "moon",
+    "sun",
+    "planets",
+    "spaceweather",
+    "satstate",
+    "propagate",
+    "lambert",
+    "propsettings",
+    "integrator",
+    "satproperties",
+    "thrust",
+    "propresult",
+    "propstats",
+    "omm_from_url",
+    "omm_from_file",
+    "omm_from_text",
+    "OMMDict",
+    "tlefitstatus",
+    "__version__",
+]

satkit/_types.py

@@ -0,0 +1,72 @@
+"""Pure-Python types shared by the stubs and the runtime package."""
+
+from __future__ import annotations
+
+import datetime
+from typing import TYPE_CHECKING, TypedDict
+
+if TYPE_CHECKING:
+    from .satkit import time
+
+__all__ = ["OMMDict"]
+
+
+class OMMDict(TypedDict, total=False):
+    """An Orbital Mean-Element Message (OMM) as a plain dictionary
+
+    This is the shape returned by :func:`omm_from_url`, :func:`omm_from_file`,
+    :func:`omm_from_text` and :meth:`TLE.to_omm`, and accepted by :func:`sgp4`
+    and :meth:`TLE.from_omm`. It is an ordinary ``dict`` (this class exists for
+    type checking only): the keys are the CCSDS 502.0-B-3 field names, so
+    ``json.load`` on a Space-Track or CelesTrak JSON response produces one
+    directly. Every key is optional in the type; :func:`sgp4` needs ``EPOCH``
+    and the six mean elements.
+
+    Units follow the TLE convention: angles in degrees, ``MEAN_MOTION`` in
+    revolutions per day, ``MEAN_MOTION_DOT`` in rev/day² and
+    ``MEAN_MOTION_DDOT`` in rev/day³ (the TLE fields, i.e. ṅ/2 and n̈/6),
+    ``BSTAR`` in inverse Earth radii, ``GM`` in km³/s², ``MASS`` in kg, areas in
+    m², ``BTERM`` and ``AGOM`` in m²/kg.
+
+    The loaders return numbers as ``float`` / ``int`` (Space-Track quotes them
+    as strings in its JSON; :func:`sgp4` accepts either), ``EPOCH`` as an
+    RFC 3339 string, absent optional fields omitted, and every key that is not
+    a CCSDS field (Space-Track's ``OBJECT_TYPE``, ``RCS_SIZE``, ``LAUNCH_DATE``,
+    ``TLE_LINE1``, ...; XML ``USER_DEFINED`` parameters) kept verbatim.
+    """
+
+    CCSDS_OMM_VERS: str
+    COMMENT: str
+    ORIGINATOR: str
+    CLASSIFICATION: str
+    MESSAGE_ID: str
+    OBJECT_NAME: str
+    OBJECT_ID: str
+    CENTER_NAME: str
+    REF_FRAME: str
+    REF_FRAME_EPOCH: str
+    TIME_SYSTEM: str
+    MEAN_ELEMENT_THEORY: str
+    EPOCH: str | time | datetime.datetime
+    MEAN_MOTION: float | str
+    ECCENTRICITY: float | str
+    INCLINATION: float | str
+    RA_OF_ASC_NODE: float | str
+    ARG_OF_PERICENTER: float | str
+    MEAN_ANOMALY: float | str
+    GM: float | str | None
+    MASS: float | str | None
+    SOLAR_RAD_AREA: float | str | None
+    DRAG_AREA: float | str | None
+    SOLAR_RAD_COEFF: float | str | None
+    DRAG_COEFF: float | str | None
+    EPHEMERIS_TYPE: int | str | None
+    CLASSIFICATION_TYPE: str
+    NORAD_CAT_ID: int | str | None
+    ELEMENT_SET_NO: int | str | None
+    REV_AT_EPOCH: int | str | None
+    BSTAR: float | str | None
+    BTERM: float | str | None
+    MEAN_MOTION_DOT: float | str | None
+    MEAN_MOTION_DDOT: float | str | None
+    AGOM: float | str | None

satkit/density.pyi

@@ -0,0 +1,96 @@
+"""
+Air density models
+
+Currently only contains NRL MSISE-00 air density model
+"""
+
+from __future__ import annotations
+import typing
+
+import satkit
+from .satkit import TimeScalar
+
+@typing.overload
+def nrlmsise(
+    itrf: satkit.itrfcoord, time: TimeScalar | None = None, /
+) -> tuple[float, float]:
+    """
+    NRL MSISE-00 Atmosphere Density Model
+
+    <https://en.wikipedia.org/wiki/NRLMSISE-00>
+
+    or for more detail:
+    <https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2002JA009430>
+
+    Args:
+
+        itrf (satkit.itrfcoord):  position at which to compute density & temperature
+        time (satkit.time|datetime.datetime, optional):  Instant at which to compute
+               density & temperature. "Space weather" data at this time will be
+               used in model computation.  Note: at satellite altitudes, density can
+               change by > 10 X depending on solar cycle. Without a time the model
+               runs on its default indices (F10.7 = F10.7A = 150, Ap = 4).
+
+    Returns:
+        tuple: (rho, T) where rho is mass density in kg/m^3 and T is temperature in Kelvin
+
+    Raises:
+        TypeError: If ``time`` is not a ``satkit.time``, ``datetime.datetime``,
+            ``numpy.datetime64`` or ``None``
+
+    Example:
+        ```python
+        t = satkit.time(2024, 1, 1)
+        coord = satkit.itrfcoord(latitude_deg=0, longitude_deg=0, altitude=400e3)
+        rho, temp = satkit.density.nrlmsise(coord, t)
+        print(f"Density: {rho:.2e} kg/m^3")
+        print(f"Temperature: {temp:.1f} K")
+        ```
+    """
+    ...
+
+@typing.overload
+def nrlmsise(
+    altitude_meters: float,
+    latitude_rad: float = 0.0,
+    longitude_rad: float = 0.0,
+    time: TimeScalar | None = None,
+    /,
+) -> tuple[float, float]:
+    """
+    NRL MSISE-00 Atmosphere Density Model
+
+    <https://en.wikipedia.org/wiki/NRLMSISE-00>
+
+    or for more detail:
+    <https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2002JA009430>
+
+    Args:
+        altitude_meters (float):  Altitude in meters
+        latitude_rad (float, optional):  Latitude in radians. Default is 0.
+        longitude_rad (float, optional):  Longitude in radians.  Default is 0.
+        time (satkit.time|datetime.datetime, optional):  Instant at which to compute
+               density & temperature. "Space weather" data at this time will be
+               used in model computation.  Note: at satellite altitudes, density can
+               change by > 10 X depending on solar cycle. Without a time the model
+               runs on its default indices (F10.7 = F10.7A = 150, Ap = 4). The time
+               may also directly follow the altitude or the latitude.
+
+    Returns:
+        tuple: (rho, T) where rho is mass density in kg/m^3 and T is temperature in Kelvin
+
+    Raises:
+        TypeError: If an angle is not a real number, or ``time`` is not a
+            ``satkit.time``, ``datetime.datetime``, ``numpy.datetime64`` or ``None``
+    """
+    ...
+
+@typing.overload
+def nrlmsise(
+    altitude_meters: float, time: TimeScalar | None, /
+) -> tuple[float, float]: ...
+
+@typing.overload
+def nrlmsise(
+    altitude_meters: float, latitude_rad: float, time: TimeScalar | None, /
+) -> tuple[float, float]: ...