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

28 statements  

« prev     ^ index     » next       coverage.py v7.5.1, created at 2024-05-16 03:34 -0700

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 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 <https://www.gnu.org/licenses/>. 

27 

28"""Driver for preparing a WMS-specific workflow. 

29""" 

30 

31import logging 

32 

33from lsst.utils import doImport 

34from lsst.utils.logging import VERBOSE 

35from lsst.utils.timer import time_this, timeMethod 

36 

37from .bps_utils import ( 

38 WhenToSaveQuantumGraphs, 

39 _create_execution_butler, 

40 create_job_quantum_graph_filename, 

41 save_qg_subgraph, 

42) 

43 

44_LOG = logging.getLogger(__name__) 

45 

46 

47@timeMethod(logger=_LOG, logLevel=VERBOSE) 

48def prepare(config, generic_workflow, out_prefix): 

49 """Convert generic workflow to a workflow for a particular WMS. 

50 

51 Parameters 

52 ---------- 

53 config : `lsst.ctrl.bps.BpsConfig` 

54 Contains configuration for BPS. 

55 generic_workflow : `lsst.ctrl.bps.GenericWorkflow` 

56 Contains generic workflow. 

57 out_prefix : `str` 

58 Contains directory to which any WMS-specific files should be written. 

59 

60 Returns 

61 ------- 

62 wms_workflow : `lsst.ctrl.bps.BaseWmsWorkflow` 

63 WMS-specific workflow. 

64 """ 

65 search_opt = {"searchobj": config["executionButler"]} 

66 _, when_create = config.search("whenCreate", opt=search_opt) 

67 if when_create.upper() == "PREPARE": 

68 _, execution_butler_dir = config.search(".bps_defined.executionButlerDir", opt=search_opt) 

69 _LOG.info("Creating execution butler in '%s'", execution_butler_dir) 

70 with time_this(log=_LOG, level=logging.INFO, prefix=None, msg="Creating execution butler completed"): 

71 _create_execution_butler(config, config["runQgraphFile"], execution_butler_dir, out_prefix) 

72 

73 found, wms_class = config.search("wmsServiceClass") 

74 if not found: 

75 raise KeyError("Missing wmsServiceClass in bps config. Aborting.") 

76 

77 wms_service_class = doImport(wms_class) 

78 wms_service = wms_service_class(config) 

79 wms_workflow = wms_service.prepare(config, generic_workflow, out_prefix) 

80 

81 # Save QuantumGraphs (putting after call to prepare so don't write a 

82 # bunch of files if prepare fails) 

83 found, when_save = config.search("whenSaveJobQgraph") 

84 if found and WhenToSaveQuantumGraphs[when_save.upper()] == WhenToSaveQuantumGraphs.PREPARE: 

85 for job_name in generic_workflow.nodes(): 

86 job = generic_workflow.get_job(job_name) 

87 save_qg_subgraph(job.quantum_graph, create_job_quantum_graph_filename(job, out_prefix)) 

88 

89 return wms_workflow