boinor.bodies
=============

.. py:module:: boinor.bodies

.. autoapi-nested-parse::

   Bodies of the Solar System.

   Contains some predefined bodies of the Solar System:

   * Sun (☉)
   * Earth (♁)
   * Moon (☾)
   * Mercury (☿)
   * Venus (♀)
   * Mars (♂)
   * Jupiter (♃)
   * Saturn (♄)
   * Uranus (⛢)
   * Neptune (♆)
   * Pluto (♇)
   * Phobos
   * Deimos
   * Europa
   * Ganyemede
   * Enceladus
   * Titan
   * Titania
   * Triton
   * Charon


   and a way to define new bodies (:py:class:`~Body` class).

   Data references can be found in :py:mod:`~boinor.constants`



Attributes
----------

.. autoapisummary::

   boinor.bodies.Sun
   boinor.bodies.Mercury
   boinor.bodies.Venus
   boinor.bodies.Earth
   boinor.bodies.Mars
   boinor.bodies.Jupiter
   boinor.bodies.Saturn
   boinor.bodies.Uranus
   boinor.bodies.Neptune
   boinor.bodies.Pluto
   boinor.bodies.Moon
   boinor.bodies.Phobos
   boinor.bodies.Deimos
   boinor.bodies.Europa
   boinor.bodies.Ganymede
   boinor.bodies.Enceladus
   boinor.bodies.Titan
   boinor.bodies.Titania
   boinor.bodies.Triton
   boinor.bodies.Charon


Classes
-------

.. autoapisummary::

   boinor.bodies.Body
   boinor.bodies.SolarSystemPlanet


Module Contents
---------------

.. py:class:: Body

   Bases: :py:obj:`namedtuple`\ (\ :py:obj:`'_Body'`\ , [\ :py:obj:`'parent'`\ , :py:obj:`'k'`\ , :py:obj:`'name'`\ , :py:obj:`'symbol'`\ , :py:obj:`'R'`\ , :py:obj:`'R_polar'`\ , :py:obj:`'R_mean'`\ , :py:obj:`'rotational_period'`\ , :py:obj:`'J2'`\ , :py:obj:`'J3'`\ , :py:obj:`'mass'`\ , :py:obj:`'mean_a'`\ ]\ )


   class to contain data from bodies of the solar system


   .. py:attribute:: __slots__
      :value: ()



   .. py:property:: angular_velocity

      Return angular velocity of Body.


   .. py:method:: __str__()

      Return str(self).



   .. py:method:: __reduce__()

      Helper for pickle.



   .. py:method:: __repr__()

      Return repr(self).



   .. py:method:: tmp_G()

      pylint detects an import error with G, so we add a test whether G is available



   .. py:method:: from_parameters(parent, k, name, symbol, R, **kwargs)
      :classmethod:


      create body object from parameters



   .. py:method:: from_relative(reference, parent, k, name, symbol=None, R=0, **kwargs)
      :classmethod:


      create body object from relative object



.. py:class:: SolarSystemPlanet

   Bases: :py:obj:`Body`


   class to contain data from planets of the solar system

   this class only adds a plotting function to its parent class Body()


   .. py:method:: plot(epoch=None, label=None, plane=Planes.EARTH_ECLIPTIC, backend=None)

      Plots the body orbit.

      :param epoch: Epoch of current position.
      :type epoch: astropy.time.Time, optional
      :param label: Label for the orbit, defaults to empty.
      :type label: str, optional
      :param plane: Reference plane of the coordinates.
      :type plane: ~boinor.frames.Planes
      :param backend: An instance of ``OrbitPlotterBackend`` for rendendering the scene.
      :type backend: ~boinor.plotting.orbit.backends._base.OrbitPlotterBackend



   .. py:attribute:: __slots__
      :value: ()



   .. py:property:: angular_velocity

      Return angular velocity of Body.


   .. py:method:: __str__()

      Return str(self).



   .. py:method:: __reduce__()

      Helper for pickle.



   .. py:method:: __repr__()

      Return repr(self).



   .. py:method:: tmp_G()

      pylint detects an import error with G, so we add a test whether G is available



   .. py:method:: from_parameters(parent, k, name, symbol, R, **kwargs)
      :classmethod:


      create body object from parameters



   .. py:method:: from_relative(reference, parent, k, name, symbol=None, R=0, **kwargs)
      :classmethod:


      create body object from relative object



.. py:data:: Sun

.. py:data:: Mercury

.. py:data:: Venus

.. py:data:: Earth

.. py:data:: Mars

.. py:data:: Jupiter

.. py:data:: Saturn

.. py:data:: Uranus

.. py:data:: Neptune

.. py:data:: Pluto

.. py:data:: Moon

.. py:data:: Phobos

.. py:data:: Deimos

.. py:data:: Europa

.. py:data:: Ganymede

.. py:data:: Enceladus

.. py:data:: Titan

.. py:data:: Titania

.. py:data:: Triton

.. py:data:: Charon