Scarabaeus API#

This reference manual details the modules, classes, and methods included in Scarabaeus. Each module contains classes relevant to itself. For more in-depth descriptions of each, see its respective section below.


Body#

The Body module defines objects in the orbit determination process. This includes planets, ground stations, and spacecraft, along with the solid-tide, pole-tide, and ocean-loading displacements of a station on a deforming body.

Dynamics#

The Dynamics module provides functionality for modeling the dynamic environment acting on a spacecraft. This includes modeling of Keplerian accelerations, 3rd body perturbations, higher-order fidelity gravitational modeling (spherical harmonics, polyhedral), solar radiation pressure, thermal and antenna radiation recoil, empirical accelerations (Gauss-Markov, piecewise polynomial, Fourier series) in inertial, RTN, or body-fixed frames, impulsive, smoothed impulsive and finite burn modeling, and user-defined force models with their own estimated parameters.

Environment#

The Environment module provides high-level representations used to define the environment of an orbit-determination scenario. This includes state vector definitions, trajectory containers, numerical propagators, and multi-leg mission sequences.

Finite Burn#

The Finite Burn module provides functionality for modeling finite burn maneuvers, including maneuver sequencing and parsing of maneuver definitions for use in trajectory propagation and orbit determination.

Guidance#

The Guidance module provides functionality for guidance tasks such as B-Plane targeting and maneuver planning.

Measurements#

The Measurements module provides functionality for both computed and observed measurement modeling, multi-type measurement datasets, and computation of partial derivatives. Supported observables include radiometric (range, range-rate, Doppler, sequential ranging), optical (angles and centroids) and user-defined measurements, along with tools to schedule, configure, and register measurement streams.

Orbit Determination#

The Orbit Determination (OD) module implements OD and filtering algorithms, including batch least-squares, linearized Kalman filter, square-root information filter, and smoother variants, as well as user-defined estimators. Also includes process noise models, multi-arc estimation, filter management, iteration control, and solution containers.

Spacecraft#

The Spacecraft module provides functionalities that define various properties of a spacecraft body, including sensors (imagers, antennas), actuators (thrusters), structural elements, n-plate models, and power-generation models.

Time & Frame#

The Time and Frame module provides tools for handling reference frame and time referencing systems. A dedicated set of classes manages reference frame definition, transformation, and storage, as well as epoch representation and SPICE integration.

Units#

The Units module provides tools to manage both physical dimensions and units across Scarabaeus, ensuring correct operations, clear interfaces, and continuity when performing calculations using physical properties.

Uncertainty Quantification#

The Uncertainty Quantification module provides tools for uncertainty quantification in the orbit determination process, including covariance matrix construction, propagation, and analysis.

Utilities#

The Utilities module provides utility tools leveraged across the entirety of Scarabaeus, including constants definitions, noise generation, orbital element conversion, polynomial representations, plotting utilities, serialization helpers, spherical harmonics of polyhedral shape models, a statistical distance between OD solutions, and the wrapper for user-supplied functions.

Scarabaeus Rust#

The Scarabaeus Rust module contains computationally expensive algorithms written in Rust instead of Python and exposes them as classes and functions to the rest of Scarabaeus: the IAS15 integrator, the Chebyshev ephemeris cache, and the spherical-harmonics, n-plate SRP, and polyhedron gravity kernels behind the Python models.