Source code for orbitize.driver

import orbitize.read_input
import orbitize.system
import orbitize.sampler

This module reads input and constructs ``orbitize`` objects
in a standardized way.

[docs]class Driver(object): """ Runs through ``orbitize`` methods in a standardized way. Args: 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 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 """ def __init__( self, 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 ): # Read in data # Try to interpret input as a filename first try: data_table = orbitize.read_input.read_file(input_data) except: try: # Check if input might be an orbitize style astropy.table.Table if 'quant_type' in input_data.columns: data_table = input_data.copy() except: raise Exception('Invalid value of input_data for Driver') if system_kwargs is None: system_kwargs = {} #Check if RV data is included, make sure fit_secondary_mass=True if 'rv' in data_table['quant_type'] and ('fit_secondary_mass' not in system_kwargs or system_kwargs['fit_secondary_mass'] == False): raise Exception('If including RV data in orbit fit, set fit_secondary_mass=True') if sampler_str == 'OFTI' and ('fit_secondary_mass' in system_kwargs and True == system_kwargs['fit_secondary_mass']): raise Exception('Run Astrometry+RV in MCMC for now.') # Initialize System object which stores data & sets priors self.system = orbitize.system.System( num_secondary_bodies, data_table, stellar_or_system_mass, plx, mass_err=mass_err, plx_err=plx_err, **system_kwargs ) # Initialize Sampler object, which has System object as an attribute. if mcmc_kwargs is not None and sampler_str == 'MCMC': kwargs = mcmc_kwargs else: kwargs = {} sampler_func = getattr(orbitize.sampler, sampler_str) self.sampler = sampler_func(self.system, like=lnlike, chi2_type=chi2_type, **kwargs)