Driver

class orbitize.driver.Driver(input_data, sampler_str, num_secondary_bodies, stellar_or_system_mass, plx, mass_err=0, plx_err=0, lnlike='chi2_lnlike', chi2_type='standard', system_kwargs=None, mcmc_kwargs=None)[source]

Runs through orbitize methods in a standardized way.

Parameters:

  • input_data – Either a relative path to data file or astropy.table.Table object in the orbitize format. See orbitize.read_input

  • sampler_str (str) – algorithm to use for orbit computation. “MCMC” for Markov Chain Monte Carlo, “OFTI” for Orbits for the Impatient, “NestedSampler” for nested sampling with Dynesty, or “MultiNest” for nested sampling with (Py)MultiNest.

  • num_secondary_bodies (int) – number of secondary bodies in the system. Should be at least 1.

  • stellar_or_system_mass (float) – mass of the primary star (if fitting for dynamical masses of both components) or total system mass (if fitting using relative astrometry only) [M_sol]

  • plx (float) – mean parallax of the system [mas]

  • mass_err (float, optional) – uncertainty on stellar_or_system_mass [M_sol]

  • plx_err (float, optional) – uncertainty on plx [mas]

  • lnlike (str, optional) – name of function in orbitize.lnlike that will be used to compute likelihood. (default=”chi2_lnlike”)

  • chi2_type (str, optional) – either “standard”, or “log”

  • system_kwargs (dict, optional) – restrict_angle_ranges, tau_ref_epoch, fit_secondary_mass, hipparcos_IAD, gaia, use_rebound, fitting_basis for orbitize.system.System.

  • mcmc_kwargs (dict, optional) – num_temps, num_walkers, and num_threads kwargs for orbitize.sampler.MCMC

Written: Sarah Blunt, 2018