LaTeX Report

class radvel.report.RadvelReport(planet: ModuleType, post: Posterior, chains: <Mock name = 'mock.DataFrame' id='135641087121584'>, minafactor: float, maxarchange: float, maxgr: float, mintz: int, compstats: dict | None = None, derived: bool = False)[source]

Radvel report

Class to handle the creation of the radvel summary PDF

Parameters:

  • planet (planet object) – planet configuration object loaded in kepfit.py using imp.load_source

  • post (radvel.posterior) –

    radvel.posterior object containing the best-fit parameters in

    post.params

  • compstats (dict) – dictionary of model comparison results from radvel ic

  • derived (bool) – included table of derived parameters

  • chains (DataFrame) – output DataFrame from a radvel.mcmc run

  • criterion (DataFrame) – output DataFrame from a ‘radvel.mcmc’ run

compile(pdfname: str, latex_compiler: str = 'pdflatex', depfiles: list[str] = []) → None[source]

Compile radvel report

Compile the radvel report from a string containing TeX code and save the resulting PDF to a file.

Parameters:

  • pdfname (str) – name of the output PDF file

  • latex_compiler (str) – path to latex compiler

  • depfiles (list) – list of file names of dependencies needed for LaTex compilation (e.g. figure files)

texdoc() → str[source]

TeX for entire document

Returns:

TeX code for report

Return type:

str

class radvel.report.TexTable(report: RadvelReport)[source]

LaTeX table

Class to handle generation of the LaTeX tables within the summary PDF.

Parameters:
tab_comparison() → str[source]

Model comparisons

tab_crit(name_in_title: bool = False) → str[source]

Table of final convergence criterion values :param name_in_title: if True, include

the name of the star in the table title

tab_derived(name_in_title: bool = False) → str[source]

Table of derived parameter values :param name_in_title: if True, include

the name of the star in the table title

tab_params(name_in_title: bool = False) → str[source]

Table of final parameter values :param name_in_title: if True, include

the name of the star in the table title

tab_prior_summary(name_in_title: bool = False) → str[source]

Summary of priors

Parameters:

name_in_title (Bool [optional]) – if True, include the name of the star in the table title

tab_rv(name_in_title: bool = False, max_lines: int | None = 50) → str[source]

Table of input velocities

Parameters:

name_in_title (Bool [optional]) – if True, include the name of the star in the table title