petitRADTRANS.retrieval.cloud_cond

Module Contents

Functions

setup_clouds(pressures, parameters, cloud_species)	This function provides the set of cloud parameters used in
get_fseds(parameters, cloud_species)	This function checks to see if the fsed values are input on a per-cloud basis
setup_clouds(pressures, parameters, cloud_species)	This function provides the set of cloud parameters used in
cloud_dict(parameters, parameter_name, cloud_species)	This is a generic method to create a dictionary of
get_fseds(parameters, cloud_species)	This function checks to see if the fsed values are input on a per-cloud basis
get_bhans(parameters, cloud_species[, shape])	This function checks to see if the bhans values are input on a per-cloud basis
return_cloud_mass_fraction(name, FeH, CO)
simple_cdf(name, press, temp, FeH, CO[, MMW])
simple_cdf_free(name, press, temp, mfrac[, MMW])
return_XFe(FeH, CO)
return_XMgSiO3(FeH, CO)
return_XMg2SiO4(FeH, CO)
return_XNa2S(FeH, CO)
return_XKCL(FeH, CO)
return_T_cond_Fe(FeH, CO[, MMW])
return_T_cond_Fe_l(FeH, CO[, MMW])
return_T_cond_Fe_comb(FeH, CO[, MMW])
return_T_cond_Fe_free(XFe[, MMW])
return_T_cond_Fe_l_free(XFe[, MMW])
return_T_cond_Fe_comb_free(XFe[, MMW])
return_T_cond_MgSiO3(FeH, CO[, MMW])
return_T_cond_Mg2SiO4(FeH, CO[, MMW])
return_T_cond_MgSiO3_free(Xmgsio3[, MMW])
return_T_cond_Mg2SiO4_free(Xmg2sio4[, MMW])
return_T_cond_Na2S(FeH, CO[, MMW])
return_T_cond_Na2S_free(Xna2s[, MMW])
return_T_cond_KCL(FeH, CO[, MMW])
return_T_cond_KCL_free(Xkcl[, MMW])
simple_cdf_Fe(press, temp, FeH, CO[, MMW])
simple_cdf_Fe_free(press, temp, XFe[, MMW])
simple_cdf_MgSiO3(press, temp, FeH, CO[, MMW])
simple_cdf_MgSiO3_free(press, temp, Xmgsio3[, MMW])
simple_cdf_Mg2SiO4(press, temp, FeH, CO[, MMW])
simple_cdf_Mg2SiO4_free(press, temp, Xmg2sio4[, MMW])
simple_cdf_Na2S(press, temp, FeH, CO[, MMW])
simple_cdf_Na2S_free(press, temp, XNa2S[, MMW])
simple_cdf_KCL(press, temp, FeH, CO[, MMW])
simple_cdf_KCL_free(press, temp, XKCL[, MMW])

Attributes

plotting
metals
nfracs
masses
FeHs
kappa_IR

petitRADTRANS.retrieval.cloud_cond.plotting = False

petitRADTRANS.retrieval.cloud_cond.metals = ['C', 'N', 'O', 'Na', 'Mg', 'Al', 'Si', 'P', 'S', 'Cl', 'K', 'Ca', 'Ti', 'V', 'Fe', 'Ni']

petitRADTRANS.retrieval.cloud_cond.nfracs

petitRADTRANS.retrieval.cloud_cond.masses

petitRADTRANS.retrieval.cloud_cond.setup_clouds(pressures, parameters, cloud_species)

This function provides the set of cloud parameters used in petitRADTRANS. This will be some combination of atmospheric parameters (fsed and Kzz), distribution descriptions (log normal or hansen) and the cloud particle radius. Fsed and the particle radii can be provided on a per-cloud basis.

Args:

pressuresnp.ndarray

The pressure array used to provide the atmospheric grid

parametersdict

The dictionary of parameters passed to the model function. Should contain:

• 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

cloud_specieslist

A list of the names of each of the cloud species used in the atmosphere.

Returns:

sigma_lnormfloat, None

The width of a log normal particle size distribution

fsedsdict, None

The sedimentation fraction for each cloud species in the atmosphere

kzznp.ndarray, None

The vertical mixing parameter

b_hansfloat, None

