Skip to content

Lox Python API Reference

Welcome to the Python API reference for lox - an ergonomic astrodynamics library.

import lox_space as lox

Overview

Lox provides tools for space mission analysis and orbital mechanics:

  • High-precision time handling with multiple astronomical time scales
  • Orbital states in Cartesian and Keplerian representations
  • Propagators for orbit prediction (analytical and SGP4)
  • Ground station analysis and visibility calculations
  • RF link budgets for space communication systems
  • Coordinate transformations between reference frames

Quick Start

import lox_space as lox

# Create a time instant
t = lox.Time("TAI", 2024, 1, 1, 12, 0, 0.0)

# Define an orbital state (LEO)
state = lox.Cartesian(
    time=t,
    x=6678.0 * lox.km, y=0.0 * lox.km, z=0.0 * lox.km,
    vx=0.0 * lox.km_per_s, vy=7.73 * lox.km_per_s, vz=0.0 * lox.km_per_s,
)

# Convert to Keplerian elements
kep = state.to_keplerian()
print(f"Semi-major axis: {kep.semi_major_axis().to_kilometers():.1f} km")
print(f"Orbital period: {kep.orbital_period()}")

# Propagate the orbit
propagator = lox.Vallado(state)
future_state = propagator.propagate(t + lox.TimeDelta.from_hours(1.5))

API Sections

Section Description
Time & Dates Time, UTC, TimeDelta, TimeScale, TimeSeries
Celestial Bodies Origin
Reference Frames Frame, SPK
Orbital States Cartesian, Keplerian, Trajectory
Propagators Vallado, SGP4, TLE, GroundPropagator
Ground Stations EllipsoidLocation, Ellipsoid, ElevationMask, Observables, Pass
Events & Visibility Event, Interval, intersect_intervals, union_intervals, complement_intervals, GroundStation, Spacecraft, Scenario, Ensemble, VisibilityAnalysis, VisibilityResults, PowerBudgetAnalysis, PowerBudgetResults
Imaging Aoi, OpticalPayload, OpticalAccessAnalysis, SarPayload, LookSide, SarAccessAnalysis, AccessResults
Communications TxChain, RxChain, AmplifierTransmitter, NoiseTempReceiver, CascadeReceiver, Channel, ModCod, LinkBudget, PropagationLosses, fspl, freq_overlap
Constellations Constellation, ConstellationSatellite
Data Providers EOPProvider, Series
Units Angle, Distance, Frequency, Velocity