Coverage for python/lsst/ctrl/mpexec/cli/script/report.py: 50%
8 statements
« prev ^ index » next coverage.py v7.4.3, created at 2024-03-01 12:48 +0000
« prev ^ index » next coverage.py v7.4.3, created at 2024-03-01 12:48 +0000
1# This file is part of ctrl_mpexec.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This software is dual licensed under the GNU General Public License and also
10# under a 3-clause BSD license. Recipients may choose which of these licenses
11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
12# respectively. If you choose the GPL option then the following text applies
13# (but note that there is still no warranty even if you opt for BSD instead):
14#
15# This program is free software: you can redistribute it and/or modify
16# it under the terms of the GNU General Public License as published by
17# the Free Software Foundation, either version 3 of the License, or
18# (at your option) any later version.
19#
20# This program is distributed in the hope that it will be useful,
21# but WITHOUT ANY WARRANTY; without even the implied warranty of
22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23# GNU General Public License for more details.
24#
25# You should have received a copy of the GNU General Public License
26# along with this program. If not, see <http://www.gnu.org/licenses/>.
28from lsst.daf.butler import Butler
29from lsst.pipe.base import QuantumGraph
30from lsst.pipe.base.execution_reports import QuantumGraphExecutionReport
33def report(butler_config: str, qgraph_uri: str, output_yaml: str, logs: bool = True) -> None:
34 """Write a yaml file summarizing the produced and missing expected datasets
35 in a quantum graph.
37 Parameters
38 ----------
39 butler_config : `str`
40 The Butler used for this report. This should match the Butler used
41 for the run associated with the executed quantum graph.
42 qgraph_uri : `str`
43 The uri of the location of said quantum graph.
44 output_yaml : `str`
45 The name to be used for the summary yaml file.
46 logs : `bool`
47 Get butler log datasets for extra information.
49 See Also
50 --------
51 lsst.pipe.base.QuantumGraphExecutionReport.make_reports : Making reports.
52 lsst.pipe.base.QuantumGraphExecutionReport.write_summary_yaml : Summaries.
53 """
54 butler = Butler.from_config(butler_config, writeable=False)
55 qgraph = QuantumGraph.loadUri(qgraph_uri)
56 report = QuantumGraphExecutionReport.make_reports(butler, qgraph)
57 report.write_summary_yaml(butler, output_yaml, do_store_logs=logs)