sunpeek.common.plot_utils.create_pdf#

sunpeek.common.plot_utils.create_pdf(fig_list, filename='sunpeek_report', export_folder=None, add_page_numbers=True, add_page_number_first_page=False, metadata=None)#

Combine matplotlib figures into a pdf report and save file to disk. Add page numbers and metadata to pdf file.

Parameters:

fig_list (List[matplotlib.figure.Figure]) – List of matplotlib figures used to create If fig_list is None, will create all figures using plot_all().
filename (str = 'pc_report', optional) – The generated pdf report will be saved under this name, with extension “.pdf”.
export_folder (Union[str, Path], optional) – Folder to which the pdf file is saved. If None, a temporary folder is used.
add_page_numbers (bool, optional) – If True, page numbers are added
add_page_number_first_page (bool, optional) – If False, first report page (cover page, see plot_cover()) has no page number.
metadata (dict, optional) – Metadata information to be attached to the pdf file. Empty dict if None.

Return type:

Optional[Path]