petitRADTRANS.retrieval.models

Module Contents

Functions

emission_model_diseq(pRT_object, parameters[, ...])

Disequilibrium Chemistry Emission Model

emission_model_diseq_patchy_clouds(pRT_object, parameters)

Disequilibrium Chemistry Emission Model

emission_model_diseq_simple_patchy_clouds(pRT_object, ...)

Disequilibrium Chemistry Emission Model

guillot_emission(pRT_object, parameters[, ...])

Emission spectrum calculation for the Guillot 2010 temperature profile.

guillot_patchy_emission(pRT_object, parameters[, ...])

This model computes a emission spectrum based the Guillot temperature-pressure profile and patchy clouds.

interpolated_profile_emission(pRT_object, parameters)

This model computes a emission spectrum based a spline temperature-pressure profile.

gradient_profile_emission(pRT_object, parameters[, ...])

This model computes a emission spectrum based a gradient temperature-pressure profile (Zhang 2023).

guillot_transmission(pRT_object, parameters[, ...])

Transmission Model, Guillot Profile

guillot_patchy_transmission(pRT_object, parameters[, ...])

Transmission Model, Guillot Profile

madhu_seager_patchy_transmission(pRT_object, parameters)

Transmission Model, Madhusudhan Seager 2009 Profile

guillot_patchy_transmission_constrained_chem(...[, ...])

Transmission Model, Guillot Profile

isothermal_transmission(pRT_object, parameters[, ...])

Equilibrium Chemistry Transmission Model, Isothermal Profile

initialize_pressure(press, parameters, AMR)

Provide the pressure array correctly sized to the pRT_object in use, accounting for

set_pglobal(press, parameters)

Check to ensure that the global pressure array has the correct length.

pglobal_check(press, shape, scaling)

Check to ensure that the global pressure array has the correct length.

Attributes

PGLOBAL

petitRADTRANS.retrieval.models.PGLOBAL
petitRADTRANS.retrieval.models.emission_model_diseq(pRT_object, parameters, PT_plot_mode=False, AMR=True)

Disequilibrium Chemistry Emission Model

This model computes an emission spectrum based on the temperature profile of (Molliere 2020). (Dis)equilibrium or free chemistry, can be used. The use of easychem for on-the-fly (dis)equilibrium chemistry calculations is supported, but is currently under development. Many of the parameters are optional, but must be used in the correct combination with other parameters.

Args:
pRT_objectobject

An instance of the pRT class, with optical properties as defined in the RunDefinition.

parametersdict
Dictionary of required parameters:

  • D_pl : Distance to the planet in [cm]

Two of

  • log_g : Log of surface gravity

  • R_pl : planet radius [cm]

  • mass : planet mass [g]

  • T_int : Interior temperature of the planet [K]

  • T3 : Innermost temperature spline [K]

  • T2 : Middle temperature spline [K]

  • T1 : Outer temperature spline [K]

  • alpha : power law index in tau = delta * press_cgs**alpha

  • log_delta : proportionality factor in tau = delta * press_cgs**alpha

  • log_pquench : Pressure at which CO, CH4 and H2O abundances become vertically constant

  • Fe/H : Metallicity

  • C/O : Carbon to oxygen ratio

  • fsed : sedimentation parameter - can be unique to each cloud type by adding _CloudName

One of:

  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:

  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

One of

  • eq_scaling_* : Scaling factor for equilibrium cloud abundances.

  • log_X_cb_: cloud mass fraction abundance

Optional

  • contribution : return the emission contribution function

PT_plot_modebool

Return only the pressure-temperature profile for plotting. Evaluate mode only.

AMRbool

Adaptive mesh refinement. Use the high resolution pressure grid around the cloud base.

Returns:
wlen_modelnp.ndarray

Wavlength array of computed model, not binned to data [um]

spectrum_modelnp.ndarray

Computed emission spectrum [W/m2/micron]

contr_emOptional, np.ndarray

Emission contribution function, relative contributions for each wavelength and pressure level.

petitRADTRANS.retrieval.models.emission_model_diseq_patchy_clouds(pRT_object, parameters, PT_plot_mode=False, AMR=True)

Disequilibrium Chemistry Emission Model

