carmapy.example

carmapy.example#

Example simulation configs and data

Functions

example_2d_levels()

Loads example atmospheric structure "levels" for a 2d CARMApy run.

example_carma(…)

Initializes and returns a Carma object with an example atmospheric structure based on a sonora diamondback run (Morley et al. 2024)/.

example_levels(…)

Loads example atmospheric structure "levels." Atmospheric levels describe the boundaries between atmospheric layers and thus the length of "levels" arrays is one more than that of the "centers" arrays.
carmapy.example.example_2d_levels()#

Loads example atmospheric structure “levels” for a 2d CARMApy run.

The bundled profile is a hot Jupiter (Teq = 1800 K, log g = 3.3 cgs, Rp = 1.3 Rjup, solar metallicity, no drag, no TiO/VO) derived from a GCM grid and latitude-averaged over |lat| <= 20°. The eddy diffusion profile follows Moses et al. (2021) Eq 1 with a 1e11 cm²/s ceiling.

Return type:

tuple[ndarray, ndarray, ndarray, ndarray, ndarray]

Returns:

  • P_levels (np.ndarray) – Pressure levels array (NZ) [barye]

  • T_levels (np.ndarray) – Temperature levels array (NZ, NLONGITUDE) [K]

  • kzz_levels (np.ndarray) – Eddy diffusion coefficients (NZ) [cm²/s]

  • U_levels (np.ndarray) – Zonal wind speed (NZ, NLONGITUDE) [cm/s]

  • longitudes (np.ndarray) – Longitude points (NLONGITUDE) [degrees]

carmapy.example.example_carma(name)#

Initializes and returns a Carma object with an example atmospheric structure based on a sonora diamondback run (Morley et al. 2024)/

The returned carma object includes Pure TiO2 and Mg2SiO4 on TiO2 clouds

Parameters:

name (str) – A name identifier for the CARMA model instance.

Returns:

An initialized and configured CARMA model object.

Return type:

Carma

carmapy.example.example_levels(t=2000)#

Loads example atmospheric structure “levels.” Atmospheric levels describe the boundaries between atmospheric layers and thus the length of “levels” arrays is one more than that of the “centers” arrays.

The files are taken from a (default 2000 K), log g = 4.5, f_sed = 4, log [Fe/H] = 1 sonora diamondback [1] run.

References

Parameters:

t (int) – Temperature of the sample P-T profile to use in K. Defaults to 2000. Options are 1000 or 2000.

Return type:

tuple[ndarray, ndarray, ndarray, ndarray]

Returns:

  • P_levels (np.ndarray) – Pressure levels [barye]

  • T_levels (np.ndarray)) – Temperature levels [K]

  • kzz_levels (np.ndarray) – Eddy diffusion coefficients [cm²/s]

  • mu_levels (np.ndarray) – mean molecular weights [dimensionless]