QuantumGraphExecutionReport¶
- class lsst.pipe.base.execution_reports.QuantumGraphExecutionReport(tasks: dict[str, lsst.pipe.base.execution_reports.TaskExecutionReport] = <factory>)¶
Bases:
object
A report on the execution of a quantum graph.
Report the detailed status of each failure; whether tasks were not run, data is missing from upstream failures, or specific errors occurred during task execution (and report the errors). Contains a count of expected, produced DatasetTypes for each task. This report can be output as a dictionary or a yaml file.
See also
TaskExecutionReport
A task report.
DatasetTypeExecutionReport
A dataset type report.
- Attributes:
- tasks
dict
A dictionary of TaskExecutionReports by task label.
- tasks
Methods Summary
make_reports
(butler, graph)Make a
QuantumGraphExecutionReport
.to_summary_dict
(butler[, do_store_logs, ...])Summarize the results of the
QuantumGraphExecutionReport
in a dictionary.write_summary_yaml
(butler, filename[, ...])Take the dictionary from
QuantumGraphExecutionReport.to_summary_dict
and store its contents in a yaml file.Methods Documentation
- classmethod make_reports(butler: Butler, graph: QuantumGraph | str | ParseResult | ResourcePath | Path) QuantumGraphExecutionReport ¶
Make a
QuantumGraphExecutionReport
.Step through the quantum graph associated with a run, creating a
networkx.DiGraph
called status_graph to annotate the status of each quantum node. For each task in the quantum graph, useTaskExecutionReport.inspect_quantum
to make aTaskExecutionReport
based on the status of each node. Return aTaskExecutionReport
for each task in the quantum graph.- Parameters:
- butler
lsst.daf.butler.Butler
The Butler used for this report. This should match the Butler used for the run associated with the executed quantum graph.
- graph
QuantumGraph
|ResourcePathExpression
Either the associated quantum graph object or the uri of the location of said quantum graph.
- butler
- Returns:
- report:
QuantumGraphExecutionReport
The
TaskExecutionReport
for each task in the quantum graph.
- report:
- to_summary_dict(butler: Butler, do_store_logs: bool = True, human_readable: bool = False) dict[str, Any] ¶
Summarize the results of the
QuantumGraphExecutionReport
in a dictionary.- Parameters:
- butler
lsst.daf.butler.Butler
The Butler used for this report.
- do_store_logs
bool
Store the logs in the summary dictionary.
- human_readable
bool
Store more human-readable information to be printed out to the command-line.
- butler
- Returns:
- summary_dict
dict
A dictionary containing a summary of a
TaskExecutionReport
for each task in the quantum graph.
- summary_dict
- write_summary_yaml(butler: Butler, filename: str, do_store_logs: bool = True) None ¶
Take the dictionary from
QuantumGraphExecutionReport.to_summary_dict
and store its contents in a yaml file.- Parameters:
- butler
lsst.daf.butler.Butler
The Butler used for this report.
- filename
str
The name to be used for the summary yaml file.
- do_store_logs
bool
Store the logs in the summary dictionary.
- butler