:mod:`pytmosph3r.planet`
========================

.. py:module:: pytmosph3r.planet


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

.. py:class:: Planet(surface_gravity=None, radius=None, r_units='m')

   Bases: :class:`pytmosph3r.log.Logger`

   Planet properties.

   :param surface_gravity: Surface gravity of the planet.
   :type surface_gravity: float
   :param radius: Radius of the planet (by default in meters, see :py:attr:`r_units` for changing the units).
   :type radius: float
   :param r_units: Length unit for the radius ('m' for meters, 'Rjup' for Jupiter radius, i.e., 71492000 m, ...). See https://docs.astropy.org/en/stable/units/index.html#module-astropy.units for more units.
   :type r_units: str, optional

   .. attribute:: surface_gravity
      

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


   .. attribute:: radius
      

      Planet radius (in `m`).


   .. method:: mass(self)


      Planet mass (:math:`kg`).


   .. method:: mass_jup(self)


      Planet mass (in `Jupiter mass`).


   .. method:: radius_jup(self)


      Planet radius (in `Jupiter radii`).


   .. method:: gravity(self, height)


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


   .. method:: inputs(self)