pygsti.report.section

Internal model of a section of a generated report

Submodules

Package Contents

Classes

Section

Abstract base class for report sections.

DriftSection

Abstract base class for report sections.

GaugeInvariantsGatesSection

Abstract base class for report sections.

GaugeInvariantsGermsSection

Abstract base class for report sections.

GaugeVariantSection

Abstract base class for report sections.

GaugeVariantsDecompSection

Abstract base class for report sections.

GaugeVariantsErrorGenSection

Abstract base class for report sections.

GaugeVariantsErrorGenNQubitSection

Abstract base class for report sections.

GaugeVariantsRawSection

Abstract base class for report sections.

GoodnessSection

Abstract base class for report sections.

GoodnessColorBoxPlotSection

Abstract base class for report sections.

GoodnessScalingSection

Abstract base class for report sections.

GoodnessUnmodeledSection

Abstract base class for report sections.

HelpSection

Abstract base class for report sections.

IdleTomographySection

Abstract base class for report sections.

InputSection

Abstract base class for report sections.

MetaSection

Abstract base class for report sections.

SummarySection

Abstract base class for report sections.

class pygsti.report.section.Section(**kwargs)

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE
static figure_factory(brevity_limit=None)

Decorator to designate a method as a figure factory.

Parameters

brevity_limit (int or None, optional) – Mark that this figure should only be rendered for reports with brevity strictly less than this limit. Defaults to None, indicating that the figure should always be rendered.

render(self, workspace, brevity=0, **kwargs)

Render this section’s figures.

Parameters
  • workspace (Workspace) – A Workspace used for caching figure computation.

  • brevity (int, optional) – Level of brevity used when generating this section. At higher brevity levels, certain non-critical figures will not be rendered. Defaults to 0 (most verbose).

  • **kwargs – All additional reportable quantities used when computing the figures of this section.

Returns

dict (str -> any) – Key-value map of report quantities used for this section.

class pygsti.report.section.DriftSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/Drift.html
drift_summary_table(workspace, results=None, dskey=None, **kwargs)
drift_details_table(workspace, results=None, **kwargs)
global_power_spectra_plot(workspace, results=None, dskey=None, **kwargs)
germ_fiducial_power_spectra_plot(workspace, results=None, switchboard=None, dskey=None, **kwargs)
germ_fiducial_prob_trajectories_plot(workspace, results=None, switchboard=None, dskey=None, **kwargs)
drift_detector_colorbox_plot(workspace, stabilityanalyzer=None, circuit_list=None, **kwargs)
drift_size_colorbox_plot(workspace, stabilityanalyzer=None, circuit_list=None, **kwargs)
class pygsti.report.section.GaugeInvariantsGatesSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/GaugeInvariants_gates.html
render(self, workspace, results=None, dataset_labels=None, est_labels=None, embed_figures=True, **kwargs)

Render this section’s figures.

Parameters
  • workspace (Workspace) – A Workspace used for caching figure computation.

  • brevity (int, optional) – Level of brevity used when generating this section. At higher brevity levels, certain non-critical figures will not be rendered. Defaults to 0 (most verbose).

  • **kwargs – All additional reportable quantities used when computing the figures of this section.

Returns

dict (str -> any) – Key-value map of report quantities used for this section.