The width of a hansen particle size distribution

radiidict, None

The central radius of the particle size distribution

distributionstring

Either “lognormal” or “hansen” - tells pRT which distribution to use.

petitRADTRANS.retrieval.cloud_cond.get_fseds(parameters, cloud_species)

This function checks to see if the fsed values are input on a per-cloud basis or only as a single value, and returns the dictionary providing the fsed values for each cloud, or None, if no cloud is used.

petitRADTRANS.retrieval.cloud_cond.setup_clouds(pressures, parameters, cloud_species)

This function provides the set of cloud parameters used in petitRADTRANS. This will be some combination of atmospheric parameters (fsed and Kzz), distribution descriptions (log normal or hansen) and the cloud particle radius. Fsed and the particle radii can be provided on a per-cloud basis.

Args:

pressuresnp.ndarray

The pressure array used to provide the atmospheric grid

parametersdict

The dictionary of parameters passed to the model function. Should contain:

• 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

cloud_specieslist

A list of the names of each of the cloud species used in the atmosphere.

Returns:

sigma_lnormfloat, None

The width of a log normal particle size distribution

fsedsdict, None

The sedimentation fraction for each cloud species in the atmosphere

kzznp.ndarray, None

The vertical mixing parameter

b_hansfloat, None

The width of a hansen particle size distribution

radiidict, None

The central radius of the particle size distribution

distributionstring

Either “lognormal” or “hansen” - tells pRT which distribution to use.

petitRADTRANS.retrieval.cloud_cond.cloud_dict(parameters, parameter_name, cloud_species, shape=0)

This is a generic method to create a dictionary of parameters values for a given cloud parameterization, testing if the parameter should be filled on a per-species basis or if each cloud species should have the same value.

petitRADTRANS.retrieval.cloud_cond.get_fseds(parameters, cloud_species)

This function checks to see if the fsed values are input on a per-cloud basis or only as a single value, and returns the dictionary providing the fsed values for each cloud, or None, if no cloud is used.

petitRADTRANS.retrieval.cloud_cond.get_bhans(parameters, cloud_species, shape=0)

This function checks to see if the bhans values are input on a per-cloud basis or only as a single value, and returns the dictionary providing the fsed values for each cloud, or None, if no cloud is used.

petitRADTRANS.retrieval.cloud_cond.return_cloud_mass_fraction(name, FeH, CO)

petitRADTRANS.retrieval.cloud_cond.simple_cdf(name, press, temp, FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.simple_cdf_free(name, press, temp, mfrac, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_XFe(FeH, CO)

petitRADTRANS.retrieval.cloud_cond.return_XMgSiO3(FeH, CO)

petitRADTRANS.retrieval.cloud_cond.return_XMg2SiO4(FeH, CO)

petitRADTRANS.retrieval.cloud_cond.return_XNa2S(FeH, CO)

petitRADTRANS.retrieval.cloud_cond.return_XKCL(FeH, CO)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_Fe(FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_Fe_l(FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_Fe_comb(FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_Fe_free(XFe, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_Fe_l_free(XFe, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_Fe_comb_free(XFe, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_MgSiO3(FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_Mg2SiO4(FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_MgSiO3_free(Xmgsio3, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_Mg2SiO4_free(Xmg2sio4, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_Na2S(FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_Na2S_free(Xna2s, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_KCL(FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.return_T_cond_KCL_free(Xkcl, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.FeHs = [0.0]

petitRADTRANS.retrieval.cloud_cond.simple_cdf_Fe(press, temp, FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.simple_cdf_Fe_free(press, temp, XFe, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.simple_cdf_MgSiO3(press, temp, FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.simple_cdf_MgSiO3_free(press, temp, Xmgsio3, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.simple_cdf_Mg2SiO4(press, temp, FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.simple_cdf_Mg2SiO4_free(press, temp, Xmg2sio4, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.simple_cdf_Na2S(press, temp, FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.simple_cdf_Na2S_free(press, temp, XNa2S, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.simple_cdf_KCL(press, temp, FeH, CO, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.simple_cdf_KCL_free(press, temp, XKCL, MMW=2.33)

petitRADTRANS.retrieval.cloud_cond.kappa_IR = 0.01