API reference

API reference#

These pages contain the API reference for the jaxoplanet package.

Orbital systems#

The modules to define orbital systems are:

  • keplerian : a module to define a Keplerian system made of a central object and its orbiting bodies.

  • transit : a module to define a system made of a star and its transiting planet, defined by the transit parameters assuming the planet transits at a constant velocity.

  • ttv: a module to define a system of planets featuring transit time variations.

Limb-darkened stars#

Given an orbital system, the following modules can be used to compute different kind of light curves:

  • limb-darkened : a module to compute occultation light curve of a star with polynomial limb darkening.

  • transforms : a module providing decorators to transform light curve functions.

Non-uniform surfaces#

The following modules can be used to create systems of bodies with limb-darkened and non-uniform emitting surfaces:

  • starry orbit : a module to define a system made of a central object and orbiting bodies with non-uniform emitting surfaces (optional).

  • starry light curve : a module to compute the light curve of a non-uniform star whose surface is represented by a sum of spherical harmonics.

And the following are lower-level modules to define and manipulate non-uniform surfaces:

  • Ylm : a lower-level module to create and manipulate vectors in the spherical harmonic basis.

  • Surface : a module to manipulate the oriented surface of spherical bodies, represented by a sum of spherical harmonics.

  • visualization : a module to visualize the surface of non-uniform spherical bodies.

Missing something? Check the full API reference.

Contents