CONAN.conf.load_yamlfile

CONAN.conf.load_yamlfile#

CONAN.conf.load_yamlfile(configfile, return_fit=False, init_decorr=False, lc_path=None, rv_path=None, verbose=False)#

configure CONAN from yaml file.

Parameters:

  • configfile (filepath;) – path to .yaml configuration file.

  • return_fit (bool;) – whether to immediately perform the fit from this function call. if True, the result object from the fit is also returned

  • init_decorr (bool;) – whether to run least-squares fit to determine start values of the decorrelation parameters. Default is False

  • lc_path (str;) – path to light curve files. If None, the path in the config file is used.

  • rv_path (str;) – path to radial velocity files. If None, the path in the config file is used.

  • verbose (bool;) – show print statements

Returns:

  • lc_obj, rv_obj, fit_obj. if return_fit is True, the result object of fit is also returned

  • lc_obj (object;) – light curve data object generated from CONAN.load_lighturves().

  • rv_obj (object;) – rv data object generated from CONAN.load_rvs()

  • fit_obj (object;) – fitting object generated from CONAN.fit_setup().

  • result (object;) – result object containing chains of the mcmc fit.

Contents