API reference¶
The public Python API is small and stable across the package's top-level
namespace. Everything documented here is re-exported from gmat_run; import
from the top level rather than from submodules:
The reference splits into one page per module:
- Mission — load a
.scriptand run it. The main entry point (Mission.load, dotted-path field access,Mission.run). - Results — the value returned by
Mission.run:reports,ephemerides,contacts, andsolver_runsas lazyMapping[str, pandas.DataFrame], plusResults.persist. - Mission summary — the dataclass schema returned by
Mission.summary(MissionSummary,ResourceGroup,CommandOutline). - Install discovery —
locate_gmatand theGmatInstalldataclass. - Runtime bootstrap —
bootstrap, thegmatpyloader behindMission.load. - Exceptions —
GmatErrorand the five leaf classes. - Parsers —
gmat_run.parsers, the standalone functions for ReportFile, EphemerisFile (CCSDS-OEM / STK-TimePosVel / SPK), CCSDS-AEM attitude, ContactLocator, solver-iteration logs, and epoch-column promotion. You normally do not call these directly —Mission.rundispatches to the right one for you.