boinor.earth
============

.. py:module:: boinor.earth

.. autoapi-nested-parse::

   Earth focused orbital mechanics routines.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/boinor/earth/atmosphere/index
   /autoapi/boinor/earth/enums/index
   /autoapi/boinor/earth/plotting/index
   /autoapi/boinor/earth/util/index


Classes
-------

.. autoapisummary::

   boinor.earth.EarthSatellite


Package Contents
----------------

.. py:class:: EarthSatellite(orbit, spacecraft)

   Position and velocity of a body with respect to Earth
   at a given time.


   .. py:property:: orbit

      Orbit of the EarthSatellite.


   .. py:property:: spacecraft

      Spacecraft of the EarthSatellite.


   .. py:method:: propagate(tof, atmosphere=None, gravity=None, *args)

      Propagates an 'EarthSatellite Orbit' at a specified time.

      If value is true anomaly, propagate orbit to this anomaly and return the result.
      Otherwise, if time is provided, propagate this `EarthSatellite Orbit` some `time` and return the result.

      :param tof: Scalar time to propagate.
      :type tof: ~astropy.units.Quantity, ~astropy.time.Time, ~astropy.time.TimeDelta
      :param atmosphere: a callable model from boinor.earth.atmosphere
      :param gravity: There are two possible values, SPHERICAL and J2. Only J2 is implemented at the moment. Default value is None.
      :type gravity: EarthGravity
      :param \*args: parameters used in perturbation models.

      :returns: A new EarthSatellite with the propagated Orbit
      :rtype: EarthSatellite