Cthulhu.calculate
=================

.. py:module:: Cthulhu.calculate


Attributes
----------

.. autoapisummary::

   Cthulhu.calculate.version
   Cthulhu.calculate.dots
   Cthulhu.calculate.positions
   Cthulhu.calculate.version
   Cthulhu.calculate.version


Functions
---------

.. autoapisummary::

   Cthulhu.calculate.find_index
   Cthulhu.calculate.prior_index
   Cthulhu.calculate.prior_index_generic
   Cthulhu.calculate.compute_transition_frequencies
   Cthulhu.calculate.compute_line_intensity_EXOMOL
   Cthulhu.calculate.compute_line_intensity_HITRAN
   Cthulhu.calculate.compute_line_intensity_VALD
   Cthulhu.calculate.compute_line_intensity
   Cthulhu.calculate.compute_cross_section
   Cthulhu.calculate.compute_cross_section_atom
   Cthulhu.calculate.compute_cross_section_atom_OLD
   Cthulhu.calculate.find_J_low
   Cthulhu.calculate.cross_section_EXOMOL
   Cthulhu.calculate.cross_section_HITRAN
   Cthulhu.calculate.produce_total_cross_section_VALD_atom
   Cthulhu.calculate.bin_cross_section_atom


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

.. py:data:: version

.. py:data:: dots

.. py:data:: positions

.. py:data:: version

.. py:data:: version

.. py:function:: find_index(val, grid_start, grid_end, N_grid)

.. py:function:: prior_index(val, grid_start, grid_end, N_grid)

.. py:function:: prior_index_generic(value, grid, start=0)

   Search a grid to find the previous index closest to a specified value (i.e.
   the index of the grid where the grid value is last less than the value).
   This function assumes the input grid monotonically increases.

   :param value: Value for which the prior grid index is desired.
   :type value: float
   :param grid: Input grid.
   :type grid: np.array of float
   :param start: Optional start index when existing knowledge is available.
   :type start: int

   :returns:     Prior index of the grid corresponding to the value.
   :rtype: index (int)


.. py:function:: compute_transition_frequencies(E, states, upper_state, lower_state)

.. py:function:: compute_line_intensity_EXOMOL(A_trans, g_state, E_state, nu_0_trans, T, Q_T, states, upper_state, lower_state)

.. py:function:: compute_line_intensity_HITRAN(S_ref, Q_T, Q_ref, T_ref, T, E_low, nu_0)

.. py:function:: compute_line_intensity_VALD(gf, E_low, nu_0, T, Q_T)

.. py:function:: compute_line_intensity(A, g_upper, E_lower, nu_0, T, Q)

.. py:function:: compute_cross_section(sigma, nu_grid, nu_0, cutoffs, S, J_lower, J_broad_all, alpha, log_alpha, alpha_sampled, log_alpha_sampled, N_Voigt, Voigt_arr, dV_da_arr, dV_dnu_arr, dnu_Voigt, dnu_out)

.. py:function:: compute_cross_section_atom(sigma, nu_grid, nu_0, S, cutoffs, N_Voigt, Voigt_arr)

.. py:function:: compute_cross_section_atom_OLD(sigma, N_grid, nu_0, nu_detune, nu_fine_start, nu_fine_end, S, T, alpha, gamma, cutoffs, N_Voigt_points, species_ID, nu_min, nu_max)

.. py:function:: find_J_low(J, states, lower_state)

   Find the lower angular momentum quantum number corresponding to each lower
   state.


.. py:function:: cross_section_EXOMOL(linelist_files, input_directory, nu_grid, sigma, alpha_sampled, m, T, Q_T, states, g_arr, E_arr, J_arr, J_max, J_broad_all, N_Voigt, cutoffs, Voigt_arr, dV_da_arr, dV_dnu_arr, dnu_Voigt, S_cut, verbose)

.. py:function:: cross_section_HITRAN(linelist_files, input_directory, nu_grid, sigma, alpha_sampled, m, T, Q_T, Q_ref, J_max, J_broad_all, N_Voigt, cutoffs, Voigt_arr, dV_da_arr, dV_dnu_arr, dnu_Voigt, S_cut, verbose)

.. py:function:: produce_total_cross_section_VALD_atom(nu_grid, sigma, nu_0_in, E_low, gf, m, T, Q_T, N_Voigt, cutoffs, Voigt_arr, S_cut)

.. py:function:: bin_cross_section_atom(sigma_fine, sigma_out, nu_fine_start, nu_fine_end, nu_out, N_fine, N_out, option)