siderust 0.9.0

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
59
60
61
62
63
64
65
66
67

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

//! NAIF SPICE kernel reader and [`SpiceEphemerisProvider`] adapter.
//!
//! This module re-exports the pure kernel-parsing layer from
//! [`crate::formats::spice`] and adds the POD-specific
//! [`SpiceEphemerisProvider`] that implements
//! [`crate::pod::providers::EphemerisProvider`].
//!
//! # Scope
//!
//! The pure DAF/SPK parsing, SPK segment evaluation (Type 2/3/9/13), body
//! chain resolution, and NAIF body-ID lookup all live in
//! `crate::formats::spice`. This module only owns the thin POD
//! adapter:
//!
//! * [`SpiceEphemerisProvider`] — typed adapter implementing
//!   [`crate::pod::providers::EphemerisProvider`]. Center selection
//!   is **explicit** at construction time and is propagated as a typed
//!   `affn` reference center on the returned [`SpiceState`].
//!
//! # Time semantics
//!
//! All epochs are **TDB seconds past J2000**, matching the convention of
//! NAIF SPK files and [`tempoch::J2000s`]. The provider trait method
//! exposes the same numeric convention; the typed `tempoch::EncodedTime`
//! constructor is available via [`SpiceEphemerisProvider::state_at`].
//!
//! # Validation gate
//!
//! Position recovery is byte-identical to NAIF's CSPICE `spkez_c` for
//! the planet body chains in `de440.bsp` / `de441.bsp` at runtime via
//! [`RuntimeEphemeris`](crate::ephemeris::RuntimeEphemeris).
//! that loads a kernel from disk (`SIDERUST_SPICE_DE_PATH`) and
//! compares against committed reference states.
//!
//! # Examples
//!
//! ```rust
//! use siderust::formats::spice::{daf::{Daf, Summary}, segment_for_summary, SpiceError};
//!
//! let daf = Daf { nd: 2, ni: 6, summaries: vec![] };
//! let summary = Summary {
//!     start_et: 0.0, end_et: 1.0, target_id: 1, center_id: 0,
//!     frame_id: 1, data_type: 21, start_word: 1, end_word: 1,
//! };
//! let err = segment_for_summary(&0.0_f64.to_le_bytes(), &daf, &summary).unwrap_err();
//! assert!(matches!(err, SpiceError::UnsupportedDataType { data_type: 21 }));
//! # Ok::<_, SpiceError>(())
//! ```

#![forbid(unsafe_code)]
#![deny(missing_docs)]

mod provider;

pub use provider::{SpiceEphemerisProvider, SpiceState};

// Re-export the full upstream spice parsing surface.
pub use crate::formats::spice::{
    daf, kernel, naif,
    naif::{naif_id_for_name, well_known},
    segment,
    segment::{segment_for_summary, ChebSegment, SpkSegment},
    spk, LoadedSegment, SpiceError, SpkKernel,
};