This model computes an emission spectrum based on the temperature profile of (Molliere 2020). (Dis)equilibrium or free chemistry, can be used. The use of easychem for on-the-fly (dis)equilibrium chemistry calculations is supported, but is currently under development. This model includes patchy clouds, and requires a unique temperature profile for the clear atmosphere regions.

Args:
pRT_objectobject

An instance of the pRT class, with optical properties as defined in the RunDefinition.

parametersdict
Dictionary of required parameters:

  • D_pl : Distance to the planet in [cm]

Two of

  • log_g : Log of surface gravity

  • R_pl : planet radius [cm]

  • mass : planet mass [g]

  • T_int : Interior temperature of the planet [K]

  • T3 : Innermost temperature spline

  • T2 : Middle temperature spline

  • T1 : Outer temperature spline

  • T3_clear : Innermost temperature spline for clear atmosphere

  • T2_clear : Middle temperature spline for clear atmosphere

  • T1_clear : Outer temperature spline for clear atmosphere

  • alpha : power law index in tau = delta * press_cgs**alpha

  • alpha_clear : power law index in tau = delta * press_cgs**alpha for clear atmosphere

  • log_delta : proportionality factor in tau = delta * press_cgs**alpha

  • log_delta_clear : proportionality factor in tau = delta * press_cgs**alpha for clear atmosphere

  • log_pquench : Pressure at which CO, CH4 and H2O abundances become vertically constant

  • Fe/H : Metallicity

  • C/O : Carbon to oxygen ratio

  • fsed : sedimentation parameter - can be unique to each cloud type

One of:

  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:

  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

One of

  • eq_scaling_* : Scaling factor for equilibrium cloud abundances.

  • log_X_cb_: cloud mass fraction abundance

Optional

  • contribution : return the emission contribution function

  • patchiness : Fraction of cloud coverage, clear contribution is (1-patchiness)

PT_plot_modebool

Return only the pressure-temperature profile for plotting. Evaluate mode only.

AMRbool

Adaptive mesh refinement. Use the high resolution pressure grid around the cloud base.

Returns:
wlen_modelnp.array

Wavlength array of computed model, not binned to data [um]

spectrum_modelnp.array

Computed emission spectrum [W/m2/micron]

contr_emOptional, np.ndarray

Emission contribution function, relative contributions for each wavelength and pressure level. Only returns the contribution of the clear atmosphere component.

petitRADTRANS.retrieval.models.emission_model_diseq_simple_patchy_clouds(pRT_object, parameters, PT_plot_mode=False, AMR=True)

Disequilibrium Chemistry Emission Model

This model computes an emission spectrum based on the temperature-pressure profile of (Molliere 2020). (Dis)equilibrium or free chemistry, can be used. The use of easychem for on-the-fly (dis)equilibrium chemistry calculations is supported, but is currently under development. This model includes patchy clouds, but uses a constant pressure temperature profile for both the clear and cloudy regions.

Args:
pRT_objectobject

An instance of the pRT class, with optical properties as defined in the RunDefinition.

parametersdict
Dictionary of required parameters:

  • D_pl : Distance to the planet in [cm]

Two of

  • log_g : Log of surface gravity

  • R_pl : planet radius [cm]

  • mass : planet mass [g]

  • T_int : Interior temperature of the planet [K]

  • T3 : Innermost temperature spline [K]

  • T2 : Middle temperature spline [K]

  • T1 : Outer temperature spline [K]

  • alpha : power law index in tau = delta * press_cgs**alpha

  • log_delta : proportionality factor in tau = delta * press_cgs**alpha

  • log_pquench : Pressure at which CO, CH4 and H2O abundances become vertically constant

  • Fe/H : Metallicity

  • C/O : Carbon to oxygen ratio

  • fsed : sedimentation parameter - can be unique to each cloud type

One of:

  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:

  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

One of

  • eq_scaling_* : Scaling factor for equilibrium cloud abundances.

  • log_X_cb_: cloud mass fraction abundance

  • patchiness : Fraction of cloud coverage, clear contribution is (1-patchiness)

Optional

  • contribution : return the emission contribution function

PT_plot_modebool

Return only the pressure-temperature profile for plotting. Evaluate mode only.

AMR :

Adaptive mesh refinement. Use the high resolution pressure grid around the cloud base.

