pygsti.report.formatters

Functions for generating report tables in different formats

Module Contents

Functions

_no_format(x, specs)

_pi_python(x, specs)

special_convert_latex(x, specs)

Special conversion rules for latex

html_figure(fig, specs)

Render a html-format figure

latex_figure(fig, specs)

Render a latex-format figure

python_figure(fig, specs)

Render a python-format figure

Attributes

html

latex

format_dict

NormalHTML

NormalLatex

PiPython

convert_html

pre_convert_latex

convert_latex

mathtext_htmlorlatex

pygsti.report.formatters.html
pygsti.report.formatters.latex
pygsti.report.formatters._no_format(x, specs)
pygsti.report.formatters.format_dict
pygsti.report.formatters.NormalHTML
pygsti.report.formatters.NormalLatex
pygsti.report.formatters._pi_python(x, specs)
pygsti.report.formatters.PiPython
pygsti.report.formatters.convert_html
pygsti.report.formatters.pre_convert_latex
pygsti.report.formatters.special_convert_latex(x, specs)

Special conversion rules for latex

Parameters
  • x (object) – Object to convert

  • specs (dictionary) – dictionary of formatting options.

Returns

str

pygsti.report.formatters.convert_latex
pygsti.report.formatters.mathtext_htmlorlatex
pygsti.report.formatters.html_figure(fig, specs)

Render a html-format figure

Parameters
  • fig (ReportableQty) – A reportable quantity holding a WorkspacePlot as its value.

  • specs (dictionary) – dictionary of formatting options.

Returns

str

pygsti.report.formatters.latex_figure(fig, specs)

Render a latex-format figure

Parameters
  • fig (ReportableQty) – A reportable quantity holding a WorkspacePlot as its value.

  • specs (dictionary) – dictionary of formatting options.

Returns

str

pygsti.report.formatters.python_figure(fig, specs)

Render a python-format figure

Parameters
  • fig (ReportableQty) – A reportable quantity holding a WorkspacePlot as its value.

  • specs (dictionary) – dictionary of formatting options.

Returns

ReportableQty