Coverage for python/lsst/ctrl/mpexec/cli/script/run_qbb.py: 36%
12 statements
« prev ^ index » next coverage.py v7.3.2, created at 2023-11-23 10:58 +0000
« prev ^ index » next coverage.py v7.3.2, created at 2023-11-23 10:58 +0000
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 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 <http://www.gnu.org/licenses/>.
28import logging
29from types import SimpleNamespace
31from ... import CmdLineFwk, TaskFactory
33_log = logging.getLogger(__name__)
36def run_qbb(
37 butler_config: str,
38 qgraph: str,
39 config_search_path: list[str] | None,
40 qgraph_id: str | None,
41 qgraph_node_id: list[int] | None,
42 processes: int,
43 pdb: str | None,
44 profile: str | None,
45 debug: bool,
46 start_method: str | None,
47 timeout: int | None,
48 fail_fast: bool,
49 summary: str | None,
50 enable_implicit_threading: bool,
51 cores_per_quantum: int,
52 memory_per_quantum: str,
53) -> None:
54 """Implement the command line interface ``pipetask run-qbb`` subcommand.
56 Should only be called by command line tools and unit test code that tests
57 this function.
59 Parameters
60 ----------
61 butler_config : `str`
62 The path location of the gen3 butler/registry config file.
63 qgraph : `str`
64 URI location for a serialized quantum graph definition.
65 config_search_path : `list` [`str`]
66 Additional search paths for butler configuration.
67 qgraph_id : `str` or `None`
68 Quantum graph identifier, if specified must match the identifier of the
69 graph loaded from a file. Ignored if graph is not loaded from a file.
70 qgraph_node_id : `iterable` of `int`, or `None`
71 Only load a specified set of nodes if graph is loaded from a file,
72 nodes are identified by integer IDs.
73 processes : `int`
74 The number of processes to use.
75 pdb : `str` or `None`
76 Debugger to launch for exceptions.
77 profile : `str`
78 File name to dump cProfile information to.
79 debug : `bool`
80 If true, enable debugging output using lsstDebug facility (imports
81 debug.py).
82 start_method : `str` or `None`
83 Start method from `multiprocessing` module, `None` selects the best
84 one for current platform.
85 timeout : `int`
86 Timeout for multiprocessing; maximum wall time (sec).
87 fail_fast : `bool`
88 If true then stop processing at first error, otherwise process as many
89 tasks as possible.
90 summary : `str` or `None`
91 File path to store job report in JSON format.
92 enable_implicit_threading : `bool`
93 If `True`, do not disable implicit threading by third-party libraries.
94 Implicit threading is always disabled during actual quantum execution
95 if ``processes > 1``.
96 cores_per_quantum : `int`
97 Number of cores that can be used by each quantum.
98 memory_per_quantum : `str`
99 Amount of memory that each quantum can be allowed to use. Empty string
100 implies no limit. The string can be either a single integer (implying
101 units of MB) or a combination of number and unit.
102 """
103 # Fork option still exists for compatibility but we use spawn instead.
104 if start_method == "fork":
105 start_method = "spawn"
106 _log.warning("Option --start-method=fork is unsafe and no longer supported, will use spawn instead.")
108 args = SimpleNamespace(
109 butler_config=butler_config,
110 qgraph=qgraph,
111 config_search_path=config_search_path,
112 qgraph_id=qgraph_id,
113 qgraph_node_id=qgraph_node_id,
114 processes=processes,
115 pdb=pdb,
116 profile=profile,
117 enableLsstDebug=debug,
118 start_method=start_method,
119 timeout=timeout,
120 fail_fast=fail_fast,
121 summary=summary,
122 enable_implicit_threading=enable_implicit_threading,
123 cores_per_quantum=cores_per_quantum,
124 memory_per_quantum=memory_per_quantum,
125 )
127 f = CmdLineFwk()
128 task_factory = TaskFactory()
129 f.runGraphQBB(task_factory, args)