satkit 0.8.4__cp314-cp314-win_amd64.whl → 0.9.0__cp314-cp314-win_amd64.whl

satkit/_version.py

@@ -14,5 +14,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = "0.8.4"
-__version_tuple__ = version_tuple = (0, 8, 4)
+__version__ = version = "0.9.0"
+__version_tuple__ = version_tuple = (0, 9, 0)

satkit/satkit.pyi

@@ -261,7 +261,7 @@ class TLE:
         """
 
 def sgp4(
-    tle: TLE | list[TLE],
+    tle: TLE | list[TLE] | dict,
     tm: time | list[time] | npt.ArrayLike,
     **kwargs,
 ) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
@@ -276,7 +276,7 @@ def sgp4(
         https://celestrak.org/publications/AIAA/2008-6770/AIAA-2008-6770.pdf
 
     Args:
-        tle (TLE | list[TLE]): TLE (or list of TLES) on which to operate
+        tle (TLE | list[TLE] | dict): TLE or OMM (or list of TLES) on which to operate
         tm (time | list[time] | npt.ArrayLike[time]): time(s) at which to compute position and velocity
 
     Keyword Args:
@@ -294,6 +294,12 @@ def sgp4(
         Additional return value if errflag is True:
         list[sgp4_error]: list of errors for each TLE and time output, if errflag is True
 
+    Note:
+        Now supports propagation of OMM (Orbital Mean-Element Message) dictionaries
+        The dictionaries must follow the structure used by https://www.celestrak.org or
+        https://www.space-track.org.
+
+
     Example:
         >>> lines = [
         >>>        "0 INTELSAT 902",
@@ -317,6 +323,20 @@ def sgp4(
         >>> # Print ITRF coordinate object location
         >>> print(coord)
         ITRFCoord(lat:  -0.0363 deg, lon:  -2.2438 deg, hae: 35799.51 km)
+
+    Example 2:
+        >>> import requests
+        >>> import json
+        >>>
+        >>> # Query ephemeris for the International Space Station (ISS)
+        >>> url = 'https://celestrak.org/NORAD/elements/gp.php?CATNR=25544&FORMAT=json'
+        >>> with requests.get(url) as response:
+        >>>     omm = response.json()
+        >>> # Get a representative time from the output
+        >>> epoch = sk.time(omm[0]['EPOCH'])
+        >>> # Compute TEME position & velocity at epoch
+        >>> pteme, vteme = satkit.sgp4(omm[0], epoch)
+
     """
 
 class sgp4_gravconst:
@@ -968,9 +988,30 @@ class time:
             satkit.time: Time object representing the same instant in time as the input "datetime.datetime" object
         """
 
-    def datetime(self, utc: bool = True) -> datetime.datetime:
+    def as_datetime(self, utc: bool = True) -> datetime.datetime:
         """Convert object to "datetime.datetime" object representing same instant in time.
 
+        Args:
+            utc (bool, optional): Whether to make the "datetime.datetime" object represent time in the local timezone or "UTC".  Default is True
+
+        Returns:
+            datetime.datetime: "datetime.datetime" object representing the same instant in time as the "satkit.time" object
+
+        Example:
+            >>> dt = satkit.time(2023, 6, 3, 6, 19, 34).as_datetime(True)
+            >>> print(dt)
+            2023-06-03 06:19:34+00:00
+            >>>
+            >>> dt = satkit.time(2023, 6, 3, 6, 19, 34).as_datetime(False)
+            >>> print(dt)
+            2023-06-03 02:19:34
+        """
+
+    def datetime(self, utc: bool = True) -> datetime.datetime:
+        """Deprecated: use :meth:`satkit.time.as_datetime`.
+
+        Convert object to "datetime.datetime" object representing same instant in time.
+
         Args:
             utc (bool, optional): Whether to make the "datetime.datetime" object represent time in the local timezone or "UTC".  Default is True
 
