:py:mod:`pytmosph3r.observations.parallel`
==========================================

.. py:module:: pytmosph3r.observations.parallel


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

.. py:function:: transit_depth_angle(transmission, rk, nprocs, *args, **kwargs)


.. py:function:: transit_depth_grid(transmission, rk, nprocs, *args, **kwargs)


.. py:function:: transit_depth_wn(transmission, rk, nprocs, *args, **kwargs)


.. py:function:: transit_depth_i(transmission, rk, nprocs, dimension, *args, **kwargs)

   Returns a list of integrals that will be concatenated/stacked together with the rest.


.. py:class:: Parallel(name, nprocs=None, dimension='rays')


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

   Base class for a parallel version of the transit depth (see :class:`~pytmosph3r.transmission.Transmission`).

   :param nprocs: number of procs (by default, maximum).
   :type nprocs: int
   :param dimension: Dimension to subdivide among workers. Possible values are `spectral`, `angles`, or `rays`. A `spectral` subdivision shares the spectral range among the workers, `angles` means the angular points of the rays grid are used, while `rays` means all of the rays grid is shared among the workers.
   :type dimension: str

   .. py:attribute:: nprocs

      

   .. py:method:: synchronize(model)


   .. py:method:: compute_integral(transmission, *args, **kwargs)

      Compute integral over :attr:`nprocs` processes by subdividing the work along the spectral dimension (if :attr:`dimension` is "spectral) or rays dimension(s).



   .. py:method:: retrieve_results(results)



.. py:class:: MultiProcTransit(nprocs=None, *args, **kwargs)


   Bases: :py:obj:`Parallel`

   Base class for a parallel version of the transit depth (see :class:`~pytmosph3r.transmission.Transmission`).

   :param nprocs: number of procs (by default, maximum).
   :type nprocs: int
   :param dimension: Dimension to subdivide among workers. Possible values are `spectral`, `angles`, or `rays`. A `spectral` subdivision shares the spectral range among the workers, `angles` means the angular points of the rays grid are used, while `rays` means all of the rays grid is shared among the workers.
   :type dimension: str