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, **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 graph. 

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

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

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

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

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

69 input : `str` 

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

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

72 search in that collection. 

73 output : `str` 

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

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

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

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

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

79 datasets (see `output_run`). 

80 output_run : `str` 

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

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

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

84 already exists then `extend_run` must be passed. 

85 extend_run : `bool` 

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

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

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

89 replace_run : `bool` 

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

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

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

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

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

95 and `extend_run` must be `None`. 

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

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

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

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

100 data_query : `str` 

101 User query selection expression. 

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

103 Descriptions of what to dump to stdout. 

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

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

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

107 which ingore these unused kwargs. 

108 

109 Returns 

110 ------- 

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

112 The qgraph object that was created. 

113 """ 

114 args = SimpleNamespace(qgraph=qgraph, 

115 qgraph_id=qgraph_id, 

116 qgraph_node_id=qgraph_node_id, 

117 save_qgraph=save_qgraph, 

118 save_single_quanta=save_single_quanta, 

119 qgraph_dot=qgraph_dot, 

120 butler_config=butler_config, 

121 input=input, 

122 output=output, 

123 output_run=output_run, 

124 extend_run=extend_run, 

125 replace_run=replace_run, 

126 prune_replaced=prune_replaced, 

127 data_query=data_query, 

128 show=show, 

129 skip_existing=skip_existing) 

130 

131 f = CmdLineFwk() 

132 qgraph = f.makeGraph(pipelineObj, args) 

133 

134 if qgraph is None: 

135 raise RuntimeError("QuantumGraph is empty.") 

136 

137 # optionally dump some info. 

138 if show: 

139 f.showInfo(args, pipelineObj, qgraph) 

140 

141 return qgraph