1# This file is part of ctrl_mpexec. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://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 <http://www.gnu.org/licenses/>. 

21 

22import logging 

23from types import SimpleNamespace 

24 

25from ... import CmdLineFwk 

26 

27_log = logging.getLogger(__name__.partition(".")[2]) 

28 

29 

30def qgraph(pipelineObj, qgraph, qgraph_id, qgraph_node_id, skip_existing, save_qgraph, save_single_quanta, 

31 qgraph_dot, butler_config, input, output, output_run, extend_run, replace_run, prune_replaced, 

32 data_query, show, save_execution_butler, clobber_execution_butler, clobber_outputs, **kwargs): 

33 """Implements the command line interface `pipetask qgraph` subcommand, 

34 should only be called by command line tools and unit test code that test 

35 this function. 

36 

37 Parameters 

38 ---------- 

39 pipelineObj : `pipe.base.Pipeline` or None. 

40 The pipeline object used to generate a qgraph. If this is not `None` 

41 then `qgraph` should be `None`. 

42 qgraph : `str` or `None` 

43 URI location for a serialized quantum graph definition as a pickle 

44 file. If this option is not None then `pipeline` should be `None`. 

45 qgraph_id : `str` or `None` 

46 Quantum graph identifier, if specified must match the identifier of the 

47 graph loaded from a file. Ignored if graph is not loaded from a file. 

48 qgraph_node_id : `list` of `int`, optional 

49 Only load a specified set of nodes if graph is loaded from a file, 

50 nodes are identified by integer IDs. 

51 skip_existing : `bool` 

52 If all Quantum outputs already exist in the output RUN collection then 

53 that Quantum will be excluded from the QuantumGraph. Will only be used 

54 if `extend_run` flag is set. 

55 save_qgraph : `str` or `None` 

56 URI location for storing a serialized quantum graph definition as a 

57 pickle file. 

58 save_single_quanta : `str` or `None` 

59 Format string of URI locations for storing individual quantum graph 

60 definition (pickle files). The curly brace {} in the input string will 

61 be replaced by a quantum number. 

62 qgraph_dot : `str` or `None` 

63 Path location for storing GraphViz DOT representation of a quantum 

64 graph. 

65 butler_config : `str`, `dict`, or `lsst.daf.butler.Config` 

66 If `str`, `butler_config` is the path location of the gen3 

67 butler/registry config file. If `dict`, `butler_config` is key value 

68 pairs used to init or update the `lsst.daf.butler.Config` instance. If 

69 `Config`, it is the object used to configure a Butler. 

70 input : `str` 

71 Comma-separated names of the input collection(s). Entries may include a 

72 colon (:), the first string is a dataset type name that restricts the 

73 search in that collection. 

74 output : `str` 

75 Name of the output CHAINED collection. This may either be an existing 

76 CHAINED collection to use as both input and output (if `input` is 

77 `None`), or a new CHAINED collection created to include all inputs 

78 (if `input` is not `None`). In both cases, the collection's children 

79 will start with an output RUN collection that directly holds all new 

80 datasets (see `output_run`). 

81 output_run : `str` 

82 Name of the new output RUN collection. If not provided then `output` 

83 must be provided and a new RUN collection will be created by appending 

84 a timestamp to the value passed with `output`. If this collection 

85 already exists then `extend_run` must be passed. 

86 extend_run : `bool` 

87 Instead of creating a new RUN collection, insert datasets into either 

88 the one given by `output_run` (if provided) or the first child 

89 collection of `output` (which must be of type RUN). 

90 replace_run : `bool` 

91 Before creating a new RUN collection in an existing CHAINED collection, 

92 remove the first child collection (which must be of type RUN). This can 

93 be used to repeatedly write to the same (parent) collection during 

94 development, but it does not delete the datasets associated with the 

95 replaced run unless `prune-replaced` is also True. Requires `output`, 

96 and `extend_run` must be `None`. 

97 prune_replaced : "unstore", "purge", or `None`. 

98 If not `None`, delete the datasets in the collection replaced by 

99 `replace_run`, either just from the datastore ("unstore") or by 

100 removing them and the RUN completely ("purge"). Requires `replace_run`. 

101 data_query : `str` 

102 User query selection expression. 

103 show : `list` [`str`] or `None` 

104 Descriptions of what to dump to stdout. 

105 save_execution_butler : `str` or `None` 

106 URI location for storing an execution Butler build from the 

107 QuantumGraph. 

108 clobber_execution_butler : `bool` 

109 It True overwrite existing execution butler files if present. 

110 clobber_outputs : `bool` 

111 Remove outputs from previous execution of the same quantum before new 

112 execution. If ``skip_existing`` is also passed, then only failed 

113 quanta will be clobbered. 

114 kwargs : `dict` [`str`, `str`] 

115 Ignored; click commands may accept options for more than one script 

116 function and pass all the option kwargs to each of the script functions 

117 which ingore these unused kwargs. 

118 

119 Returns 

120 ------- 

121 qgraph : `lsst.pipe.base.QuantumGraph` 

122 The qgraph object that was created. 

123 """ 

124 args = SimpleNamespace(qgraph=qgraph, 

125 qgraph_id=qgraph_id, 

126 qgraph_node_id=qgraph_node_id, 

127 save_qgraph=save_qgraph, 

128 save_single_quanta=save_single_quanta, 

129 qgraph_dot=qgraph_dot, 

130 butler_config=butler_config, 

131 input=input, 

132 output=output, 

133 output_run=output_run, 

134 extend_run=extend_run, 

135 replace_run=replace_run, 

136 prune_replaced=prune_replaced, 

137 data_query=data_query, 

138 show=show, 

139 skip_existing=skip_existing, 

140 execution_butler_location=save_execution_butler, 

141 clobber_execution_butler=clobber_execution_butler, 

142 clobber_outputs=clobber_outputs, 

143 ) 

144 

145 f = CmdLineFwk() 

146 qgraph = f.makeGraph(pipelineObj, args) 

147 

148 if qgraph is None: 

149 raise RuntimeError("QuantumGraph is empty.") 

150 

151 # optionally dump some info. 

152 if show: 

153 f.showInfo(args, pipelineObj, qgraph) 

154 

155 return qgraph