Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.54 KB

README.md

File metadata and controls

59 lines (40 loc) · 2.54 KB
Raw

RadVel

General Toolkit for Modeling Radial Velocities.

Build Status Coverage Status Documentation Status PyPI version ASCL:1801.012 Requirements Status

Attribution

Written by BJ Fulton, Erik Petigura, Sarah Blunt, and Evan Sinukoff. Fulton et al. (2018)

Please cite the original publication and the following DOI if you make use of this software in your research. DOI

Documentation

Documentation is available here

Features

With RadVel you can

  • Optimize
  • Run MCMC
    • leverages emcee package for MCMC exploration of posterior
  • Visualize
    • creates quicklook summary plots and statistics

RadVel is

  • Flexible
    • fix/float parameters that are indexed as strings (emulates lmfit API)
    • convert between different parameterizations e.g. e omega <-> sqrtecosw sqrtesinw
    • incorporate RVs from multiple telescopes
  • Extensible
    • Object-oriented programing makes adding new likelihoods, priors, etc. easy
  • Scriptable
    • Code can be run through a convenient Command-line Interface (CLI)
  • Fast
    • Kepler's equation solved in C (slower Python solver also included)
    • MCMC is multi-threaded

Tutorials

Follow examples in

  • radvel/docs/tutorials/SyntheticData.ipynb
  • radvel/docs/tutorials/K2-24_Fitting+MCMC.ipynb
  • radvel/docs/tutorials/164922_Fitting+MCMC.ipynb
  • radvel/docs/tutorials/GaussianProcess-tutorial.ipynb