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

sidereon_core/
lib.rs
