API reference

The transit models have their APIs on their own pages under Transit models, and the supporting modules on Stellar spectra, Contamination, and Data containers. This section collects what is left: the base class the models share, the limb darkening functions, and the deprecated pre-2.9 evaluation methods.

• TransitModel
  • TransitModel
  • Limb darkening model interface
• Limb darkening functions
  • Uniform
  • Linear
  • Quadratic
  • Quadratic, triangular parametrisation
  • Power-2
  • Power-2, (h1, h2) parametrisation
  • Square root
  • Logarithmic
  • Exponential
  • Non-linear
  • General
  • Evaluation helpers
• Deprecated evaluation API
  • Migrating
  • Silencing the warnings
  • Numba models
  • OpenCL models

Quick index

Transit models

Class	Import	Page
RoadRunnerModel	from pytransit import RoadRunnerModel	RoadRunner model
TransmissionSpectroscopyModel	from pytransit import TSModel	Transmission spectroscopy model
OblatePlanetModel	from pytransit import OPModel	Oblate planet model
EclipseModel	from pytransit import EclipseModel	Eclipse models
EclipseSpectroscopyModel	from pytransit import ESModel	Eclipse models
QuadraticModel	from pytransit import QuadraticModel	Quadratic model
QPower2Model	from pytransit import QPower2Model	Power-2 model
GeneralModel	from pytransit import GeneralModel	General model
UniformModel	from pytransit import UniformModel	Uniform model
ChromosphereModel	from pytransit import ChromosphereModel	Chromosphere model
GravityDarkenedModel	from pytransit import GravityDarkenedModel	Gravity-darkened model
UniformModelCL	from pytransit import UniformModelCL	OpenCL models
QuadraticModelCL	from pytransit import QuadraticModelCL	OpenCL models
QPower2ModelCL	from pytransit import QPower2ModelCL	OpenCL models
RoadRunnerModelCL	from pytransit.models.roadrunner.rrmodel_cl import RoadRunnerModelCL	OpenCL models

Supporting modules

Module	Contents
pytransit.stars	BT-Settl and Husser et al. (2013) stellar spectrum grids.
pytransit.contamination	Passbands, instruments, and flux contamination models.
pytransit.utils.io	Light curve and radial velocity data containers.
pytransit.models.limb_darkening	Numba-compiled limb darkening profiles and their disk integrals.