Skip to main content

ravest

Radial Velocity fitting with Bayesian model comparison

GitHub PyPI version CI/CD codecov Documentation Status License: GPL v3

Features:

  • Model exoplanets and host stars, to simulate RV data for given orbital and instrumental parameters
  • Fit RV data with MCMC to explore posterior distributions for parameters - including Gaussian Processes for stellar activity
  • Bayesian Model Comparison using the Learned Harmonic Mean Estimator from harmonic
  • Visualise/animate the star's orbit (coming soon!)

Check out the example notebooks at the online documentation to see examples of how to do all of these!

GitHub: github.com/ross-dobson/ravest

Installation

It should be as simple as

$ pip install ravest

JAX is a requirement for ravest (and harmonic), so you may want to consult the JAX installation docs if you want GPU or TPU support (tl;dr: install JAX first according to those instructions, then install ravest on top).

Usage

For an example of how to fit a model to RV data, see Example 1: fitting a single planet, where we fit ELODIE data for 51 Peg b.

For fitting a two-planet system, comparing circular and eccentric orbits, see Example 2: fitting a two-planet system, where we fit HIRES data for K2-24.

For an example of how to use a Gaussian Process to mitigate stellar variability, see Example 3: fitting with a Gaussian Process, where we use a quasiperiodic kernel on HARPS data for K2-229.

For an example on using the Learned Harmonic Mean Estimator from harmonic to compare two competing RV models by estimating the Bayesian evidence $\mathcal{Z}$ and Bayes factors, see Example 4: using the Learned Harmonic Mean Estimator, where we compare a one-planet and two-planet fit for TOI-544. It also demonstrates a multi-instrument fit, using both HARPS and HARPS-N data.

If you have any questions, check the Frequently Asked Questions, raise an issue on Github, or email me and I'll be happy to help.

Citing ravest

If you use ravest in your research, please cite Dobson et al. (2026).

If you use the Learned Harmonic Mean Estimator for Bayesian evidence estimation, then please also cite the harmonic team: see their GitHub repository for the relevant papers to cite, starting with McEwen et al. (2021).

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

Acknowledgements

Ravest makes use of the following open-source packages:

  • NumPy for numerical computing
  • SciPy for scientific computing algorithms
  • Matplotlib for plotting and visualisation
  • Astropy for astronomical calculations and utilities
  • pandas for data manipulation
  • tqdm for progress bars
  • emcee for MCMC sampling
  • corner for visualising posterior distributions
  • tinygp for Gaussian Process modelling
  • JAX for accelerated array computing and 64-bit precision, also required by tinygp and harmonic
  • harmonic for Bayesian evidence estimation via the Learned Harmonic Mean Estimator

License

ravest was created by Ross Dobson. It is licensed under the terms of the GNU General Public License v3.0 or later (GPL-3.0-or-later).

Metadata

Release files for ravest 0.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ravest 0.4.1
File Size Uploaded
ravest-0.4.1.tar.gz 107.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ravest 0.4.1
File Interpreter ABI Platform
ravest-0.4.1-py3-none-any.whl Python 3 none any Details

Total release size: 215.8 kB

Release files / ravest-0.4.1.tar.gz

Download URL ravest-0.4.1.tar.gz
Size 107.2 kB
Tags Source
SHA-256 checksum
How to use checksums
2eba6ba82f785ffde2b340d38d9b019aa135d772b5a83d4bc7d30ed3eaa4d0ab
BLAKE2b-256 checksum
How to use checksums
01b06ba3ea5dea927d9ddb4e1d58e628bdd5d9783e5951ce22b6fccaa46dff96
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.1 CPython/3.11.13 Darwin/27.0.0

Release files / ravest-0.4.1-py3-none-any.whl

Download URL ravest-0.4.1-py3-none-any.whl
Size 108.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
aeea19b60fc374908fa11719a1a4bf3bf00505d5b4c18babdc142a7ab80057d3
BLAKE2b-256 checksum
How to use checksums
3007aeb41cb3ffb341e34cf5bca4fc46c7d070dce85afff21bf9184a7f30569f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.1 CPython/3.11.13 Darwin/27.0.0

Release history Release notifications | RSS feed

This release

0.4.1 This release

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.0

2 release files

0.1.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page