/
formatters.py
331 lines (259 loc) · 10.9 KB
/
formatters.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
"""
Functions for generating report tables in different formats
"""
#***************************************************************************************************
# Copyright 2015, 2019 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
# Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights
# in this software.
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
# in compliance with the License. You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0 or in the LICENSE file in the root pyGSTi directory.
#***************************************************************************************************
from pygsti.report.convert import converter
html = converter('html') # Retrieve low-level formatters
latex = converter('latex')
from pygsti.report.formatter import Formatter as _Formatter
from pygsti.report.reportableqty import ReportableQty as _ReportableQty
import numpy as _np
import numbers as _numbers
##############################################################################
# Formatting functions #
##############################################################################
'''
For documentation on creating additional formatters, see formatter.py
If the Formatter class does not offer enough functionality,
any function with the signature (item, specs -> string) can be used as a formatter
'''
#An example of a formatting function
# 'specs' is a dictionary of rendering options
def _no_format(x, specs):
return x
# This dictionary is intentionally exported to other modules.
# Even though it can change at runtime, it never does and should not
format_dict = dict()
# 'rho' (state prep) formatting
# Replace rho with ρ
# Numbers following 'rho' -> subscripts
format_dict['Rho'] = {
'html': _Formatter(regexreplace=('rho([0-9]+)$', 'ρ<sub>%s</sub>')),
'latex': _Formatter(regexreplace=('rho([0-9]+)$', '$\\rho_{%s}$')),
'python': _no_format}
# 'E' (POVM) effect formatting
format_dict['Effect'] = {
# If label == 'Ec', return E sub C
# Otherwise, match regex and replace with subscript
'html': _Formatter(stringreturn=('Ec', 'E<sub>C</sub>'),
regexreplace=('E([0-9]+)$', 'E<sub>%s</sub>')),
'latex': _Formatter(stringreturn=('Ec', '$E_C$'),
regexreplace=('E([0-9]+)$', '$E_{%s}$')),
'python': _no_format}
NormalHTML = _Formatter(html,
ebstring='%s <span class="errorbar">± %s</span>',
nmebstring='%s <span class="nmerrorbar">± %s</span>')
NormalLatex = _Formatter(latex,
ebstring='$ \\begin{array}{c} %s \\\\ \pm %s \\end{array} $') # nmebstring will match
# Normal replacements
format_dict['Normal'] = {
'html': NormalHTML,
'latex': NormalLatex, # nmebstring will match
'python': _no_format}
# 'normal' formatting but round to 2 decimal places regardless of what is passed in to table.render()
format_dict['Rounded'] = {
'html': NormalHTML.variant(defaults={'precision': 2, 'sciprecision': 0}),
'latex': NormalLatex.variant(defaults={'precision': 2, 'sciprecision': 0}),
'python': _no_format}
# 'small' formating - make text smaller
format_dict['Small'] = {
'html': NormalHTML,
'latex': NormalLatex.variant(formatstring='\\small%s'),
'python': _no_format}
# 'small' formating - make text smaller
format_dict['Verbatim'] = {
'html': NormalHTML,
'latex': NormalLatex.variant(formatstring='\\spverb!%s!'),
'python': _no_format}
def _pi_python(x, specs):
if isinstance(x, _numbers.Number):
return x * _np.pi
else:
return x
PiPython = _Formatter(_pi_python)
# Pi formatters
format_dict['Pi'] = {
'html': NormalHTML.variant(formatstring='%sπ',
ebstring='%sπ <span class="errorbar">± %s</span>π',
nmebstring='%sπ <span class="nmerrorbar">± %s</span>π'),
'latex': NormalLatex.variant(formatstring='%s$\\pi$',
ebstring='$ \\begin{array}{c}(%s \\\\ \\pm %s)\\pi \\end{array} $'),
'python': PiPython}
# BracketFormatters
format_dict['Brackets'] = {
'html': NormalHTML.variant(defaults={'brackets': True}),
'latex': NormalLatex.variant(defaults={'brackets': True}),
'python': _no_format}
##################################################################################
# 'conversion' formatting: catch all for find/replacing specially formatted text #
##################################################################################
convert_html = NormalHTML.variant(stringreplacers=[
('\\', '\'),
('|', ' '),
('<STAR>', '★')])
pre_convert_latex = _Formatter(stringreplacers=[
("\\", "\\textbackslash"),
('%', '\\%'),
('#', '\\#'),
("half-width", "$\\nicefrac{1}{2}$-width"),
("1/2", "$\\nicefrac{1}{2}$"),
("Diamond", "$\\Diamond$"),
("Check", "\\checkmark"),
('|', '\\\\'),
('<STAR>', '\\bigstar')])
def special_convert_latex(x, specs):
"""
Special conversion rules for latex
Parameters
----------
x : object
Object to convert
specs : dictionary
dictionary of formatting options.
Returns
-------
str
"""
x = pre_convert_latex(str(x), specs)
if '\\bigstar' in x:
x = '${}$'.format(x)
if "\\\\" in x:
return '\\begin{tabular}{c}' + x + '\\end{tabular}'
else:
return x
convert_latex = NormalLatex.variant(custom=special_convert_latex)
mathtext_htmlorlatex = _Formatter(
stringreplacers=[('log', '\\log'),
('Re', '\\mathrm{Re}'),
('Im', '\\mathrm{Im}'),
('*', '\\cdot ')],
formatstring='$%s$')
format_dict['Conversion'] = {
'html': convert_html,
'latex': convert_latex,
'python': _no_format}
format_dict['MathText'] = {
'html': mathtext_htmlorlatex,
'latex': mathtext_htmlorlatex,
'python': _no_format}
format_dict['Vec'] = {
'html': NormalHTML,
'latex': _Formatter(latex, ebstring='%s $\pm$ %s'),
'python': _no_format}
format_dict['Circuit'] = {
'html': _Formatter(lambda s, specs: '.'.join(map(str, s)) if s is not None else ''),
'latex': _Formatter(lambda s, specs: '' if s is None else ('$%s$' % '\\cdot'.join([('\\mbox{%s}' % str(gl))
for gl in s]))),
'python': _no_format}
'''
Figure formatters no longer use Formatter objects, because figure formatters are more specialized.
Notice that they still have the function signature (item, specs -> string)
'''
def 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
"""
#Create figure inline with 'js' set to only handlers (no further plot init)
fig.value.set_render_options(switched_item_mode="inline",
resizable="handlers only",
click_to_display=specs['click_to_display'],
link_to=specs['link_to'],
autosize=specs['autosize'],
output_dir=specs['output_dir'])
render_out = fig.value.render("html")
return render_out # a dictionary with 'html' and 'js' keys
def 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
"""
assert('output_dir' in specs and specs['output_dir']), \
"Cannot render a figure-containing table as 'latex' without a valid 'output_dir' render option"
fig.value.set_render_options(output_dir=specs['output_dir'],
render_includes=specs['render_includes'])
render_out = fig.value.render('latex')
render_out['latex'] = "\\vcenteredhbox{%s}" % render_out['latex'] # wrap std latex output
return render_out
def 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
"""
fig.value.set_render_options(switched_item_mode="inline")
render_out = fig.value.render('python') # a dict w/keys == plotIDs
plotDivID = list(render_out['python'].keys())[0] # just take info for the first figure (assume only one figure)
if specs['output_dir'] is not None: # setting output_dir signals that fig should also be rendered
fig.value.set_render_options(switched_item_mode="separate files",
output_dir=specs['output_dir'])
fig.value.render('python') # to a separate python file
return _ReportableQty(render_out['python'][plotDivID]['value'],
render_out['python'][plotDivID].get('errorbar', None))
format_dict['Figure'] = {
'html': html_figure,
'latex': latex_figure,
'python': python_figure}
# Bold formatting
format_dict['Bold'] = {
'html': _Formatter(html, formatstring='<b>%s</b>'),
'latex': _Formatter(latex, formatstring='\\textbf{%s}'),
'python': _no_format}
#Special formatting for Hamiltonian and Stochastic model types
format_dict['GatesetType'] = {
'html': _Formatter(),
'latex': _Formatter(stringreplacers=[('H', '$\\mathcal{H}$'), ('S', '$\\mathcal{S}$')]),
'python': _no_format}
'''
# 'pre' formatting, where the user gives the data in separate formats
def _pre_fmt_template(formatname):
return lambda label : label[formatname]
format_dict['Pre'] = {
'html' : _pre_fmt_template('html'),
'latex' : _pre_fmt_template('latex')}
#Multi-row and multi-column formatting (with "Conversion" type inner formatting)
format_dict['MultiRow'] = {
'html' : TupleFormatter(convert_html, formatstring='<td rowspan="{l1}">{l0}</td>'),
'latex' : TupleFormatter(convert_latex, formatstring='\\multirow{{{l1}}}{{*}}{{{l0}}}')}
def _empty_str(l): return ""
def _return_None(l): return None #signals no <td></td> in HTML
format_dict['SpannedRow'] = {
'html' : _return_None,
'latex' : _empty_str}
def _repeatno_format(label_tuple):
label, reps = label_tuple
return ["%s" % label]*reps
format_dict['MultiCol'] = {
'html' : TupleFormatter(convert_html, formatstring='<td colspan="{l1}">{l0}</td>'),
'latex' : TupleFormatter(convert_latex, formatstring='\\multicolumn{{{l1}}}{{c|}}{{{l0}}}')}
'''