Planet

class kelp.Planet(per=None, t0=None, inc=None, rp=None, ecc=None, w=None, a=None, u=None, fp=None, t_secondary=None, T_s=None, rp_a=None, limb_dark='quadratic', name=None)[source] [edit on github]

Bases: object

Transiting planet parameters.

This is meant to be a duck-type drop-in for the batman package’s transiting exoplanet parameters TransitParams object.

Parameters:
perfloat

Orbital period [days]

t0float

Mid-transit time

incfloat

Orbital inclination [deg]

rpfloat

Ratio of planet to star radius

eccfloat

Eccentricity

wfloat

Argument of periastron [deg]

afloat

Semimajor axis normalized by the stellar radius

ulist

(i.e.) Quadratic limb-darkening parameters

fpfloat

Planetary flux out of eclipse

t_secondaryfloat

Time of secondary eclipse

T_sfloat

Temperature of the host star [K]

rp_afloat

Radius of the planet over the semimajor axis

limb_darkstr

Limb darkening law to use

namestr

Name metadata for the planet

Methods Summary

eclipse_model(xi)

Compute eclipse model at orbital phases xi.

from_name(name)

Initialize a Planet instance from the target name.

Methods Documentation

eclipse_model(xi)[source] [edit on github]

Compute eclipse model at orbital phases xi.

Parameters:
xindarray

Orbital phase angle \(\xi\)

Returns:
eclipsendarray

Eclipse model normalized such that flux is zero in eclipse.

classmethod from_name(name)[source] [edit on github]

Initialize a Planet instance from the target name.

There’s a small (but growing?) database of planets pre-defined in the kelp/data/planets.json file. If your favorite planet is missing, pull requests are welcome!

Parameters:
namestr (i.e.: “Kepler-7” or “KELT-9”)

Name of the planet