EXOSIMS.PlanetPhysicalModel package

Submodules

EXOSIMS.PlanetPhysicalModel.Forecaster module

class EXOSIMS.PlanetPhysicalModel.Forecaster.Forecaster(n_pop=4, **specs)[source]

Bases: FortneyMarleyCahoyMix1

Planet M-R relation model based on the FORECASTER software, Chen & Kippling 2016.

This module requires to download the fitting_parameters.h5 file from the FORECASTER GitHub repository at https://github.com/chenjj2/forecaster and add it to the PlanetPhysicalModel directory.

Parameters:: **specs – user specified values

calc_radius_from_mass(Mp)[source]

Forecast the Radius distribution given the mass distribution.

Parameters:: Mp (astropy Quantity array) – Planet mass in units of Earth mass
Returns:: Planet radius in units of Earth radius
Return type:: Rp (astropy Quantity array)

indicate(M, trans, i)[source]: indicate which M belongs to population i given transition parameter

piece_linear(hyper, M, prob_R)[source]: model: straight line

split_hyper_linear(hyper)[source]: split hyper and derive c

EXOSIMS.PlanetPhysicalModel.ForecasterMod module

class EXOSIMS.PlanetPhysicalModel.ForecasterMod.ForecasterMod(**specs)[source]

Bases: FortneyMarleyCahoyMix1

Planet M-R relation model based on modification of the FORECASTER best-fit model (Chen & Kippling 2016) as described in Savransky et al. (2019)

This modification forces all planets below hydrogen burning to have a maximum radius of 1 R_jupiter and also adds the Saturn density as an explicit point in the model

calc_mass_from_radius(Rp)[source]

Calculate planet mass from radius

Parameters:: Rp (astropy Quantity array) – Planet radius in units of Earth radius
Returns:: Planet mass in units of Earth mass
Return type:: astropy Quantity array

Note

The fit is non-invertible for Jupiter radii, so all those get 1 Jupiter mass.

calc_radius_from_mass(Mp)[source]

Calculate planet radius from mass

Parameters:: Mp (astropy Quantity array) – Planet mass in units of Earth mass
Returns:: Planet radius in units of Earth radius
Return type:: astropy Quantity array

EXOSIMS.PlanetPhysicalModel.FortneyMarleyCahoyMix1 module

class EXOSIMS.PlanetPhysicalModel.FortneyMarleyCahoyMix1.FortneyMarleyCahoyMix1(**specs)[source]

Bases: PlanetPhysicalModel

Planet density models based on Fortney & Marley, albedo models based on Cahoy. Intended for use with the Kepler-like planet population modules.

Parameters:: **specs – user specified values

Attributes:

Notes: 1. The calculation of albedo is based solely on the semi-major axis and uses a uniform distribution of metallicities to interpolate albedo from the grid in Cahoy et al. 2010.

calc_albedo_from_sma(a, prange)[source]

Helper function for calculating albedo.

We assume a uniform distribution of metallicities, and then interpolate the grid from Cahoy et al. 2010.

Parameters:: a (astropy Quanitity array) – Semi-major axis values
Returns:: Albedo values
Return type:: p (ndarray)

calc_mass_from_radius(Rp)[source]

Helper function for calculating mass given the radius.

The calculation is done in two steps, first covering all things that can only be ice/rock/iron, and then things that can be giants.

Parameters:: Rp (astropy Quantity array) – Planet radius in units of Earth radius
Returns:: Planet mass in units of Earth mass
Return type:: Mp (astropy Quantity array)

calc_radius_from_mass(Mp)[source]

Helper function for calculating radius given the mass.

The calculation is done in two steps, first covering all things that can only be ice/rock/iron, and then things that can be giants.

Parameters:: Mp (astropy Quantity array) – Planet mass in units of Earth mass
Returns:: Planet radius in units of Earth radius
Return type:: Rp (astropy Quantity array)