propagation_matrix_agenda
=========================

.. currentmodule:: pyarts3.workspace

.. attribute:: Workspace.propagation_matrix_agenda
   :type: ~pyarts3.arts.Agenda
   
   Compute the propagation matrix, the non-LTE source vector, and their derivatives.
   
   The intent of this agenda is to be the workhorse for the propagation matrix
   calculations that are happening deep in your ARTS method calls.
   
   .. tip::
       Use :func:`~pyarts3.workspace.Workspace.propagation_matrix_agendaAuto` after having defined
       your absorption data to create this agenda.  It covers most use-cases.
   
   It is possible to execute :attr:`~pyarts3.workspace.Workspace.propagation_matrix_agenda` directly from the workspace by calling :func:`~pyarts3.workspace.Workspace.propagation_matrix_agendaExecute`.
   
   As all agendas in ARTS, :attr:`~pyarts3.workspace.Workspace.propagation_matrix_agenda` is also customizable via its operator helper class: :class:`~pyarts3.arts.propagation_matrix_agendaOperator`.
   See it, :func:`~pyarts3.workspace.Workspace.propagation_matrix_agendaSetOperator`, and :func:`~pyarts3.workspace.Workspace.propagation_matrix_agendaExecuteOperator` for more details.
   
   :attr:`~pyarts3.workspace.Workspace.propagation_matrix_agenda` have these constraints ():
   
   #. On output, :attr:`~pyarts3.workspace.Workspace.propagation_matrix` has the size of :attr:`~pyarts3.workspace.Workspace.frequency_grid`.
   #. On output, :attr:`~pyarts3.workspace.Workspace.propagation_matrix_source_vector_nonlte` has the size of :attr:`~pyarts3.workspace.Workspace.frequency_grid`.
   #. On output, :attr:`~pyarts3.workspace.Workspace.propagation_matrix_jacobian` has the shape of the target-count of :attr:`~pyarts3.workspace.Workspace.jacobian_targets` times the size of :attr:`~pyarts3.workspace.Workspace.frequency_grid`.
   #. On output, :attr:`~pyarts3.workspace.Workspace.propagation_matrix_source_vector_nonlte_jacobian` has the shape of the target-count of :attr:`~pyarts3.workspace.Workspace.jacobian_targets` times the size of :attr:`~pyarts3.workspace.Workspace.frequency_grid`.
   
   
   
   
   Parameters
   ----------
   propagation_matrix : ~pyarts3.arts.PropmatVector
       This contains the fully polarized propagation matrix for the current path point. See :attr:`~pyarts3.workspace.Workspace.propagation_matrix` **[OUT]**
   propagation_matrix_source_vector_nonlte : ~pyarts3.arts.StokvecVector
       The part of the source vector that is due to non-LTE. See :attr:`~pyarts3.workspace.Workspace.propagation_matrix_source_vector_nonlte` **[OUT]**
   propagation_matrix_jacobian : ~pyarts3.arts.PropmatMatrix
       Partial derivative of the :attr:`~pyarts3.workspace.Workspace.propagation_matrix` with regards to :attr:`~pyarts3.workspace.Workspace.jacobian_targets`. See :attr:`~pyarts3.workspace.Workspace.propagation_matrix_jacobian` **[OUT]**
   propagation_matrix_source_vector_nonlte_jacobian : ~pyarts3.arts.StokvecMatrix
       Partial derivative of the :attr:`~pyarts3.workspace.Workspace.propagation_matrix_source_vector_nonlte` with regards to :attr:`~pyarts3.workspace.Workspace.jacobian_targets`. See :attr:`~pyarts3.workspace.Workspace.propagation_matrix_source_vector_nonlte_jacobian` **[OUT]**
   frequency_grid : ~pyarts3.arts.AscendingGrid
       A single frequency grid. See :attr:`~pyarts3.workspace.Workspace.frequency_grid` **[IN]**
   frequency_grid_wind_shift_jacobian : ~pyarts3.arts.Vector3
       The frequency grid wind shift Jacobian. See :attr:`~pyarts3.workspace.Workspace.frequency_grid_wind_shift_jacobian` **[IN]**
   jacobian_targets : ~pyarts3.arts.JacobianTargets
       A list of targets for the Jacobian Matrix calculations. See :attr:`~pyarts3.workspace.Workspace.jacobian_targets` **[IN]**
   select_species : ~pyarts3.arts.SpeciesEnum
       Species selection. See :attr:`~pyarts3.workspace.Workspace.select_species` **[IN]**
   ray_path_point : ~pyarts3.arts.PropagationPathPoint
       A single path point. See :attr:`~pyarts3.workspace.Workspace.ray_path_point` **[IN]**
   atmospheric_point : ~pyarts3.arts.AtmPoint
       An atmospheric point in ARTS. See :attr:`~pyarts3.workspace.Workspace.atmospheric_point` **[IN]**
   
   
   
   
   .. rubric:: Input to workspace methods
   
   .. hlist::
       :columns: 2
   
       * :func:`~pyarts3.workspace.Workspace.atmospheric_fieldFitNonLTE` 
       * :func:`~pyarts3.workspace.Workspace.atmospheric_profileFitNonLTE` 
       * :func:`~pyarts3.workspace.Workspace.propagation_matrix_agendaExecute` 
       * :func:`~pyarts3.workspace.Workspace.ray_path_propagation_matrixFromPath` 
       * :func:`~pyarts3.workspace.Workspace.ray_path_propagation_matrix_species_splitFromPath` 
       * :func:`~pyarts3.workspace.Workspace.ray_path_spectral_radiance_scatteringSunsFirstOrderRayleigh` 
       * :func:`~pyarts3.workspace.Workspace.spectral_flux_profileFromPathField` 
       * :func:`~pyarts3.workspace.Workspace.spectral_flux_profilePseudo2D` 
       * :func:`~pyarts3.workspace.Workspace.spectral_radianceClearskyBackgroundTransmission` 
       * :func:`~pyarts3.workspace.Workspace.spectral_radianceClearskyEmission` 
       * :func:`~pyarts3.workspace.Workspace.spectral_radianceClearskyRayleighScattering` 
       * :func:`~pyarts3.workspace.Workspace.spectral_radianceClearskyTransmission` 
       * :func:`~pyarts3.workspace.Workspace.spectral_radiance_fieldProfilePseudo2D`
   
   
   .. rubric:: Output from workspace methods
   
   .. hlist::
       :columns: 1
   
       * :func:`~pyarts3.workspace.Workspace.propagation_matrix_agendaAuto` 
       * :func:`~pyarts3.workspace.Workspace.propagation_matrix_agendaSet` 
       * :func:`~pyarts3.workspace.Workspace.propagation_matrix_agendaSetOperator`
   
   
   .. rubric:: Related workspace variables
   
   .. hlist::
       :columns: 2
   
       * :attr:`~pyarts3.workspace.Workspace.propagation_matrix` 
       * :attr:`~pyarts3.workspace.Workspace.propagation_matrix_jacobian` 
       * :attr:`~pyarts3.workspace.Workspace.propagation_matrix_scattering` 
       * :attr:`~pyarts3.workspace.Workspace.propagation_matrix_scattering_agenda` 
       * :attr:`~pyarts3.workspace.Workspace.propagation_matrix_scattering_spectral_agenda` 
       * :attr:`~pyarts3.workspace.Workspace.propagation_matrix_source_vector_nonlte` 
       * :attr:`~pyarts3.workspace.Workspace.propagation_matrix_source_vector_nonlte_jacobian` 
       * :attr:`~pyarts3.workspace.Workspace.ray_path_propagation_matrix` 
       * :attr:`~pyarts3.workspace.Workspace.ray_path_propagation_matrix_jacobian` 
       * :attr:`~pyarts3.workspace.Workspace.ray_path_propagation_matrix_scattering` 
       * :attr:`~pyarts3.workspace.Workspace.ray_path_propagation_matrix_source_vector_nonlte` 
       * :attr:`~pyarts3.workspace.Workspace.ray_path_propagation_matrix_source_vector_nonlte_jacobian`
   
   .. :class:`~pyarts3.arts.Agenda`