pytmosph3r.atmosphere.inputatmosphere
=====================================

.. py:module:: pytmosph3r.atmosphere.inputatmosphere




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

.. py:class:: InputAtmosphere(grid=None, pressure=None, max_pressure=None, min_pressure=None, temperature=None, gas_mix_ratio=None, transparent_gases=None, aerosols=None, winds=None, chemistry=None, molar_mass=None, albedo_surf=None, wn_albedo_cutoff=None)

   Bases: :py:obj:`pytmosph3r.atmosphere.atmosphere.Atmosphere`


   Class to build an atmosphere of your own, which will override the datafile.

   Create the atmosphere you want (or you deserve).

   :param grid: Grid representing the coordinate system (level+layer, latitude,
   :type grid: :class:`~pytmosph3r.grid.Grid3D`
   :param longitude).:
   :param pressure: Pressure for each point in :py:attr:`grid`. Incompatible with
   :type pressure: float, :obj:`array`, optional
   :param :py:attr:`max_pressure`.:
   :param max_pressure: Maximum pressure (at the surface). Incompatible with :py:attr:`pressure`.
   :type max_pressure: float
   :param min_pressure: Minimum pressure to use in the highest column of the model.
   :type min_pressure: float
   :param temperature: Temperature for each point in :py:attr:`grid`. If it is an array
   :type temperature: float, :obj:`array`, dict
   :param or a float:
   :param it will simply define the temperature over the whole grid. If used as a dictionary:
   :param :
   :param it can configure :class:`~pytmosph3r.atmosphere.simple2d.Simple2DTemperature`.:
   :param gas_mix_ratio: Volume Mixing Ratio of gases (dictionary :code:`{'H2O': array, ...}`.
   :type gas_mix_ratio: float, :obj:`array`
   :param transparent_gases: Gases considered transparent (not taken into account for the
   :type transparent_gases: list, optional
   :param contributions).:
   :param aerosols: Aerosols: number density of particles (in number per unit volume).
   :type aerosols: float, :obj:`array`
   :param chemistry: Chemistry module. Either a class of
   :type chemistry: :class:`pytmosph3r.chemistry.Chemistry`
   :param :class:`pytmosph3r.chemistry.Chemistry` or your personal module (which should probably inherit from:
   :param :class:`pytmosph3r.chemistry.Chemistry`:
   :param or at least change the gas mix ratio of the atmosphere).:
   :param albedo_surf: 2d array with the albedo value to use on each column.
   :type albedo_surf: ndarray, optional
   :param wn_albedo_cutoff: 2d array with the cutoff value of the low pass filter on each column.
   :type wn_albedo_cutoff: ndarray, optional


   .. py:attribute:: grid
      :value: None



   .. py:attribute:: pressure
      :value: None


      Pressure (in `Pa`).


   .. py:attribute:: max_pressure
      :value: None


      Max (bottom) pressure in the model (in `Pa`). Optional if using an input file.


   .. py:attribute:: min_pressure
      :value: None


      Min (top) pressure in the model (in `Pa`). Optional if using an input file.


   .. py:attribute:: temperature
      :value: None


      Temperature (in `K`).


   .. py:attribute:: winds
      :value: None



   .. py:attribute:: gas_mix_ratio
      :value: None


      Volume mixing ratios of each gas.


   .. py:attribute:: transparent_gases
      :value: None



   .. py:attribute:: aerosols
      :value: None


      Dictionary for aerosols. Each aerosol is itself a dictionary of which each element indicates the
      MMR, the effective radius and the condensate density of the aerosol.


   .. py:attribute:: altitude
      :value: None



   .. py:attribute:: albedo_surf
      :type:  Optional[Union[float, numpy.ndarray]]
      :value: None



   .. py:attribute:: wn_albedo_cutoff
      :type:  Optional[Union[float, numpy.ndarray]]
      :value: None



   .. py:attribute:: molar_mass
      :value: None


      Molar mass (in `kg/mol`).


   .. py:method:: outputs()