Examples

Worked end-to-end examples of common VARTOOLS tasks. Each page shows a command-line invocation, the real output it produces, the equivalent pyvartools script, and short notes on what's going on.

All examples use data files shipped with VARTOOLS in the EXAMPLES/ subdirectory of the source tree. Commands assume that directory is your current working directory.

Overview

Topic	Page	What it covers
Polynomial detrending	polynomial-detrending.md	Fit a quadratic in (t - tzero) and subtract it; RMS before vs. after.
Period finding	period-finding.md	Lomb-Scargle period search chained into a harmonic fit at the recovered period.
Transit injection	transit-injection.md	Generate a Mandel-Agol transit model and add it onto a clean LC.
Transit search and fit	transit-search-and-fit.md	TFA detrending followed by BLS with a trapezoidal transit fit.
RR Lyrae recovery	rrlyrae-recovery.md	Fit a real RR Lyrae template and inject it at halving amplitudes to test LS vs. multi-harmonic AoV recovery.
Batch variability	batch-variability.md	Parallel run of LS / AoV / AoV-harm / BLS / autocorrelation on a list of LCs.
Kepler FITS	kepler-fits.md	Read a Kepler long-cadence FITS file, convert flux to magnitude, and run LS.

Run them as a notebook

All seven Python examples above are also packaged as a single Jupyter notebook, python/examples/pyvartools_tour.ipynb, which you can read in the browser via GitHub's notebook renderer or download with the Raw / Download raw file button on that page. The notebook contains the same code shown on the example pages plus the matplotlib steps used to produce the figures, so you can run any example end-to-end and reproduce its plot inline.

The notebook starts with a configuration cell where you must set VARTOOLS_ROOT to your local vartools source tree before any other cell will run. See python/examples/README.md in the source repo for full launch instructions.