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

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 

30import logging 

31 

32from lsst.ctrl.bps import BaseWmsWorkflow, BpsConfig, GenericWorkflow 

33from lsst.utils import doImport 

34from lsst.utils.logging import VERBOSE 

35from lsst.utils.timer import timeMethod 

36 

37from .bps_utils import WhenToSaveQuantumGraphs, create_job_quantum_graph_filename, save_qg_subgraph 

38 

39_LOG = logging.getLogger(__name__) 

40 

41 

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

43def prepare(config: BpsConfig, generic_workflow: GenericWorkflow, out_prefix: str) -> BaseWmsWorkflow: 

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

45 

46 Parameters 

47 ---------- 

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

49 Contains configuration for BPS. 

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

51 Contains generic workflow. 

52 out_prefix : `str` 

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

54 

55 Returns 

56 ------- 

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

58 WMS-specific workflow. 

59 """ 

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

61 if not found: 

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

63 

64 wms_service_class = doImport(wms_class) 

65 wms_service = wms_service_class(config) 

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

67 

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

69 # bunch of files if prepare fails) 

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

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

72 for job_name in generic_workflow.nodes(): 

73 job = generic_workflow.get_job(job_name) 

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

75 

76 return wms_workflow