Coverage for python/lsst/ctrl/bps/prepare.py : 20%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
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
26import time
28from lsst.utils import doImport
29from .bps_utils import (save_qg_subgraph, WhenToSaveQuantumGraphs, create_job_quantum_graph_filename,
30 _create_execution_butler)
33_LOG = logging.getLogger(__name__)
36def prepare(config, generic_workflow, out_prefix):
37 """Convert generic workflow to a workflow for a particular WMS.
39 Parameters
40 ----------
41 config : `lsst.ctrl.bps.BpsConfig`
42 Contains configuration for BPS.
43 generic_workflow : `lsst.ctrl.bps.GenericWorkflow`
44 Contains generic workflow.
45 out_prefix : `str`
46 Contains directory to which any WMS-specific files should be written.
48 Returns
49 -------
50 wms_workflow : `lsst.ctrl.bps.BaseWmsWorkflow`
51 WMS-specific workflow.
52 """
53 search_opt = {"searchobj": config["executionButler"]}
54 _, when_create = config.search("whenCreate", opt=search_opt)
55 if when_create.upper() == "PREPARE":
56 _, execution_butler_dir = config.search(".bps_defined.executionButlerDir", opt=search_opt)
57 _LOG.info("Creating execution butler (%s)", execution_butler_dir)
58 stime = time.time()
59 _create_execution_butler(config, config["runQgraphFile"], execution_butler_dir, out_prefix)
60 _LOG.info("Creating execution butler took %.2f seconds", time.time() - stime)
62 found, wms_class = config.search("wmsServiceClass")
63 if not found:
64 raise KeyError("Missing wmsServiceClass in bps config. Aborting.")
66 wms_service_class = doImport(wms_class)
67 wms_service = wms_service_class(config)
68 wms_workflow = wms_service.prepare(config, generic_workflow, out_prefix)
70 # Save QuantumGraphs (putting after call to prepare so don't write a
71 # bunch of files if prepare fails)
72 found, when_save = config.search("whenSaveJobQgraph")
73 if found and WhenToSaveQuantumGraphs[when_save.upper()] == WhenToSaveQuantumGraphs.PREPARE:
74 for job_name in generic_workflow.nodes():
75 job = generic_workflow.get_job(job_name)
76 save_qg_subgraph(job.quantum_graph, create_job_quantum_graph_filename(job, out_prefix))
78 return wms_workflow