:py:mod:`pytmosph3r.aerosols`
=============================

.. py:module:: pytmosph3r.aerosols


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

.. py:class:: PrepareAerosols(model, atm, size)


   Transform aerosols (from mmr, reff and condensate_density) to a format suitable to exo_k (reff and nb_density).


   Initialize the aer_reff_densities to a exo_k-compatible format.

   :param model: The model from which to extract some data.
   :type model: :class:`~pytmosph3r.model.Model`
   :param atm: The atmosphere from which to extract some data.
   :type atm: :class:`~pytmosph3r.atmosphere.Atmosphere`
   :param size: Size of the data (reff & nb_density) for each molecule.
   :type size: int

   .. py:attribute:: aer_reff_densities

      Dictionary that should be compatible with exo_k. Its keys should be the aerosol names and the values should be lists containing 2 floats (or arrays) as values. The values are the particle effective radii and number densities.  See `absorption_coefficient()`_ in the doc of exo_k:

      .. _absorption_coefficient():
      http://perso.astrophy.u-bordeaux.fr/~jleconte/exo_k-doc/autoapi/exo_k/adatabase/index.html?highlight=absorption_coefficient#exo_k.adatabase.Adatabase.absorption_coefficient

   .. py:method:: compute(i, coordinates)

      Compute the value of aer_reff_densities at :attr:`coordinates`, which will be stored at index :attr:`i`. The input :attr:`aerosols` dictionary should contain a MMR :attr:`mmr` (in `kg/kg`), and effective radius :attr:`reff` (in `m`), and :attr:`condensate_density` (in :math:`kg/m^3`).

      :param i: index.
      :type i: int, slice
      :param coordinates: cell coordinates.
      :type coordinates: tuple

      :returns: A dictionary with aerosol names as keys and lists containing 2 floats (or arrays) as values. The values are the particle effective radii and number densities.
      :rtype: dict