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/>. 

21 

22"""Driver for submitting a prepared WMS-specific workflow 

23""" 

24 

25import getpass 

26import logging 

27import os 

28import pickle 

29import time 

30 

31from lsst.utils import doImport 

32from lsst.obs.base import Instrument 

33 

34from .bps_draw import draw_networkx_dot 

35from .pre_transform import pre_transform, cluster_quanta 

36from .prepare import prepare 

37from .transform import transform 

38 

39 

40# Config section search order 

41BPS_SEARCH_ORDER = ["payload", "pipetask", "site", "bps_defined"] 

42 

43# logging properties 

44_LOG_PROP = """\ 

45log4j.rootLogger=INFO, A1 

46log4j.appender.A1=ConsoleAppender 

47log4j.appender.A1.Target=System.err 

48log4j.appender.A1.layout=PatternLayout 

49log4j.appender.A1.layout.ConversionPattern={} 

50""" 

51 

52_LOG = logging.getLogger() 

53 

54 

55def submit(config, wms_workflow, wms_service=None): 

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

57 

58 Parameters 

59 ---------- 

60 config : `~lsst.ctrl.bps.bps_config.BpsConfig` 

61 Configuration values to be used by submission. 

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

63 The workflow to submit. 

64 wms_service : `~lsst.ctrl.bps.wms_service.BaseWmsService`, optional 

65 The workflow management service to which the workflow should be submitted. 

66 

67 Returns 

68 ------- 

69 wms_workflow : `~lsst.ctrl.bps.wms_workflow.BaseWmsWorkflow` 

70 WMS-specific workflow 

71 """ 

72 if wms_service is None: 

73 wms_service_class = doImport(config["wmsServiceClass"]) 

74 wms_service = wms_service_class(config) 

75 return wms_service.submit(wms_workflow) 

76 

77 

78def create_submission(config): 

79 """Create submission files but don't actually submit. 

80 

81 Parameters 

82 ---------- 

83 config : `~lsst.ctrl.bps.bps_config.BpsConfig` 

84 Batch Processing service configuration. 

85 

86 Returns 

87 ------- 

88 wms_workflow : `~lsst.ctrl.bps.wms_workflow` 

89 WMS-specific workflow. 

90 """ 

91 subtime = time.time() 

92 

93 config[".bps_defined.timestamp"] = Instrument.makeCollectionTimestamp() 

94 if "uniqProcName" not in config: 

95 config[".bps_defined.uniqProcName"] = config["outCollection"].replace("/", "_") 

96 if "operator" not in config: 

97 config[".bps_defined.operator"] = getpass.getuser() 

98 

99 # make submit directory to contain all outputs 

100 submit_path = config["submitPath"] 

101 os.makedirs(submit_path, exist_ok=True) 

102 config[".bps_defined.submit_path"] = submit_path 

103 

104 stime = time.time() 

105 _LOG.info("Pre-transform steps (includes QuantumGraph generation if needed)") 

106 qgraph_file, qgraph = pre_transform(config, out_prefix=submit_path) 

107 _LOG.info("Run QuantumGraph file %s", qgraph_file) 

108 config['.bps_defined.run_qgraph_file'] = qgraph_file 

109 clustered_qgraph = cluster_quanta(config, qgraph, config["uniqProcName"]) 

110 _LOG.info("Pre-transform steps took %.2f seconds", time.time() - stime) 

111 _, save_clustered_qgraph = config.search("saveClusteredQgraph", opt={"default": False}) 

112 if save_clustered_qgraph: 

113 with open(os.path.join(submit_path, "bps_clustered_qgraph.pickle"), 'wb') as outfh: 

114 pickle.dump(clustered_qgraph, outfh) 

115 _, save_dot = config.search("saveDot", opt={"default": False}) 

116 if save_dot: 

117 draw_networkx_dot(clustered_qgraph, os.path.join(submit_path, "bps_clustered_qgraph.dot")) 

118 

119 stime = time.time() 

120 _LOG.info("Creating Generic Workflow") 

121 generic_workflow, generic_workflow_config = transform(config, clustered_qgraph, submit_path) 

122 _LOG.info("Creating Generic Workflow took %.2f seconds", time.time() - stime) 

123 _LOG.info("Generic Workflow name %s", generic_workflow.name) 

124 _, save_workflow = config.search("saveGenericWorkflow", opt={"default": False}) 

125 if save_workflow: 

126 with open(os.path.join(submit_path, "bps_generic_workflow.pickle"), 'wb') as outfh: 

127 generic_workflow.save(outfh, 'pickle') 

128 if save_dot: 

129 with open(os.path.join(submit_path, "bps_generic_workflow.dot"), 'w') as outfh: 

130 generic_workflow.draw(outfh, 'dot') 

131 

132 stime = time.time() 

133 _LOG.info("Creating specific implementation of workflow") 

134 wms_workflow = prepare(generic_workflow_config, generic_workflow, submit_path) 

135 _LOG.info("Creating specific implementation of workflow took %.2f seconds", time.time() - stime) 

136 

137 _LOG.info("Total submission creation time = %.2f", time.time() - subtime) 

138 return wms_workflow