petitRADTRANS.radtrans
======================
.. py:module:: petitRADTRANS.radtrans
.. autoapi-nested-parse::
Stores the Radtrans object.
Classes
-------
.. autoapisummary::
petitRADTRANS.radtrans.Radtrans
Module Contents
---------------
.. py:class:: Radtrans(pressures: numpy.typing.NDArray[numpy.floating] = None, wavelength_boundaries: numpy.typing.NDArray[numpy.floating] = None, line_species: list[str] = None, gas_continuum_contributors: list[str] = None, rayleigh_species: list[str] = None, cloud_species: list[str] = None, line_opacity_mode: str = 'c-k', line_by_line_opacity_sampling: int = 1, scattering_in_emission: bool = False, emission_angle_grid: numpy.typing.NDArray[numpy.floating] = None, anisotropic_cloud_scattering: bool = 'auto', path_input_data: str = None)
Calculate spectra using a given set of opacities.
Args:
pressures (Optional):
(bar) Array defining the pressure grid to be used for the spectral calculations.
wavelength_boundaries (Optional):
List containing left and right border of wavelength region to be considered, in micron. If nothing else
is specified, it will be equal to ``[0.05, 300]``, hence using the full petitRADTRANS wavelength range
(0.11 to 250 microns for ``'c-k'`` mode, 0.3 to 30 microns for the ``'lbl'`` mode). The larger the
range the longer the computation time.
line_species (Optional):
List of strings, denoting which line absorber species to include.
gas_continuum_contributors (Optional):
List of strings, denoting which continuum absorber species to include.
rayleigh_species (Optional):
List of strings, denoting which Rayleigh scattering species to include.
cloud_species (Optional):
List of strings, denoting which cloud opacity species to include.
line_opacity_mode (Optional[string]):
If equal to ``'c-k'``: use low-resolution mode, at :math:`\\lambda/\\Delta \\lambda = 1000`, with the
correlated-k assumption. if equal to ``'lbl'``: use high-resolution mode, at
:math:`\\lambda/\\Delta \\lambda = 10^6`, with a line-by-line treatment.
line_by_line_opacity_sampling (Optional[int]):
If ``mode = 'lbl'``, then this will only load every line_by_line_opacity_sampling-nth point of the
high-resolution opacities. This can be used to save time and RAM.
The user should verify whether this leads to solutions which are identical to the results of the
non down-sampled :math:`10^6` resolution.
scattering_in_emission (Optional[bool]):
Will be ``False`` by default.
If ``True`` scattering will be included in the emission spectral calculations. Note that this increases
the runtime of pRT!
emission_angle_grid (Optional):
Array defining the cosines of the angle grid to be used for the emission spectrum calculations,
and their weights. The array is of shape (2, n_angles), with emission_angle_grid[0] being the cosines of
the angles, and emission_angle_grid[1] being the weights.
A dictionary of array with keys 'cos_angles' and 'weights' can also be used.
If None, a default set of values and weights are used.
anisotropic_cloud_scattering (Optional[bool, str]):
If True, anisotropic cloud scattering opacities are used for the spectral calculations.
If False, isotropic cloud scattering opacities are used for the spectral calculations.
If 'auto' (recommended), anisotropic_cloud_scattering is set to True for emission spectrum
calculations, and to False for transmission spectrum calculations.
path_input_data (Optional[str]):
Path to the input_data folder, containing the files to be loaded by petitRADTRANS.
.. py:attribute:: __dat_opacity_files_warning_message
:value: Multiline-String
.. raw:: html
Show Value
.. code-block:: python
"""loading opacities from .dat files is discouraged, the HDF5 format offer better performances at for a lower memory usage
Converting petitRADTRANS .dat opacity files into HDF5 can be done by executing:
>>> from petitRADTRANS.__file_conversion import convert_all
>>> convert_all()
Alternatively, the petitRADTRANS HDF5 files can be downloaded (see https://petitradtrans.readthedocs.io/en/latest/content/available_opacities.html)"""
.. raw:: html
Show Value
.. code-block:: python
"""setting a Radtrans line opacity property should be avoided
These properties are loaded from the opacity data in the input_data directory and are inter-dependent (they need to be updated for consistency)
It is recommended to create a new Radtrans instance instead"""
.. raw:: html
Show Value
.. code-block:: python
"""setting a Radtrans property directly is not recommended
Create a new Radtrans instance (recommended) or re-do all the setup steps necessary for the modification to be taken into account"""
.. raw:: html