API reference

This page provides an auto-generated summary of orbitx’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

TLE(tle_xarray)	Class to retrieve satellite TLEs.
TLE.from_sat_shortname(satellite_shortname, ...)	Generates a TLE object from the satellite shortname
TLE.from_filepath(tle_filepath, ...[, ...])	Generates a TLE object from a TLE file.
TLE.__len__()	The number of TLEs included in this object
Orbit(orbit)	Class to simulate satellite orbits
Orbit.simulate(satellites, start_date, ...)	Main generator for the Orbit class
Orbit.from_netcdf(input_path)	Loads an Orbit object from a netcdf file.
Orbit.to_netcdf(output_path)	Saves the generated orbits to a netCDF file
Orbit.plot([projection])	Plots the simulated orbits
Orbit.__len__()	Number of positions simulated in the orbits
Orbit.__eq__(value)	Checks if two orbit objects are identical
Matchups(data)	Class to find matchup events between multiple satellites
Matchups.find_matchups(satellites, ...[, ...])	Main generator for Matchups object
Matchups.from_netcdf(input_path)	Loads a Matchup object from a netCDF4 file
Matchups.to_netcdf(output_path)	Exports a matchup object to a netcdf file
Matchups.plot([projection, show_events])	Plot the matchup dataset generated from orbitx.interface.return_matchups
Matchups.__len__()	__len__ Number of matchups in this object
Matchups.__eq__(other)	Return self==value.