final_model_spam_parameters_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
final_model_eigenvalue_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
final_model_vs_target_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
final_gates_vs_target_table_gauge_inv(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
final_gauge_inv_model_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
single_metric_table_gauge_inv(workspace, switchboard=None, dataset_labels=None, est_labels=None, gi_switchboard=None, **kwargs)
final_gauge_inv_metric_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, gr_switchboard=None, **kwargs)
gram_bar_plot(workspace, switchboard=None, **kwargs)
class pygsti.report.section.GaugeInvariantsGermsSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/GaugeInvariants_germs.html
final_gates_vs_target_table_gauge_invgerms(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
germs_eigenvalue_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
class pygsti.report.section.GaugeVariantSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/GaugeVariants.html
render(self, workspace, results=None, dataset_labels=None, est_labels=None, embed_figures=True, **kwargs)

Render this section’s figures.

Parameters
  • workspace (Workspace) – A Workspace used for caching figure computation.

  • brevity (int, optional) – Level of brevity used when generating this section. At higher brevity levels, certain non-critical figures will not be rendered. Defaults to 0 (most verbose).

  • **kwargs – All additional reportable quantities used when computing the figures of this section.

Returns

dict (str -> any) – Key-value map of report quantities used for this section.

final_model_spam_vs_target_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
final_gates_vs_target_table_gauge_var(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
final_gates_vs_target_table_gauge_vargerms(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
single_metric_table_gauge_var(workspace, switchboard=None, dataset_labels=None, est_labels=None, gv_switchboard=None, **kwargs)
class pygsti.report.section.GaugeVariantsDecompSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/GaugeVariants_decomp.html
final_model_choi_eigenvalue_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
final_model_decomposition_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
class pygsti.report.section.GaugeVariantsErrorGenSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/GaugeVariants_errgen.html
final_model_errorgen_box_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, errgen_type='logGTi', **kwargs)
errorgen_type(workspace, errgen_type='logGTi', **kwargs)
class pygsti.report.section.GaugeVariantsErrorGenNQubitSection(**kwargs)

Bases: GaugeVariantsErrorGenSection

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

final_model_errorgen_box_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, errgen_type='logGTi', **kwargs)
class pygsti.report.section.GaugeVariantsRawSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/GaugeVariants_raw.html
final_gates_box_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
final_model_brief_spam_table(workspace, switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)
class pygsti.report.section.GoodnessSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/Goodness.html
final_model_fit_colorscatter_plot(workspace, switchboard=None, linlog_percentile=5, comm=None, bgcolor='white', **kwargs)
final_model_fit_progress_table(workspace, switchboard=None, max_lengths=None, comm=None, **kwargs)
final_model_fit_progress_bar_plot(workspace, switchboard=None, max_lengths=None, comm=None, **kwargs)
class pygsti.report.section.GoodnessColorBoxPlotSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/Goodness_colorboxplot.html
final_model_fit_colorbox_plot(workspace, switchboard=None, linlog_percentile=5, brevity=0, comm=None, bgcolor='white', **kwargs)
final_model_tvd_colorbox_plot(workspace, switchboard=None, brevity=0, comm=None, bgcolor='white', **kwargs)
maxlength_switchboard1(workspace, switchboard=None, switchbd_maxlengths=None, **kwargs)
class pygsti.report.section.GoodnessScalingSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/Goodness_scaling.html
final_model_fit_colorscatter_plot_scl(workspace, switchboard=None, linlog_percentile=5, comm=None, bgcolor='white', **kwargs)
final_model_fit_colorbox_plot_scl(workspace, switchboard=None, linlog_percentile=5, brevity=0, comm=None, bgcolor='white', **kwargs)
final_model_fit_histogram_scl(workspace, switchboard=None, linlog_percentile=5, comm=None, bgcolor='white', **kwargs)
final_model_fit_progress_table_scl(workspace, switchboard=None, max_lengths=None, comm=None, **kwargs)
final_model_fit_progress_bar_plot_scl(workspace, switchboard=None, max_lengths=None, comm=None, **kwargs)
data_scaling_colorbox_plot(workspace, switchboard=None, comm=None, bgcolor='white', **kwargs)
class pygsti.report.section.GoodnessUnmodeledSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/Goodness_unmodeled.html
unmodeled_error_budget_table(workspace, switchboard=None, **kwargs)
final_model_fit_progress_bar_plot_ume(workspace, switchboard=None, max_lengths=None, comm=None, **kwargs)
final_model_fit_progress_table_ume(workspace, switchboard=None, max_lengths=None, comm=None, **kwargs)
final_model_fit_histogram_ume(workspace, switchboard=None, linlog_percentile=5, comm=None, bgcolor='white', **kwargs)
final_model_fit_colorbox_plot_ume(workspace, switchboard=None, linlog_percentile=5, brevity=0, comm=None, bgcolor='white', **kwargs)
final_model_fit_colorscatter_plot_ume(workspace, switchboard=None, linlog_percentile=5, comm=None, bgcolor='white', **kwargs)
class pygsti.report.section.HelpSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/Help.html
example_table(workspace, switchboard, **kwargs)
class pygsti.report.section.IdleTomographySection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/IdleTomography.html
idt_intrinsic_errors_table(workspace, switchboard=None, **kwargs)
idt_observed_rates_table(workspace, switchboard=None, **kwargs)
class pygsti.report.section.InputSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/Input.html
fiducial_list_table(workspace, switchboard=None, **kwargs)
germ_list_2col_table(workspace, switchboard=None, **kwargs)
dataset_overview_table(workspace, switchboard=None, **kwargs)
target_gates_box_table(workspace, switchboard=None, **kwargs)
target_spam_brief_table(workspace, switchboard=None, **kwargs)
class pygsti.report.section.MetaSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/Meta.html
metadata_table(workspace, switchboard=None, **kwargs)
stdout_block(workspace, switchboard=None, **kwargs)
profiler_table(workspace, switchboard=None, **kwargs)
software_environment_table(workspace, **kwargs)
class pygsti.report.section.SummarySection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs – Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

_HTML_TEMPLATE = tabs/Summary.html
final_model_fit_progress_bar_plot_sum(workspace, switchboard=None, max_lengths=None, comm=None, **kwargs)
final_model_fit_histogram(workspace, switchboard=None, linlog_percentile=5, comm=None, bgcolor='white', **kwargs)
final_gates_vs_target_table_insummary(workspace, switchboard=None, confidence_level=None, ci_brevity=1, show_unmodeled_error=False, **kwargs)
final_fits_comparison_plot(workspace, switchboard=None, est_labels=None, dataset_labels=None, comm=None, **kwargs)