Skip to content

Usage

Command-line interface

timex <working_directory> [options]
Option Description
-v, --verbose Enable verbose console output
-o, --outdir Output directory name (default: out)

Examples

timex examples/hip67522b
timex examples/hip67522b -v
timex examples/hip67522b -o model1

Python API

import yaml
from timex.fit import TransitFit

sys_params = yaml.load(open('sys.yaml'), Loader=yaml.FullLoader)
fit_params = yaml.load(open('fit.yaml'), Loader=yaml.FullLoader)

fit = TransitFit(sys_params, fit_params, wd='.')
fit.build_model()
fit.clip_outliers()
fit.sample()
fit.plot_corner()
fit.save_results()

Loading saved results

from timex.fit import TransitFit

fit = TransitFit.from_dir('examples/hip67522b')

Pipeline

The timex CLI runs the following steps in order:

  1. Load data -- read light curve files, bin, detrend
  2. Build model -- construct PyMC model with priors, optimize for MAP solution
  3. Clip outliers -- sigma-clip residuals (if clip: true in data config)
  4. Re-fit -- rebuild model with outlier mask applied
  5. Sample -- MCMC sampling with PyMC
  6. Plot -- light curve fits, corner plots, trace plots, limb darkening
  7. Save -- summary statistics, transit times, posterior samples, corrected light curves

Outputs

All outputs are saved to the out/ directory (or custom --outdir):

File Description
fit.png Light curve fit with residuals
corner.png Corner plot of posterior distributions
trace.png MCMC trace plot
summary.csv Parameter summary statistics
tc.txt Fitted transit center times
ic.txt Information criteria (BIC, AIC, AICc)
posterior_samples.csv.gz Full posterior samples
*-cor.csv Corrected (detrended) light curves
timex.log Full log file
fit.yaml, sys.yaml Copies of input configuration