Returns:
wlen_modelnp.array

Wavlength array of computed model, not binned to data [um]

spectrum_modelnp.array

Computed emission spectrum [W/m2/micron]

contr_emOptional, np.ndarray

Emission contribution function, relative contributions for each wavelength and pressure level. Only returns the contribution of the clear atmosphere component.

petitRADTRANS.retrieval.models.guillot_emission(pRT_object, parameters, PT_plot_mode=False, AMR=False)

Emission spectrum calculation for the Guillot 2010 temperature profile. (Dis)equilibrium or free chemistry, can be used. The use of easychem for on-the-fly (dis)equilibrium chemistry calculations is supported, but is currently under development.

Args:
pRT_objectobject

An instance of the pRT class, with optical properties as defined in the RunDefinition.

parametersdict
Dictionary of required parameters:

  • D_pl : Distance to the planet in [cm]

Two of

  • log_g : Log of surface gravity

  • R_pl : planet radius [cm]

  • mass : planet mass [g]

  • T_int : Interior temperature of the planet [K]

  • T_equ : Equilibrium temperature of the planet

  • gamma : Guillot gamma parameter

  • log_kappa_IR : The log of the ratio between the infrared and optical opacities

Either:

  • log_pquench : Pressure at which CO, CH4 and H2O abundances become vertically constant

  • Fe/H : Metallicity

  • C/O : Carbon to oxygen ratio

Or:

  • $SPECIESNAME[_$DATABASE][_R_$RESOLUTION] : The log mass fraction abundance of the species

  • fsed : sedimentation parameter - can be unique to each cloud type

One of:

  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:

  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

One of

  • eq_scaling_* : Scaling factor for equilibrium cloud abundances.

  • log_X_cb_: cloud mass fraction abundance

Optional

  • contribution : return the emission contribution function

PT_plot_mode : bool PT_plot_mode : bool

Return only the pressure-temperature profile for plotting. Evaluate mode only.

AMR :

Adaptive mesh refinement. Use the high resolution pressure grid around the cloud base.

Returns:
wlen_modelnp.array

Wavlength array of computed model, not binned to data [um]

spectrum_modelnp.array

Computed transmission spectrum R_pl**2/Rstar**2

contr-emnp.ndarray

Optional, Emission contribution function, relative contributions for each wavelength and pressure level.

petitRADTRANS.retrieval.models.guillot_patchy_emission(pRT_object, parameters, PT_plot_mode=False, AMR=False)

This model computes a emission spectrum based the Guillot temperature-pressure profile and patchy clouds. Either free or equilibrium chemistry can be used, together with a range of cloud parameterizations. It is possible to use free abundances for some species and equilibrium chemistry for the remainder.

Args:
pRT_objectobject

An instance of the pRT class, with optical properties as defined in the RunDefinition.

parametersdict
Dictionary of required parameters:

  • D_pl : Distance to the planet in [cm]

Two of

  • log_g : Log of surface gravity

  • R_pl : planet radius [cm]

  • mass : planet mass [g]

  • T_int : Interior temperature of the planet [K]

  • T_equ : Equilibrium temperature of the planet

  • gamma : Guillot gamma parameter

  • log_kappa_IR : The log of the ratio between the infrared and optical opacities

Either:

  • log_pquench : Pressure at which CO, CH4 and H2O abundances become vertically constant

  • Fe/H : Metallicity

  • C/O : Carbon to oxygen ratio

Or:

  • $SPECIESNAME[_$DATABASE][_R_$RESOLUTION] : The log mass fraction abundance of the species

  • fsed : sedimentation parameter - can be unique to each cloud type

One of:

  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:

  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

One of

  • eq_scaling_* : Scaling factor for equilibrium cloud abundances.

  • log_X_cb_: cloud mass fraction abundance

  • patchiness : Fraction of cloud coverage, clear contribution is (1-patchiness)

Optional

  • contribution : return the emission contribution function

PT_plot_mode : bool PT_plot_mode : bool

Return only the pressure-temperature profile for plotting. Evaluate mode only.

AMR :

Adaptive mesh refinement. Use the high resolution pressure grid around the cloud base.

Returns:
wlen_modelnp.array

Wavlength array of computed model, not binned to data [um]

