sidereon_core/
lib.rs

1//! # sidereon-core
2//!
3//! The complete Sidereon engine in one crate. It folds the numerical
4//! astrodynamics core (orbit propagation, force models, frames, time, SGP4)
5//! together with the GNSS domain layer (SP3, broadcast ephemeris, multi-GNSS
6//! positioning, RTK/PPP, ionosphere/troposphere, DOP).
7//!
8//! - The propagation/astro layer is always present under the [`astro`] module.
9//! - The GNSS layer lives behind the default-on `gnss` cargo feature, so a
10//!   propagation-only consumer can build with `--no-default-features` (plus
11//!   any astro features it wants) and never compile the IONEX/SP3 parsers.
12//!
13//! The GNSS façade is organized by user-facing tasks:
14//!
15//! - [`ephemeris`] - precise SP3 and broadcast ephemeris products,
16//! - [`rinex`] - RINEX navigation/observation parsing and CRINEX decoding,
17//! - [`antex`] - ANTEX receiver and satellite antenna calibration parsing,
18//! - [`combinations`] - observable linear combinations such as ionosphere-free,
19//! - [`observables`] - forward range, Doppler, and azimuth/elevation prediction,
20//! - [`velocity`] - receiver velocity and clock-drift solve from range-rate data,
21//! - [`positioning`] - single-point positioning and DOP diagnostics,
22//! - [`dgnss`] - code-differential pseudorange correction and rover pairing,
23//! - [`quality`] - pseudorange weighting, RAIM, and FDE integrity checks,
24//! - [`signal`] - GPS C/A code generation, correlation, and acquisition,
25//! - [`ppp_corrections`] - static-arc PPP correction precomputation,
26//! - [`atmosphere`] - ionosphere and troposphere corrections,
27//! - [`orbit`] - compact reduced-orbit fitting/evaluation.
28//!
29//! Implementation modules (`sp3`, `rinex_nav`, `spp`, etc.) are crate-private.
30//! This is a clean public surface rather than a compatibility shim around the
31//! original implementation-shaped module layout.
32//!
33//! ## Units policy (internal representation)
34//!
35//! All quantities are stored and computed in **SI base units**, with the frame
36//! and datum encoded in the type name (per the spec's frames-in-the-type-system
37//! rule), never hidden behind a bare `position_m`:
38//!
39//! - **Length / position:** meters (`_m`). SP3 positions are ITRF/IGS-frame
40//!   ECEF meters; SPP receiver positions are WGS84/ITRF-compatible ECEF meters.
41//!   (The [`astro`] state layer works in kilometers; conversions happen
42//!   explicitly at the boundary, never implicitly.)
43//! - **Time / clock:** seconds (`_s`). Epochs are represented by the [`astro`]
44//!   time family (`Instant`/`TimeScale`), always scale-tagged; there is no bare
45//!   ambiguous epoch.
46//! - **Velocity:** meters per second (`_m_s`).
47//! - **Angles:** radians (`_rad`) internally. Degrees appear only at I/O edges
48//!   and are named `_deg`.
49//! - **Frequency:** hertz (`_hz`).
50//!
51//! Field and parameter names carry the unit suffix so the unit is visible at
52//! every call site. Matrix/vector linear algebra uses `nalgebra`
53//! (`DMatrix`/`DVector`) per the spec.
54
55extern crate self as sidereon_core;
56
57// ---------------------------------------------------------------------------
58// Astro / propagation layer. Always present. The GNSS layer below depends on
59// it via `crate::astro::*`.
60// ---------------------------------------------------------------------------
61
62mod validate;
63
64#[cfg(all(test, sidereon_repo_tests))]
65mod test_parity;
66
67pub mod astro;
68pub(crate) mod format;
69
70// ---------------------------------------------------------------------------
71// GNSS domain layer. Behind the default-on `gnss` feature so a propagation-only
72// consumer can opt out. Additional product modules are added as each lands.
73// ---------------------------------------------------------------------------
74
75mod ambiguity; // shared RTK/PPP cycle-slip policy + wide-lane/narrow-lane prep
76mod antenna; // shared ANTEX PCV/PCO zenith/azimuth interpolation kernels
77pub mod antex; // ANTEX receiver/satellite antenna parser + PCO/PCV lookup
78pub mod bias; // Bias-SINEX and DCB bias products
79mod broadcast; // broadcast-ephemeris (GPS LNAV / Galileo I/NAV) orbit + clock
80pub mod broadcast_comparison; // broadcast-vs-precise (SISRE orbit/clock) accuracy
81pub mod carrier_phase; // carrier-phase combinations, cycle-slip detection, Hatch smoothing
82pub mod constants; // shared physical/time constants (used by astro + gnss)
83pub mod constellation; // GNSS constellation identity catalog (CelesTrak/NAVCEN)
84mod crinex; // Hatanaka (CRINEX) observation-file decoder
85pub mod data; // sans-IO GNSS product filename and archive URL catalog
86mod dop; // dilution-of-precision geometry (GDOP/PDOP/HDOP/VDOP/TDOP)
87pub mod frequencies; // canonical GNSS carrier-frequency table
88mod glonass; // GLONASS PZ-90.11 state-vector RK4 propagation
89mod ionex; // Klobuchar broadcast model + IONEX ionospheric maps
90pub mod navigation; // navigation-message bit-level codecs (GPS LNAV)
91pub mod observables; // forward GNSS observable prediction
92pub mod ppp_corrections; // static-arc PPP correction tables
93pub mod precise_positioning; // static multi-epoch PPP float solve
94mod reduced_orbit; // compact mean-element orbit approximation (fitted)
95mod rinex_clock; // RINEX clock satellite-bias parsing and interpolation
96mod rinex_common; // shared RINEX header concepts (time-system label mapping)
97mod rinex_nav; // RINEX 3 navigation-message parsing (GPS/Galileo broadcast)
98mod rinex_obs; // RINEX 3 observation parsing + single-frequency pseudoranges
99pub mod rtcm; // RTCM 3 differential-GNSS stream decode/encode (MSM, station, ephemeris)
100pub mod rtk; // RTK double-difference construction
101pub mod sbas;
102pub mod signal; // GPS C/A code, coherent correlation, and acquisition
103mod sp3; // SP3-c / SP3-d parser + arbitrary-epoch interpolation
104mod spp; // single-point positioning (least-squares PVT)
105pub mod ssr; // SSR correction store and corrected broadcast ephemeris source
106pub mod staleness; // product-staleness graceful degradation for time-varying products
107mod tropo; // Saastamoinen zenith + Niell (NMF) mapping troposphere
108pub mod velocity; // receiver velocity / clock-drift least-squares solve
109
110mod error;
111pub mod frame;
112mod id;
113
114pub mod atmosphere;
115pub mod combinations;
116pub mod dgnss;
117pub mod ephemeris;
118pub mod estimation; // Phase-2 estimation substrate: named operation-order recipes
119pub mod geoid; // geoid undulation grid + bilinear interpolation (orthometric heights)
120pub mod geometry;
121pub mod ils; // integer least squares ambiguity-resolution kernels
122pub mod orbit;
123pub mod positioning;
124pub mod prelude;
125pub mod quality; // measurement weighting, RAIM, and FDE integrity checks
126pub mod rinex;
127pub mod rtk_filter; // sequential RTK baseline filter - serializable state ABI (kernel migration)
128pub mod terrain;
129pub mod tides;
130pub mod tolerances;
131
132pub use error::{Error, Result};
133pub use frame::{
134    geodetic_to_itrf, itrf_to_geodetic, FrameValueError, ItrfPositionM, ItrfVelocityMS,
135    Wgs84Geodetic,
136};
137pub use geoid::{
138    ellipsoidal_height_m, geoid_undulation, orthometric_height_m, GeoidError, GeoidGrid,
139};
140pub use id::{GnssSatelliteId, GnssSystem, SatelliteIdError};
sidereon_core/lib.rs

sidereon_core/
lib.rs
