User Guide

This section outlines the core components for modeling your exoplanet interiors and host stars.

Planet

class exopie.planet(Mass=[1, 0.001], Radius=[1, 0.001], Teq=[1000, 10], N=50000, planet_type=None, **kwargs)

Bases: exoplanet

run(tol=1e-08, host_star=None, **kwargs)

Running Monte Carlo simulation of assumed planet model.

Parameters:

tol: float

Tolerance of a minimization function, when modeling interior.

host_star: class

Host star object with all the properties.

kwargs:

parameters provided to the minerology model, ignored if host_star provided.

Note:

1. xSi and xFe parameters are only used for purely rocky model.

2. The CMF parameter is assumed to be Rocky core mass fraction, such that rcmf = (1-wmf)/cmf.

3. For H/He model the CMF parameter is fixed for the moment.

Star

class exopie.star(Fe=[0, 0.04], Mg=[0, 0.04], Si=[0, 0.04], prior=None, normalization=None, N=50000, **kwargs)

Bases: object

Wrapper to compute the planet equivelent interior given the host star elemental abundances, using chemical interior model that allows for all the major and minor mineralogies. However, for stars that have Mg/Si<0.86 the planet equivelent interior switches to allow SiO2, which may not be as representative or real planet composition.

Parameters:

N: int

Number of samples to generate, default is 50000.

Fe: list

Set host star Fe abundance in dex and normalized to Sun, assumes normal distribution or skew normal distribution. Format: [mu, sigma] or [mu, sigma_up, sigma_lw] or posterior size [n].

Mg: list

Set host star Fe abundance in dex and normalized to Sun, assumes normal distribution or skew normal distribution. Format: [mu, sigma] or [mu, sigma_up, sigma_lw] or posterior size [n].

Si: list

Set host star Fe abundance in dex and normalized to Sun, assumes normal distribution or skew normal distribution. Format: [mu, sigma] or [mu, sigma_up, sigma_lw] or posterior size [n].

prior: list

List of refractory ratios to constrain the minerology of planet equivelent. Default is [‘Fe/Si’, ‘Fe/Mg’, ‘Mg/Si’], but if Ca, Al, Ni is defined the prior is expanded.

normalization: list

List of solar abundances for normalization. Default is Asplund 2021 solar abundances for Fe, Si, Mg, Ca, Al, Ni in log scale.

Attributes:

FeMF: array

Iron mass fraction

SiMF: array

Silicon mass fraction

MgMF: array

Magnesium mass fraction

CMF: array

Core mass fraction

Methods:

to_planet()

Executes the chemical model to compute the planet equivalent composition.

to_planet(tol=1e-08)