spectrum_modelnp.array

Computed transmission spectrum R_pl**2/Rstar**2

contr-emnp.ndarray

Optional, the emission contribution function, relative contributions for each wavelength and pressure level. Only returns the contribution of the clear atmosphere component.

petitRADTRANS.retrieval.models.interpolated_profile_emission(pRT_object, parameters, PT_plot_mode=False, AMR=False)

This model computes a emission spectrum based a spline temperature-pressure profile. Either free or equilibrium chemistry can be used, together with a range of cloud parameterizations. It is possible to use free abundances for some species and equilibrium chemistry for the remainder.

Args:
pRT_objectobject

An instance of the pRT class, with optical properties as defined in the RunDefinition.

parametersdict
Dictionary of required parameters:

  • D_pl : Distance to the planet in [cm]

Two of

  • log_g : Log of surface gravity

  • R_pl : planet radius [cm]

  • mass : planet mass [g]

  • nnodesnumber of nodes to interplate, excluding the first and last points.

    so the total number of nodes is nnodes + 2

  • Temps : One parameter for each temperature node

  • gamma : weight for penalizing the profile curvature

Either:

  • log_pquench : Pressure at which CO, CH4 and H2O abundances become vertically constant

  • Fe/H : Metallicity

  • C/O : Carbon to oxygen ratio

Or:

  • $SPECIESNAME[_$DATABASE][_R_$RESOLUTION] : The log mass fraction abundance of the species

Optional: * fsed : sedimentation parameter - can be unique to each cloud type One of:

  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:

  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

One of

  • eq_scaling_* : Scaling factor for equilibrium cloud abundances.

  • log_X_cb_: cloud mass fraction abundance

Optional

  • contribution : return the emission contribution function

PT_plot_modebool

Return only the pressure-temperature profile for plotting. Evaluate mode only.

AMR :

Adaptive mesh refinement. Use the high resolution pressure grid around the cloud base.

Returns:
wlen_modelnp.array

Wavlength array of computed model, not binned to data [um]

spectrum_modelnp.array

Computed transmission spectrum R_pl**2/Rstar**2

contr-emnp.ndarray

Optional, the emission contribution function, relative contributions for each wavelength and pressure level.

petitRADTRANS.retrieval.models.gradient_profile_emission(pRT_object, parameters, PT_plot_mode=False, AMR=False)

This model computes a emission spectrum based a gradient temperature-pressure profile (Zhang 2023). Either free or equilibrium chemistry can be used, together with a range of cloud parameterizations. It is possible to use free abundances for some species and equilibrium chemistry for the remainder.

Args:
pRT_objectobject

An instance of the pRT class, with optical properties as defined in the RunDefinition.

parametersdict
Dictionary of required parameters:

  • D_pl : Distance to the planet in [cm]

Two of

  • log_g : Log of surface gravity

  • R_pl : planet radius [cm]

  • mass : planet mass [g]

  • N_layersnumber of nodes to interplate, excluding the first and last points.

    so the total number of nodes is nnodes + 2

  • T_bottom : Temperature at the base of the atmosphere

  • PTslope_* : Temperature gradient for each of the n_layers between which the profile is interpolated.

Either:

  • log_pquench : Pressure at which CO, CH4 and H2O abundances become vertically constant

  • Fe/H : Metallicity

  • C/O : Carbon to oxygen ratio

Or:

  • $SPECIESNAME[_$DATABASE][_R_$RESOLUTION] : The log mass fraction abundance of the species

Optional: * fsed : sedimentation parameter - can be unique to each cloud type One of:

  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:

  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

One of

  • eq_scaling_* : Scaling factor for equilibrium cloud abundances.

  • log_X_cb_: cloud mass fraction abundance

Optional

  • contribution : return the emission contribution function

PT_plot_modebool

Return only the pressure-temperature profile for plotting. Evaluate mode only.

AMR :

Adaptive mesh refinement. Use the high resolution pressure grid around the cloud base.

Returns:
wlen_modelnp.array

Wavlength array of computed model, not binned to data [um]

spectrum_modelnp.array

Computed transmission spectrum R_pl**2/Rstar**2

contr-emnp.ndarray

Optional, the emission contribution function, relative contributions for each wavelength and pressure level.

