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