Pipeline Driver Functions

Driver functions for the radvel pipeline.These functions are meant to be used only withthe cli.py command line interface.

radvel.driver.derive(args: ArgumentParser) None[source]

Derive physical parameters from posterior samples

Parameters:

args (ArgumentParser) – command line arguments

radvel.driver.fit(args: ArgumentParser) None[source]

Perform maximum a posteriori fit

Parameters:

args (ArgumentParser) – command line arguments

radvel.driver.ic_compare(args: ArgumentParser) None[source]
Compare different models and comparative statistics including

AIC and BIC statistics.

Parameters:

args (ArgumentParser) – command line arguments

radvel.driver.load_status(statfile: str) RawConfigParser[source]

Load pipeline status

Parameters:

statfile (string) – name of configparser file

Returns:

configparser.RawConfigParser

radvel.driver.mcmc(args: ArgumentParser) None[source]

Perform MCMC error analysis

Parameters:

args (ArgumentParser) – command line arguments

radvel.driver.nested_sampling(args: ArgumentParser) None[source]

Perform nested sampling

Parameters:

args (ArgumentParser) – command line arguments

radvel.driver.plots(args: ArgumentParser) None[source]

Generate plots

Parameters:

args (ArgumentParser) – command line arguments

radvel.driver.report(args: ArgumentParser) None[source]

Generate summary report

Parameters:

args (ArgumentParser) – command line arguments

radvel.driver.save_status(statfile: str, section: str, statevars: dict) None[source]

Save pipeline status

Parameters:
  • statfile (string) – name of output file

  • section (string) – name of section to write

  • statevars (dict) – dictionary of all options to populate the specified section

radvel.driver.tables(args: ArgumentParser) None[source]

Generate TeX code for tables in summary report

Parameters:

args (ArgumentParser) – command line arguments