pygsti.report.python

Routines for converting python objects to python.

Module Contents

Functions

table(custom_headings, col_headings_formatted, rows, spec)	Create a "Python table" - really a pandas DataFrame
cell(data, label, spec)	Format the cell of a python table
list(l, specs)	Stub for conversion that isn't needed in python case.
vector(v, specs)	Stub for conversion that isn't needed in python case.
matrix(m, specs)	Stub for conversion that isn't needed in python case.
value(el, specs)	Stub for conversion that isn't needed in python case.
escaped(txt, specs)	Stub for conversion that isn't needed in python case.

pygsti.report.python.table(custom_headings, col_headings_formatted, rows, spec)

Create a “Python table” - really a pandas DataFrame

Parameters

custom_headingsNone, dict

optional dictionary of custom table headings

col_headings_formattedlist

formatted column headings

rowslist of lists of cell-strings

Data in the table, pre-formatted

specdict

options for the formatter

Returns

dictcontains key ‘python’, which corresponds to a

pandas.DataFrame object representing the table

pygsti.report.python.cell(data, label, spec)

Format the cell of a python table

Parameters

datastring

string representation of cell content

labelstring

optional cell label, used for tooltips

specdict

options for the formatters

Returns

string

pygsti.report.python.list(l, specs)

Stub for conversion that isn’t needed in python case.

(Convert a python list to python.)

Parameters

llist

list to convert into latex. sub-items pre formatted

specsdictionary

Dictionary of user-specified and default parameters to formatting

Returns

list

pygsti.report.python.vector(v, specs)

Stub for conversion that isn’t needed in python case.

(Convert a 1D numpy array to python.)

Parameters

vnumpy array

1D array to convert.

specsdictionary

Dictionary of user-specified and default parameters to formatting

Returns

numpy array

pygsti.report.python.matrix(m, specs)

Stub for conversion that isn’t needed in python case.

Convert a 2D numpy array to python.

Parameters

mnumpy array

2D array to convert.

specsdictionary

Dictionary of user-specified and default parameters to formatting

Returns

numpy array

pygsti.report.python.value(el, specs)

Stub for conversion that isn’t needed in python case.

(this function would be for converting python to python).

Parameters

elfloat or complex

Value to convert into latex.

specsdictionary

Dictionary of user-specified and default parameters to formatting

Returns

float or complex

pygsti.report.python.escaped(txt, specs)

Stub for conversion that isn’t needed in python case.

(Escape txt so it is python safe.)

Parameters

txtstring

value to escape

specsdictionary

Dictionary of user-specified and default parameters to formatting

Returns

string