import io
import json
import pathlib
from typing import Optional, Union
import plotly.graph_objects as go
import yaml
from jinja2 import Environment, FileSystemLoader
from qibo.backends import GlobalBackend
from qibolab.qubits import QubitId, QubitPairId
from qibocal.auto.execute import Executor
from qibocal.auto.mode import ExecutionMode
from qibocal.auto.runcard import Runcard
from qibocal.auto.task import Completed
from qibocal.cli.utils import META, RUNCARD
from qibocal.config import log
from qibocal.web.report import STYLES, TEMPLATES, Report
ReportOutcome = tuple[str, list[go.Figure]]
"""Report produced by protocol."""
[docs]def plotter(
node: Completed, target: Union[QubitId, QubitPairId, list[QubitId]]
) -> tuple[str, str]:
"""Run plotly pipeline for generating html.
Performs conversions of plotly figures in html rendered code for completed
node on specific target.
"""
figures, fitting_report = generate_figures_and_report(node, target)
buffer = io.StringIO()
html_list = []
for figure in figures:
figure.write_html(buffer, include_plotlyjs=False, full_html=False)
buffer.seek(0)
html_list.append(buffer.read())
buffer.close()
all_html = "".join(html_list)
return all_html, fitting_report
[docs]def report(path: pathlib.Path, executor: Optional[Executor] = None):
"""Report generation.
Generates the report for protocol dumped in `path`.
Executor can be passed to generate report on the fly.
"""
if path.exists():
log.warning(f"Regenerating {path}/index.html")
# load meta
meta = json.loads((path / META).read_text())
# load runcard
runcard = Runcard.load(yaml.safe_load((path / RUNCARD).read_text()))
# set backend, platform and qubits
GlobalBackend.set_backend(backend=meta["backend"], platform=meta["platform"])
# load executor
if executor is None:
executor = Executor.load(runcard, path, targets=runcard.targets)
# produce html
list(executor.run(mode=ExecutionMode.report))
css_styles = f"<style>\n{pathlib.Path(STYLES).read_text()}\n</style>"
env = Environment(loader=FileSystemLoader(TEMPLATES))
template = env.get_template("template.html")
html = template.render(
is_static=True,
css_styles=css_styles,
path=path,
title=path.name,
report=Report(
path=path,
targets=executor.targets,
history=executor.history,
meta=meta,
plotter=plotter,
),
)
(path / "index.html").write_text(html)