petitRADTRANS.retrieval.models.guillot_transmission(pRT_object, parameters, PT_plot_mode=False, AMR=False)

Transmission Model, Guillot Profile

This model computes a transmission spectrum based on the Guillot profile Either free or (dis)equilibrium chemistry can be used, together with a range of cloud parameterizations. It is possible to use free abundances for some species and equilibrium chemistry for the remainder. Chemical clouds can be used, or a simple gray opacity source.

Args:
pRT_objectobject

An instance of the pRT class, with optical properties as defined in the RunDefinition.

parametersdict
Dictionary of required parameters:

  • D_pl : Distance to the planet in [cm]

Two of

  • log_g : Log of surface gravity

  • R_pl : planet radius [cm]

  • mass : planet mass [g]

  • T_int : Interior temperature of the planet [K]

  • T_equ : Equilibrium temperature of the planet

  • gamma : Guillot gamma parameter

  • log_kappa_IR : The log of the ratio between the infrared and optical opacities

Either:

  • log_pquench : Pressure at which CO, CH4 and H2O abundances become vertically constant

  • Fe/H : Metallicity

  • C/O : Carbon to oxygen ratio

Or:

  • $SPECIESNAME[_$DATABASE][_R_$RESOLUTION] : The log mass fraction abundance of the species

Either:

  • [log_]Pcloud : The (log) pressure at which to place the gray cloud opacity.

Or:

  • fsed : sedimentation parameter - can be unique to each cloud type

One of:

  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:

  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

One of

  • eq_scaling_* : Scaling factor for equilibrium cloud abundances.

  • log_X_cb_: cloud mass fraction abundance

Optional

  • contribution : return the transmission contribution function

PT_plot_modebool

Return only the pressure-temperature profile for plotting. Evaluate mode only.

AMR :

Adaptive mesh refinement. Use the high resolution pressure grid around the cloud base.

Returns:
wlen_modelnp.array

Wavlength array of computed model, not binned to data [um]

spectrum_modelnp.array

Computed transmission spectrum R_pl**2/Rstar**2

contr-emnp.ndarray

Optional, the transmission contribution function, relative contributions for each wavelength and pressure level.

petitRADTRANS.retrieval.models.guillot_patchy_transmission(pRT_object, parameters, PT_plot_mode=False, AMR=False)

Transmission Model, Guillot Profile

This model computes a transmission spectrum based on a Guillot temperature-pressure profile. Either free or equilibrium chemistry can be used, together with a range of cloud parameterizations. It is possible to use free abundances for some species and equilibrium chemistry for the remainder. Chemical clouds can be used, or a simple gray opacity source. This model requires patchy clouds.

Args:
pRT_objectobject

An instance of the pRT class, with optical properties as defined in the RunDefinition.

parametersdict
Dictionary of required parameters:

  • D_pl : Distance to the planet in [cm]

Two of

  • log_g : Log of surface gravity

  • R_pl : planet radius [cm]

  • mass : planet mass [g]

  • T_int : Interior temperature of the planet [K]

  • T_equ : Equilibrium temperature of the planet

  • gamma : Guillot gamma parameter

  • log_kappa_IR : The log of the ratio between the infrared and optical opacities

Either:

  • log_pquench : Pressure at which CO, CH4 and H2O abundances become vertically constant

  • Fe/H : Metallicity

  • C/O : Carbon to oxygen ratio

Or:

  • $SPECIESNAME[_$DATABASE][_R_$RESOLUTION] : The log mass fraction abundance of the species

Either:

  • [log_]Pcloud : The (log) pressure at which to place the gray cloud opacity.

Or:

  • fsed : sedimentation parameter - can be unique to each cloud type

One of:

  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:

  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

One of

  • eq_scaling_* : Scaling factor for equilibrium cloud abundances.

  • log_X_cb_: cloud mass fraction abundance

  • patchiness : Fraction of cloud coverage, clear contribution is (1-patchiness)

Optional

  • contribution : return the transmission contribution function

PT_plot_modebool

Return only the pressure-temperature profile for plotting. Evaluate mode only.

AMR :

Adaptive mesh refinement. Use the high resolution pressure grid around the cloud base.

Returns:
wlen_modelnp.array

Wavlength array of computed model, not binned to data [um]

