kepmodel documentation#
The kepmodel package allows to model radial velocity and/or astrometric time series, including Keplerian orbits using kepderiv, correlated noise / GP using S+LEAF (see [3]), and linear predictors (offets, drifts, activity indicators, etc.). Planets can be easily searched for by computing a periodogram and its corresponding FAP (false alarm probability) analytically (see [2], [4]). The orbital elements can then be initialized from the periodogram (see [1], [4]) to improve the fit convergence efficiency.
Installation#
Using conda#
The kepmodel package can be installed using conda with the following command:
conda install -c conda-forge kepmodel
Using pip#
It can also be installed using pip with:
pip install kepmodel
Usage#
The kepmodel.rv.RvModel class defines a radial velocity model, the kepmodel.astro.AstroModel class defines an astrometric model, and the kepmodel.astrorv.AstroRvModel allows to model both time series at the same time.
A detailed example of the use of kepmodel (in the case of radial velocities) can be found as a DACE tutorial jupyter notebook.