@@ -1393,6 +1434,36 @@ class duration:
             Duration: 2 days, 12 hours, 0 minutes, 0.000 seconds
         """
 
+    @typing.overload
+    def __truediv__(self, other: float) -> duration:
+        """Divide (or scale) duration by given value
+
+        Args:
+            other (float): value by which to divide duration
+
+        Returns:
+            duration: Duration object representing the input duration divided by the input value
+
+        Example:
+            >>> print(duration.from_days(1) / 2)
+            Duration: 12 hours, 0 minutes, 0.000 seconds
+        """
+
+    @typing.overload
+    def __truediv__(self, other: duration) -> float:
+        """Divide (or scale) duration by another duration to get a dimensionless ratio
+
+        Args:
+            other (duration): duration by which to divide current duration
+
+        Returns:
+            float: Dimensionless ratio of the two durations
+
+        Example:
+            >>> print(duration.from_hours(1) / duration.from_minutes(30))
+            2.0
+        """
+
     def __gt__(self, other: duration) -> bool:
         """Compare two durations for greater than
 
@@ -1649,6 +1720,39 @@ class quaternion:
             satkit.quaternion: Conjugate or inverse of the rotation
         """
 
+    @property
+    def x(self) -> float:
+        """X component of the quaternion
+
+        Returns:
+            float: X component of the quaternion
+        """
+
+    @property
+    def y(self) -> float:
+        """Y component of the quaternion
+
+        Returns:
+            float: Y component of the quaternion
+        """
+
+    @property
+    def z(self) -> float:
+        """Z component of the quaternion
+
+        Returns:
+            float: Z component of the quaternion
+        """
+
+    @property
+    def w(self) -> float:
+        """Scalar component of the quaternion
+
+        Returns:
+            float: Scalar component of the quaternion
+        """
+
+
     @typing.overload
     def __mul__(self, other: quaternion) -> quaternion:
         """Multiply by another quaternion to concatenate rotations
@@ -2172,7 +2276,7 @@ class propresult:
 
     Notes:
 
-    * If "enable_interp" is set to True in the propagation settings, the propresult object can be used to interpolate solutions at any time between the start and stop times of the propagation via the "interp" method
+    * If "enable_interp" is set to True in the propagation settings, the propresult object can be used to interpolate solutions at any time between the begin and end times of the propagation via the "interp" method
 
     """
 
@@ -2213,10 +2317,10 @@ class propresult:
         """
 
     @property
-    def state_start(self) -> npt.NDArray[np.float64]:
-        """6-element state (pos + vel) of satellite in meters & meters/second at start of propagation
+    def state_begin(self) -> npt.NDArray[np.float64]:
+        """6-element state (pos + vel) of satellite in meters & meters/second at begin of propagation
         Returns:
-            npt.NDArray[np.float64]: 6-element numpy array representing state of satellite in meters & meters/second at start of propagation
+            npt.NDArray[np.float64]: 6-element numpy array representing state of satellite in meters & meters/second at begin of propagation
         """
 
     @property
@@ -2239,12 +2343,12 @@ class propresult:
         """
 
     @property
-    def time_start(self) -> time:
-        """Time at which state_start is valid
+    def time_begin(self) -> time:
+        """Time at which state_begin is valid
 
 
         Returns:
-            satkit.time: Time at which state_start is valid
+            satkit.time: Time at which state_begin is valid
         """
 
     @property
@@ -2335,7 +2439,7 @@ class propsettings:
         * use_jplephem: True
         * enable_interp: True
 
-    * enable_interp enables high-preciion interpolation of state between start and stop times via the returned function,
+        * enable_interp enables high-preciion interpolation of state between begin and end times via the returned function,
       it is enabled by default.  There is a small increase in computational efficiency if set to false
 
     """
@@ -2349,7 +2453,7 @@ class propsettings:
             gravity_order (int, optional keyword): Earth gravity order to use in ODE integration. Default is 4
             use_spaceweather (bool, optional keyword): Use space weather data when computing atmospheric density for drag forces. Default is True
             use_jplephem (bool, optional keyword): Use JPL ephemeris for solar system bodies. Default is True