spectrum_modelnp.array

Computed transmission spectrum R_pl**2/Rstar**2

contr-emnp.ndarray

Optional, the transmission contribution function, relative contributions for each wavelength and pressure level. Only the clear atmosphere contribution is returned.

petitRADTRANS.retrieval.models.madhu_seager_patchy_transmission(pRT_object, parameters, PT_plot_mode=False, AMR=False)

Transmission Model, Madhusudhan Seager 2009 Profile

This model computes a transmission spectrum based on a Guillot temperature-pressure profile. Either free or equilibrium chemistry can be used, together with a range of cloud parameterizations. It is possible to use free abundances for some species and equilibrium chemistry for the remainder. Chemical clouds can be used, or a simple gray opacity source. This model requires patchy clouds.

Args:
pRT_objectobject

An instance of the pRT class, with optical properties as defined in the RunDefinition.

parametersdict
Dictionary of required parameters:

  • D_pl : Distance to the planet in [cm]

Two of

  • log_g : Log of surface gravity

  • R_pl : planet radius [cm]

  • mass : planet mass [g]

  • log_P_set : Pressure value to contrain the PT profile, defaults to 10 bar.

  • T_set : temperature at P_set to constrain the PT profile. [K]

  • log_P3 : (log) Pressure value for the top of the deep atmospheric layer, [bar]

  • P2 : in range (0,1), sets the pressure level of the middle atmospheric layer

  • P1 : in range (0,1), sets the pressure level of the top atmospheric layer

  • alpha_0 : slope of the upper atmospheric layer

  • alpha_1 : slope of the middle atmospheric layer

Optional :

  • beta : power law for the slopes, default value is 0.5. Not recommended to change!

Either:

  • log_pquench : Pressure at which CO, CH4 and H2O abundances become vertically constant

  • Fe/H : Metallicity

  • C/O : Carbon to oxygen ratio

Or:

  • $SPECIESNAME[_$DATABASE][_R_$RESOLUTION] : The log mass fraction abundance of the species

Either:

  • [log_]Pcloud : The (log) pressure at which to place the gray cloud opacity.

Or:

  • fsed : sedimentation parameter - can be unique to each cloud type

One of:

  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:

  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

One of

  • eq_scaling_* : Scaling factor for equilibrium cloud abundances.

  • log_X_cb_: cloud mass fraction abundance

  • patchiness : Fraction of cloud coverage, clear contribution is (1-patchiness)

Optional

  • contribution : return the transmission contribution function

PT_plot_modebool

Return only the pressure-temperature profile for plotting. Evaluate mode only.

AMR :

Adaptive mesh refinement. Use the high resolution pressure grid around the cloud base.

Returns:
wlen_modelnp.array

Wavlength array of computed model, not binned to data [um]

spectrum_modelnp.array

Computed transmission spectrum R_pl**2/Rstar**2

contr-emnp.ndarray

Optional, the transmission contribution function, relative contributions for each wavelength and pressure level. Only the clear atmosphere contribution is returned.

petitRADTRANS.retrieval.models.guillot_patchy_transmission_constrained_chem(pRT_object, parameters, PT_plot_mode=False, AMR=False)

Transmission Model, Guillot Profile

This model computes a transmission spectrum based on a Guillot temperature-pressure profile. Either free or equilibrium chemistry can be used, together with a range of cloud parameterizations. It is possible to use free abundances for some species and equilibrium chemistry for the remainder. Chemical clouds can be used, or a simple gray opacity source. This model requires patchy clouds.

Args:
pRT_objectobject

An instance of the pRT class, with optical properties as defined in the RunDefinition.

parametersdict
Dictionary of required parameters:

  • D_pl : Distance to the planet in [cm]

Two of

  • log_g : Log of surface gravity

  • R_pl : planet radius [cm]

  • mass : planet mass [g]

  • T_int : Interior temperature of the planet [K]

  • T_equ : Equilibrium temperature of the planet

  • gamma : Guillot gamma parameter

  • log_kappa_IR : The log of the ratio between the infrared and optical opacities

Either:

  • log_pquench : Pressure at which CO, CH4 and H2O abundances become vertically constant

  • Fe/H : Metallicity

  • C/O : Carbon to oxygen ratio

