pygsti.report.Results¶
-
class
pygsti.report.
Results
(templatePath=None, latexCmd='pdflatex')¶ Encapsulates a set of GST results.
A Results object is constructed from the input parameters and raw output gatesets from a GST calculation, typically performed by one of the “do<something>” methods of GST.Core, and acts as a end-output factory (creating reports, presentations, etc), and a derived-results cache (so derived quantities don’t need to be recomputed many times for different output formats).
-
__init__
(templatePath=None, latexCmd='pdflatex') Initialize a Results object.
Parameters: - templatePath (string or None, optional) – A local path to the stored GST report template files. The default value of None means to use the default path, which is almost always what you want.
- latexCmd (string or None, optional) – The system command used to compile latex documents.
Methods
__init__
([templatePath, latexCmd])Initialize a Results object. create_brief_report_pdf
([confidenceLevel, ...])Create a “brief” GST report. create_full_report_pdf
([confidenceLevel, ...])Create a “full” GST report. create_general_report_pdf
([confidenceLevel, ...])Create a “general” GST report. create_presentation_pdf
([confidenceLevel, ...])Create a GST presentation (i.e. create_presentation_ppt
([confidenceLevel, ...])Create a GST Microsoft Powerpoint presentation. init_Ls_and_germs
(objective, targetGateset, ...)Initialize this Results object from the inputs and outputs of an iterative GST method based on gate string lists containing germs repeated up to a maximum-L value that increases with iteration. init_single
(objective, targetGateset, ...[, ...])Initialize this Results object from the inputs and outputs of a single (non-iterative) GST method. -