LaTeX Report¶
-
class
radvel.report.
RadvelReport
(planet, post, chains, minafactor, maxarchange, maxgr, mintz, compstats=None, derived=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, latex_compiler='pdflatex', depfiles=[])[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)
-
class
radvel.report.
TexTable
(report)[source]¶ LaTeX table
Class to handle generation of the LaTeX tables within the summary PDF.
Parameters: - report (radvel.report.RadvelReport) – radvel report object
- full (bool) – get full-length RV table [default: True]
-
tab_crit
(name_in_title=False)[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=False)[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=False)[source]¶ Table of final parameter values :param name_in_title: if True, include
the name of the star in the table title