Reference/API

This is the API documentation for kelp.

kelp Package

Classes

Filter(wavelength, transmittance[, name])

Astronomical filter object.

Model([hotspot_offset, alpha, omega_drag, ...])

Planetary system object for generating phase curves

PhaseCurve(xi, flux[, flux_err, name, ...])

Thermal phase curve.

Planet([per, t0, inc, rp, ecc, w, a, u, fp, ...])

Transiting planet parameters.

StellarSpectrum(wavelength, ...)

Parameters:

Class Inheritance Diagram

digraph inheritance3e4c4ff342 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "Filter" [URL="../../api/kelp.Filter.html#kelp.Filter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Astronomical filter object."]; "Model" [URL="../../api/kelp.Model.html#kelp.Model",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Planetary system object for generating phase curves"]; "PhaseCurve" [URL="../../api/kelp.PhaseCurve.html#kelp.PhaseCurve",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Thermal phase curve."]; "Planet" [URL="../../api/kelp.Planet.html#kelp.Planet",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Transiting planet parameters."]; "StellarSpectrum" [URL="../../api/kelp.StellarSpectrum.html#kelp.StellarSpectrum",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; }

kelp.jax Package

Functions

reflected_phase_curve(phases, omega, g, a_rp)

Reflected light phase curve for a homogeneous sphere by Heng, Morris & Kitzmann (2021).

reflected_phase_curve_inhomogeneous(phases, ...)

Reflected light phase curve for an inhomogeneous sphere by Heng, Morris & Kitzmann (2021), with inspiration from Hu et al. (2015).

thermal_phase_curve(xi, hotspot_offset, ...)

Compute the phase curve evaluated at phases xi.