:py:mod:`exo_k.aerosols`
========================

.. py:module:: exo_k.aerosols

.. autoapi-nested-parse::

   @author: jeremy leconte



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

.. py:class:: Aerosols(aer_reffs_densities=None, a_database=None)


   Bases: :py:obj:`exo_k.util.spectral_object.Spectral_object`

   Dict-like class to handle aerosol composition, reff, and density, and link this to the optical propoerties.


   __init__ Instantiates an aerosols object.


   .. py:method:: set_aer_reffs_densities(aer_reffs_densities=None)

      Set the dictionary with the arrays of the effective radii and number densities for the aerosols.

      .. warning::
          The unit and physical meaning of the result may change depending on the
          quantity provided in aer_reffs_densities (number density or ratio of particle to gas number density).
          See :func:`exo_k.atable.Atable.absorption_coefficient` for further details.

          For use in the amtospheric model, one should provide the particle to gas number density ratio.

      :param aer_reffs_densities: 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 (or ratio of aerosol to gas number density).
      :type aer_reffs_densities: :class:`dict`


   .. py:method:: set_a_database(a_database=None)

      Change the radiative database attached to the current instance of aerosols

      :param a_database: New Adatabase to use.
      :type a_database: :class:`~exo_k.kdatabase.Kdatabase` object


   .. py:method:: optical_properties(aer_reffs_densities=None, wl_range=None, wn_range=None, log_interp=True, compute_all_opt_prop=True, **kwargs)

      Compute the optical properties for the mix.

      :param aer_reffs_densities: 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 (or ratio of aerosol to gas number density).
                                  See :func:`exo_k.atable.Atable.absorption_coefficient` for further details.
      :type aer_reffs_densities: :class:`dict`

      :param wl_range: Wavelength or wavenumber range to consider
      :type wl_range: :class:`two-value list`
      :param wn_range: Wavelength or wavenumber range to consider
      :type wn_range: :class:`two-value list`
      :param log_interp: Whether the interpolation is linear in kdata or in log(kdata).
      :type log_interp: :class:`bool`, *optional*
      :param compute_all_opt_prop: Whether to compute all the optical properties or just the extinction.
      :type compute_all_opt_prop: :class:`bool`, *optional*


   .. py:method:: absorption_coefficient(aer_reffs_densities=None, wl_range=None, wn_range=None, log_interp=True, **kwargs)

      Compute the aerosol opacity for the mix.

      :param aer_reffs_densities: 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 (or ratio of aerosol to gas number density).
                                  See :func:`exo_k.atable.Atable.absorption_coefficient` for further details.
      :type aer_reffs_densities: :class:`dict`

      :param wl_range: Wavelength or wavenumber range to consider
      :type wl_range: :class:`two-value list`
      :param wn_range: Wavelength or wavenumber range to consider
      :type wn_range: :class:`two-value list`
      :param log_interp: Whether the interpolation is linear in kdata or in log(kdata).
      :type log_interp: :class:`bool`, *optional*