Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.32 KB

README.md

File metadata and controls

34 lines (26 loc) · 1.32 KB
Raw

orbits

WARNING: This is still in early development. See the Initial release milestone section for details.

Currently, only the RVModel is available. orbits also provides functions to load PyMC3 parameters and define GP kernel.

orbits is a wrapper around exoplanet aimed at providing pre-defined orbit models that can be quickly setup from the API or from a configuration file. The goal is to have something similar to RadVel, but using exoplanet and PyMC3 as a backend.

The 0.1 release supports creating an RVModel with a parameter dictionary, defining GP kernels, and using the RVModel object for inference.

Installation

orbits can be installed with pip: python -m pip install orbits. It is probably a good idea to install this in a new virtual environment.

To use the development version of orbits, clone the repository and install it:

git clone https://github.com/vandalt/orbits.git
cd orbits
python -m pip install -U -e ".[dev]"

Using orbits

There is no detailed documentation yet, but examples will be added to the examples directory. There is currently an example with the K2-24 dataset. This replicates tutorials from exoplanet and RadVel.