siderust 0.9.1

High-precision astronomy and satellite mechanics in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

// SPDX-License-Identifier: AGPL-3.0-or-later
// Copyright (C) 2026 Vallés Puig, Ramon

//! TLE mean-element propagator producing typed TEME Cartesian states.
//!
//! ## What this module is
//!
//! * A type-preserving Siderust-native TLE mean-element propagator. Inputs are
//!   typed [`crate::formats::tle::TLE`] records and
//!   target epochs are typed [`tempoch::JulianDate<tempoch::UTC>`]. Outputs are
//!   typed [`TemeState`] values: a geocentric **TEME** position in kilometres
//!   and a velocity in km·s⁻¹.
//! * Supports near-Earth and deep-space TLE orbital periods.
//!
//! ## What this module is *not*
//!
//! * It is **not** a full SGP4/SDP4 implementation. It applies secular J2
//!   node/perigee/mean-anomaly drift and solves Kepler's equation, but does
//!   *not* include the periodic corrections, Lyddane deep-space drag, or
//!   resonance terms of the Vallado/AFSPC SGP4 reference.
//! * It does not perform TEME → ITRF / GCRF rotations.
//! * It does not implement orbit determination, force models, or estimation.
//!
//! ## Example
//!
//! ```
//! use siderust::astro::sgp4::TlePropagator;
//! use siderust::formats::tle::parse_3le;
//! use siderust::qtty::Minutes;
//!
//! let tle = parse_3le(
//!     "ISS (ZARYA)",
//!     "1 25544U 98067A   08264.51782528 -.00002182  00000-0 -11606-4 0  2927",
//!     "2 25544  51.6416 247.4627 0006703 130.5360 325.0288 15.72125391563537",
//! ).unwrap();
//! let prop = TlePropagator::from_tle(&tle).unwrap();
//! let state = prop.propagate_minutes(Minutes::new(0.0)).unwrap();
//! assert!(state.position().distance().value() > 6_500.0);
//! assert!(state.velocity().magnitude().value() > 5.0);
//! ```

#![forbid(unsafe_code)]

mod elements;
mod error;
mod propagator;
mod state;

pub use error::Sgp4Error;
pub use propagator::{GravityModel, TlePropagator};
pub use state::{KilometerPerSecond, TemePositionKm, TemeState, TemeVelocityKmPerSec};

/// Backward-compatible name for the TLE mean-element propagator.
///
/// New code may use [`TlePropagator`] when the TLE input contract is the
/// important part of the API, or `Sgp4Propagator` when matching existing SGP4
/// example code.
pub type Sgp4Propagator = TlePropagator;