Coverage for python/lsst/ctrl/bps/prepare.py: 28%
28 statements
« prev ^ index » next coverage.py v7.3.0, created at 2023-09-02 09:43 +0000
« prev ^ index » next coverage.py v7.3.0, created at 2023-09-02 09:43 +0000
1# This file is part of ctrl_bps.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://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 program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
22"""Driver for preparing a WMS-specific workflow.
23"""
25import logging
27from lsst.utils import doImport
28from lsst.utils.logging import VERBOSE
29from lsst.utils.timer import time_this, timeMethod
31from .bps_utils import (
32 WhenToSaveQuantumGraphs,
33 _create_execution_butler,
34 create_job_quantum_graph_filename,
35 save_qg_subgraph,
36)
38_LOG = logging.getLogger(__name__)
41@timeMethod(logger=_LOG, logLevel=VERBOSE)
42def prepare(config, generic_workflow, out_prefix):
43 """Convert generic workflow to a workflow for a particular WMS.
45 Parameters
46 ----------
47 config : `lsst.ctrl.bps.BpsConfig`
48 Contains configuration for BPS.
49 generic_workflow : `lsst.ctrl.bps.GenericWorkflow`
50 Contains generic workflow.
51 out_prefix : `str`
52 Contains directory to which any WMS-specific files should be written.
54 Returns
55 -------
56 wms_workflow : `lsst.ctrl.bps.BaseWmsWorkflow`
57 WMS-specific workflow.
58 """
59 search_opt = {"searchobj": config["executionButler"]}
60 _, when_create = config.search("whenCreate", opt=search_opt)
61 if when_create.upper() == "PREPARE":
62 _, execution_butler_dir = config.search(".bps_defined.executionButlerDir", opt=search_opt)
63 _LOG.info("Creating execution butler in '%s'", execution_butler_dir)
64 with time_this(log=_LOG, level=logging.INFO, prefix=None, msg="Creating execution butler completed"):
65 _create_execution_butler(config, config["runQgraphFile"], execution_butler_dir, out_prefix)
67 found, wms_class = config.search("wmsServiceClass")
68 if not found:
69 raise KeyError("Missing wmsServiceClass in bps config. Aborting.")
71 wms_service_class = doImport(wms_class)
72 wms_service = wms_service_class(config)
73 wms_workflow = wms_service.prepare(config, generic_workflow, out_prefix)
75 # Save QuantumGraphs (putting after call to prepare so don't write a
76 # bunch of files if prepare fails)
77 found, when_save = config.search("whenSaveJobQgraph")
78 if found and WhenToSaveQuantumGraphs[when_save.upper()] == WhenToSaveQuantumGraphs.PREPARE:
79 for job_name in generic_workflow.nodes():
80 job = generic_workflow.get_job(job_name)
81 save_qg_subgraph(job.quantum_graph, create_job_quantum_graph_filename(job, out_prefix))
83 return wms_workflow