Rust API Reference¶
The Rust API reference is on docs.rs/satkit, built from the doc comments of each release.
Where to find what:
- Crate root: the most used types, re-exported:
Instant,Duration,TimeScale,Frame,ITRFCoord,TLE,Kepler,SatState,PropSettings,propagate,Vector3,Quaternion.satkit::preludebrings these and a few more into scope withuse satkit::prelude::*;. - Modules by topic:
frametransform(rotations),itrfcoord,tle,omm,sgp4,orbitprop(numerical propagation),jplephem,lpephem,kepler,lambert,earthgravity,nrlmsise(atmospheric density),consts. - Data management:
utils(update_datafiles, data directories, offline mode),earth_orientation_paramsandspaceweather(loading and coverage of the tables). - Errors: each module's
Errorenum is documented in that module; see Errors.
The Python API reference is under API Reference. The two APIs mirror each other closely, with Python-style names (satkit.time for Instant, satkit.satstate for SatState); the migration guide lists Rust-only changes per release.