:py:mod:`pytmosph3r.planetary_system.planet`
============================================

.. py:module:: pytmosph3r.planetary_system.planet


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

.. py:function:: mass_to_surface_gravity(mass: astropy.units.Quantity[pytmosph3r.util.pt.mass], radius: astropy.units.Quantity[pytmosph3r.util.pt.length])

   Compute the gravity at the surface of a sphere of radius `radius` and mass `mass`.

   :param mass: Mass of the planet.
   :type mass: Quantity[mass]
   :param radius: Radius of the planet.
   :type radius: Quantity[length]

   :returns: Return the gravity at the surface of the planet.
   :rtype: (Quantity[acceleration])


.. py:class:: Planet(surface_gravity: Union[float, astropy.units.Quantity[pytmosph3r.util.pt.acceleration]], radius: Union[float, astropy.units.Quantity[pytmosph3r.util.pt.length]], **kwargs)


   Bases: :py:obj:`pytmosph3r.log.Logger`

   Represent a planet, while allowing to get the position of the star in the planet frame.

   :param surface_gravity: Surface gravity of the planet (m.s-2)
   :type surface_gravity: float
   :param radius: Radius of the planet (m)
   :type radius: float

   .. py:property:: mass

      Planet mass (:math:`kg`).

   .. py:property:: mass_jup
      :type: float

      Planet mass (in `Jupiter mass`).

   .. py:property:: radius_jup
      :type: float

      Planet radius (in `Jupiter radii`).

   .. py:attribute:: radius

      Planet radius (in `m`).

   .. py:attribute:: surface_gravity

      Surface gravity (:math:`m\cdot s^{-2}`).

   .. py:method:: build(model=None)


   .. py:method:: fromJupiter(surface_gravity: float, radius: float)
      :classmethod:

      Create a `Planet` object using Jupiter values.

      :param surface_gravity: Surface gravity in `m s-2`
      :type surface_gravity: float
      :param radius: Planet radius in Jupiter radius.
      :type radius: float


   .. py:method:: gravity(height: float) -> float

      Gravity (:math:`m\cdot s^{-2}`) at height (:math:`m`) from planet.