.. currentmodule:: orbitx

.. _api:

#############
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.

.. add package's API's functions, classes, methods etc. to the below toctree

.. autosummary::
   :toctree: generated/

   TLE
   TLE.from_sat_shortname
   TLE.from_filepath
   TLE.__len__

   Orbit
   Orbit.simulate
   Orbit.from_netcdf
   Orbit.to_netcdf
   Orbit.plot
   Orbit.__len__
   Orbit.__eq__

   Matchups
   Matchups.find_matchups
   Matchups.from_netcdf
   Matchups.to_netcdf
   Matchups.plot
   Matchups.__len__
   Matchups.__eq__