-            enable_interp (bool, optional keyword): Store intermediate data that allows for fast high-precision interpolation of state between start and stop times. Default is True
+            enable_interp (bool, optional keyword): Store intermediate data that allows for fast high-precision interpolation of state between begin and end times. Default is True
 
 
         Returns:
@@ -2408,30 +2512,30 @@ class propsettings:
     def use_spaceweather(self, value: bool) -> None: ...
     @property
     def enable_interp(self) -> bool:
-        """Store intermediate data that allows for fast high-precision interpolation of state between start and stop times
+        """Store intermediate data that allows for fast high-precision interpolation of state between begin and end times
         If not needed, there is a small computational advantage if set to False
         """
 
     @enable_interp.setter
     def enable_interp(self, value: bool) -> None: ...
     def precompute_terms(
-        self, start: time, stop: time, step: Optional[duration] = None
+        self, begin: time, end: time, step: Optional[duration] = None
     ):
-        """Precompute terms for fast interpolation of state between start and stop times
+        """Precompute terms for fast interpolation of state between begin and end times
 
         This can be used, for example, to compute sun and moon positions only once if propagating many satellites over the same time period
 
         Args:
-            start (satkit.time): Start time of propagation
-            stop (satkit.time): Stop time of propagation
+            begin (satkit.time): Begin time of propagation
+            end (satkit.time): End time of propagation
             step (satkit.duration, optional): Step size for interpolation.  Default = 60 seconds
 
         """
 
 def propagate(
     state: npt.NDArray[np.float64],
-    start: time,
-    stop: time,
+    begin: time,
+    end: time,
     **kwargs,
 ) -> propresult:
     """High-precision orbit propagator
@@ -2440,12 +2544,12 @@ def propagate(
 
     Args:
         state (npt.ArrayLike[float], optional): 6-element numpy array representing satellite GCRF position and velocity in meters and meters/second
-        start (satkit.time, optional): satkit.time object representing instant at which satellite is at "pos" & "vel"
-        stop (satkit.time, optional keyword): satkit.time object representing instant at which new position and velocity will be computed
-        duration (satkit.duration, optional keyword): duration from "start" at which new position & velocity will be computed.
-        duration_secs (float, optional keyword): duration in seconds from "start" for at which new position and velocity will be computed.
-        duration_days (float, optional keyword): duration in days from "start" at which new position and velocity will be computed.
-        output_phi (bool, optional keyword): Output 6x6 state transition matrix between "starttime" and "stoptime" (and at intervals, if specified)
+        begin (satkit.time, optional): satkit.time object representing instant at which satellite is at "pos" & "vel"
+        end (satkit.time, optional keyword): satkit.time object representing instant at which new position and velocity will be computed
+        duration (satkit.duration, optional keyword): duration from "begin" at which new position & velocity will be computed.
+        duration_secs (float, optional keyword): duration in seconds from "begin" for at which new position and velocity will be computed.
+        duration_days (float, optional keyword): duration in days from "begin" at which new position and velocity will be computed.
+        output_phi (bool, optional keyword): Output 6x6 state transition matrix between "begintime" and "endtime" (and at intervals, if specified)
         propsettings (propsettings, optional keyword): "propsettings" object with input settings for the propagation. if left out, default will be used.
         satproperties (satproperties_static, optional keyword): "sat_properties_static" object with drag and radiation pressure succeptibility of satellite.
 
@@ -2461,7 +2565,7 @@ def propagate(
         * Sun, Moon gravity
         * Radiation pressured
         * Atmospheric drag: NRL-MISE 2000 density model, with option to include space weather effects (which can be large)
-    * Stop time must be set by keyword argument, either explicitely or by duration
+    * End time must be set by keyword argument, either explicitely or by duration
     * Solid Earth tides are not (yet) included in the model
 
     """

