3.7.8.1. Report Definitions

Each report is defined with a dict containing several options. The name of the key is the name of the report, so for example pycart --report case will look for a definition under "case" in the "Report" section. If pycart --report is called without a report name, cape will update the first report definition it finds. Reports named any of "Reports", "Archive", "Sweeps", "Figures", or "Subfigures" (case-sensitive) are not allowed.

The options used to describe a single report are listed below.

case: dict

Definition of report named "case"

Title: str

Title placed on title page and PDF title

Subtitle: str

Subtitle placed on title page

Author: str

LaTeX string of author(s) printed on title page

Affiliation: str

Name of institution or otherwise to be placed below author

Logo: str

File name (relative to report/ folder) of logo to place on bottom left of each report page

Frontispiece: str

File name (relative to report/ folder) of image to be placed on title page

Restriction: {""} | "SBU - ITAR" | str

Data release restriction to place in center footnote if applicable

ShowCaseNumber: True | {False}

Whether or not to print the case number on each page

Sweeps: {[]} | list (str)

List of names of sweeps (plots of run matrix subsets) to include

Figures: {[]} | list (str)

List of figures for analysis of each case that has been run at least one iteration

ErrorFigures: {[]} | list (str)

List of figures for each case with "ERROR" status, defaults to value of Figures

ZeroFigures: {[]} | list (str)

List of figures for each cases that have a folder but have not run for any iterations yet and are not marked "ERROR", defaults to value of Figures