Or:

  • $SPECIESNAME[_$DATABASE][_R_$RESOLUTION] : The log mass fraction abundance of the species

Either:

  • [log_]Pcloud : The (log) pressure at which to place the gray cloud opacity.

Or:

  • fsed : sedimentation parameter - can be unique to each cloud type

One of:

  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:

  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

One of

  • eq_scaling_* : Scaling factor for equilibrium cloud abundances.

  • log_X_cb_: cloud mass fraction abundance

  • patchiness : Fraction of cloud coverage, clear contribution is (1-patchiness)

Optional

  • contribution : return the transmission contribution function

PT_plot_modebool

Return only the pressure-temperature profile for plotting. Evaluate mode only.

AMR :

Adaptive mesh refinement. Use the high resolution pressure grid around the cloud base.

Returns:
wlen_modelnp.array

Wavlength array of computed model, not binned to data [um]

spectrum_modelnp.array

Computed transmission spectrum R_pl**2/Rstar**2

contr-emnp.ndarray

Optional, the transmission contribution function, relative contributions for each wavelength and pressure level. Only the clear atmosphere contribution is returned.

petitRADTRANS.retrieval.models.isothermal_transmission(pRT_object, parameters, PT_plot_mode=False, AMR=False)

Equilibrium Chemistry Transmission Model, Isothermal Profile

This model computes a transmission spectrum based on an isothermal temperature-pressure profile.

Args:
pRT_objectobject

An instance of the pRT class, with optical properties as defined in the RunDefinition.

parametersdict
Dictionary of required parameters:

  • D_pl : Distance to the planet in [cm]

Two of

  • log_g : Log of surface gravity

  • R_pl : planet radius [cm]

  • mass : planet mass [g]

  • Temp : Interior temperature of the planet [K]

Either:

  • log_pquench : Pressure at which CO, CH4 and H2O abundances become vertically constant

  • Fe/H : Metallicity

  • C/O : Carbon to oxygen ratio

Or:

  • $SPECIESNAME[_$DATABASE][_R_$RESOLUTION] : The log mass fraction abundance of the species

Either:

  • [log_]Pcloud : The (log) pressure at which to place the gray cloud opacity.

Or:

  • fsed : sedimentation parameter - can be unique to each cloud type

One of:

  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:

  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

Optional

  • patchiness : Fraction of cloud coverage, clear contribution is (1-patchiness)

  • contribution : return the transmission contribution function

PT_plot_modebool

Return only the pressure-temperature profile for plotting. Evaluate mode only.

AMR :

Adaptive mesh refinement. Use the high resolution pressure grid around the cloud base.

Returns:
wlen_modelnp.array

Wavlength array of computed model, not binned to data [um]

spectrum_modelnp.array

Computed transmission spectrum R_pl**2/Rstar**2

contr-emnp.ndarray

Optional, the transmission contribution function, relative contributions for each wavelength and pressure level. Only the clear atmosphere contribution is returned if patchy clouds are considered.

petitRADTRANS.retrieval.models.initialize_pressure(press, parameters, AMR)

Provide the pressure array correctly sized to the pRT_object in use, accounting for the use of Adaptive Mesh Refinement around the location of clouds.

Args:
pressnumpy.ndarray

Pressure array from a pRT_object. Used to set the min and max values of PGLOBAL

shapeint

the shape of the pressure array if no AMR is used

scaling :

The factor by which the pressure array resolution should be scaled.

petitRADTRANS.retrieval.models.set_pglobal(press, parameters)

Check to ensure that the global pressure array has the correct length. Updates PGLOBAL.

Args:
pressnumpy.ndarray

Pressure array from a pRT_object. Used to set the min and max values of PGLOBAL

parametersdict

Must include the ‘pressure_simple’ and ‘pressure_scaling’ parameters, used to determine the size of the high resolution grid.

petitRADTRANS.retrieval.models.pglobal_check(press, shape, scaling)

Check to ensure that the global pressure array has the correct length. Updates PGLOBAL.

Args:
pressnumpy.ndarray

Pressure array from a pRT_object. Used to set the min and max values of PGLOBAL

shapeint

the shape of the pressure array if no AMR is used

scaling :

The factor by which the pressure array resolution should be scaled.