{satkit-0.8.4.dist-info → satkit-0.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: satkit
-Version: 0.8.4
+Version: 0.9.0
 Summary: Satellite Orbital Dynamics Toolkit
 Author-email: Steven Michael <ssmichael@gmail.com>
 Maintainer-email: Steven Michael <ssmichael@gmail.com>
@@ -40,6 +40,9 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy>=1.0.0
 Requires-Dist: satkit-data>=0.7.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: xmltodict; extra == "test"
 Dynamic: license-file
 
 # Satellite Toolkit (satkit)
@@ -48,7 +51,7 @@ Dynamic: license-file
 
 Satkit provides robust, high-performance satellite orbital mechanics calculations with a clean, intuitive API. Built from the ground up in Rust for maximum performance and memory safety, it offers complete Python bindings for all functionality, making advanced orbital mechanics accessible to both systems programmers and data scientists.
 
------ 
+-----
 
 ![Build Passing?](https://github.com/ssmichael1/satkit/actions/workflows/build.yml/badge.svg)
 ![Wheel Passing?](https://github.com/ssmichael1/satkit/actions/workflows/wheels.yml/badge.svg)
@@ -62,7 +65,7 @@ Satkit provides robust, high-performance satellite orbital mechanics calculation
 ![PyPI - Status](https://img.shields.io/pypi/status/satkit)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/satkit)
 ![Read the Docs](https://img.shields.io/readthedocs/satellite-toolkit)
- 
+
 ------
 
 ## Language Bindings
@@ -84,7 +87,7 @@ High-precision conversions between multiple reference frames with full support f
   - **CIRF** - Celestial Intermediate Reference Frame (IAU-2006 intermediate)
   - **TIRF** - Terrestrial Intermediate Reference Frame (Earth-rotation intermediate)
   - **Geodetic** - Latitude, longitude, altitude with WGS-84 ellipsoid
-  
+
 ### Orbit Propagation
 Multiple propagation methods optimized for different accuracy and performance requirements:
   - **Numerical Integration**: High-precision propagation using adaptive Runge-Kutta 9(8) methods with dense output
@@ -95,27 +98,29 @@ Multiple propagation methods optimized for different accuracy and performance re
     - Full AFSPC and improved mode support
     - TLE fitting from high-precision states with drag estimation
     - Batch processing for multiple satellites
+    - Support TLE and Orbital Mean-Element Messages
   - **Keplerian**: Fast analytical two-body propagation for preliminary analysis
-  
-### Force Models
+
+### Numerical Integration Force Models
 Comprehensive perturbation modeling for high-fidelity orbit propagation:
   - **Earth Gravity**: Spherical harmonic models up to degree/order 360
     - Multiple models: JGM2, JGM3, EGM96, ITU GRACE16
     - Efficient computation with configurable truncation order
     - Gravity gradient support for state transition matrix
   - **Third-Body Gravity**: Solar and lunar perturbations using JPL ephemerides
-  - **Atmospheric Drag**: NRLMSISE-00 density model with space weather integration
+  - **Atmospheric Drag**:
+    - NRLMSISE-00 density model with space weather integration
     - Automatic space weather data updates (F10.7, Ap index)
     - Configurable ballistic coefficients
   - **Solar Radiation Pressure**: Cannon-ball model with shadow function
-  
-### Ephemerides
+
+### Solar System Ephemerides
 Access to high-precision solar system body positions:
   - **JPL DE440/DE441**: State-of-the-art planetary ephemerides
     - Chebyshev polynomial interpolation for accuracy
     - Support for all major planets, sun, moon, and solar system barycenter
   - **Low-Precision Models**: Fast analytical models for sun and moon when high precision isn't required
-  
+
 ### Time Systems
 Comprehensive support for all standard astronomical time scales:
   - **UTC** - Coordinated Universal Time with leap second handling
@@ -125,7 +130,7 @@ Comprehensive support for all standard astronomical time scales:
   - **UT1** - Universal Time with Earth orientation corrections
   - **GPS** - GPS Time
   - Automatic conversion between all time scales with microsecond precision
-  
+
 ### Geodetic Utilities
 - **Geodesic Calculations**: Accurate distance and azimuth between ground locations using Vincenty's formulae
 - **Coordinate Conversions**: ITRF ↔ Geodetic ↔ East-North-Up ↔ North-East-Down
@@ -178,12 +183,12 @@ The library requires external data files for various calculations. These are aut
   - DE440/DE441 planetary ephemerides (~100 MB)
   - Provides positions of sun, moon, planets, and solar system barycenter
   - Valid for years 1550-2650 CE
-  
+
 - **Gravity Models** ([ICGEM](http://icgem.gfz-potsdam.de/home))
   - JGM2, JGM3, EGM96, ITU GRACE16 spherical harmonic coefficients
   - International Centre for Global Earth Models standardized format
   - Up to degree/order 360 for high-fidelity propagation
-  
+
 - **IERS Nutation Tables** ([IERS Conventions](https://www.iers.org/IERS/EN/Publications/TechnicalNotes/tn36.html))
   - IAU-2006 nutation series coefficients
   - Required for GCRF ↔ ITRF transformations
@@ -196,7 +201,7 @@ The library requires external data files for various calculations. These are aut
   - Ap geomagnetic index
   - Critical for atmospheric density modeling and drag calculations
   - Updated daily by NOAA Space Weather Prediction Center
-  
+
 - **Earth Orientation Parameters** ([Celestrak](https://celestrak.org/SpaceData/))
   - Polar motion (x, y)
   - UT1-UTC time difference
@@ -218,15 +223,15 @@ The library includes comprehensive test suites ensuring correctness of calculati
 - **JPL Ephemerides**: Validated against JPL-provided test vectors for Chebyshev polynomial interpolation
   - Over 10,000 test cases covering all planets and time ranges
   - Accuracy verified to within JPL's published tolerances (sub-meter precision)
-  
+
 - **SGP4**: Verified using official test vectors from the original C++ distribution
   - All test cases from Vallado's SGP4 implementation
   - Includes edge cases and error conditions
-  
+
 - **Coordinate Transformations**: Cross-validated against multiple reference implementations
   - SOFA library comparisons for IAU-2006 transformations
   - Vallado test cases for GCRF ↔ ITRF conversions
-  
+
 - **Numerical Propagation**: Validated against high-precision commercial tools
   - Orbit fits to GPS SP3 ephemerides
   - Multi-day propagations with sub-meter accuracy
@@ -266,7 +271,7 @@ pip install satkit
 
 Pre-built binary wheels are available for:
 - **Windows**: AMD64
-- **macOS**: Intel (x86_64) and Apple Silicon (ARM64)  
+- **macOS**: Intel (x86_64) and Apple Silicon (ARM64)
 - **Linux**: x86_64 and ARM64 (aarch64)
 - **Python versions**: 3.8, 3.9, 3.10, 3.11, 3.12, 3.13, 3.14
 
@@ -336,9 +341,9 @@ settings.gravity_order = 8
 
 # Propagate for 1 day
 result = sk.propagate(
-    state0, 
-    time0, 
-    stop=time0 + sk.duration.from_days(1),
+    state0,
+    time0,
+    end=time0 + sk.duration.from_days(1),
     propsettings=settings
 )
 
@@ -375,13 +380,13 @@ use satkit::{Instant, SolarSystem, jplephem};
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     // Create time instant
     let time = Instant::from_datetime(2024, 1, 1, 0, 0, 0.0)?;
-    
+
     // Get Moon position and velocity in GCRF
     let (pos, vel) = jplephem::geocentric_state(SolarSystem::Moon, &time)?;
-    
+
     println!("Moon position: {:?}", pos);
     println!("Moon velocity: {:?}", vel);
-    
+
     Ok(())
 }
 ```

{satkit-0.8.4.dist-info → satkit-0.9.0.dist-info}/RECORD

@@ -1,18 +1,18 @@
 satkit/__init__.py,sha256=_N6_4wz07lz7HhjdL-8bUKOlubFC4WJHyTumLoS1ru4,622
 satkit/__init__.pyi,sha256=zqMluH0ZKLDXQK9Z32yiEf2LncSDE8yiHHj9X0DS6Ww,732
-satkit/_version.py,sha256=pko_A_eLBgtgca2NAVwL1CtJv5C9sEnYRNT2KIjdjSY,446
+satkit/_version.py,sha256=yPAtgqyyGYDKGGxCwEzymB8ULCvrs8uAfofuy5v01KY,446
 satkit/density.pyi,sha256=j_25g_QI7LKo0IEq13Y2daSMYnb4pE5ZPHFX6H8gscE,2211
 satkit/frametransform.pyi,sha256=UeVyVbWJppoPkCNWOvUM-MGs7FShVVP0wWh6LE8BPus,15806
 satkit/jplephem.pyi,sha256=5W0tK3-kv5Si-aS7cci1QGTtXC5cAeEbUj5mwIu7IU8,3506
 satkit/moon.pyi,sha256=r151F1_D2J_Zp9YgZfAuuUlqb8OMPUjk610UwhJ0OXs,3510
 satkit/planets.pyi,sha256=MX_4waUoTVM11ftaIEDg8kmdZDId9nuRWUUiMYP6Zvg,1110
 satkit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-satkit/satkit.cp314-win_amd64.pyd,sha256=KcGl91M_aiTqh2nQpdI2yDbO7DJ8Vs_dXLYTTHEmLdM,4691456
-satkit/satkit.pyi,sha256=76po_AyRsCU5MpmhS32-KhWFFjaTfSFV3iYCDL0398E,84827
+satkit/satkit.cp314-win_amd64.pyd,sha256=kEtZ1WKzmmslSRG6HJONiDSNng0ppyVfAuHplcyo5Y0,4700160
+satkit/satkit.pyi,sha256=Bb0rhJN9EVbAeVSFO2vBmLcWZUme4CzzItub3_eEjiA,88098
 satkit/sun.pyi,sha256=Ox7n-JJTNRXFjIR1U0ehbEeecoVss11KFiiKhl28wQs,4217
 satkit/utils.pyi,sha256=f087jRMh4Y4Lghrn-ncIvt16KCQ4Sto_icicvaXgXk4,3085
-satkit-0.8.4.dist-info/licenses/LICENSE,sha256=_G_hwbOSJZqdIWNjgzjFB91eZKvherjtmFfvVvy9wCA,1092
-satkit-0.8.4.dist-info/METADATA,sha256=CQ1ZlNUwua4FLFFjwK5DLnAe3yWm_8p-sh5ZfS7s1-4,17409
-satkit-0.8.4.dist-info/WHEEL,sha256=7k6Wcy588iJYe5lf5K095NLg-uoBTnE-T8eHJ92G4_4,101
-satkit-0.8.4.dist-info/top_level.txt,sha256=1gsJ2XQ64FuUfw4z-i3CDi4Y4z9qcKNcm8Fy6-8xSVE,7
-satkit-0.8.4.dist-info/RECORD,,
+satkit-0.9.0.dist-info/licenses/LICENSE,sha256=_G_hwbOSJZqdIWNjgzjFB91eZKvherjtmFfvVvy9wCA,1092
+satkit-0.9.0.dist-info/METADATA,sha256=WVbRyKx82_Lr9r-WLt7XcT8pJ-RZg7FkkndH7Q_QjHM,17568
+satkit-0.9.0.dist-info/WHEEL,sha256=7k6Wcy588iJYe5lf5K095NLg-uoBTnE-T8eHJ92G4_4,101
+satkit-0.9.0.dist-info/top_level.txt,sha256=1gsJ2XQ64FuUfw4z-i3CDi4Y4z9qcKNcm8Fy6-8xSVE,7
+satkit-0.9.0.dist-info/RECORD,,