Coverage for python/lsst/ctrl/bps/cli/cmd/commands.py : 84%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
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"""Subcommand definitions.
22"""
23import click
25from lsst.daf.butler.cli.utils import MWCommand
26from lsst.ctrl.bps.drivers import (
27 acquire_qgraph_driver,
28 cluster_qgraph_driver,
29 transform_driver,
30 prepare_driver,
31 submit_driver,
32 report_driver,
33 cancel_driver
34)
35from .. import opt
38class BpsCommand(MWCommand):
39 """Command subclass with bps-command specific overrides."""
41 extra_epilog = "See 'bps --help' for more options."
44@click.command(cls=BpsCommand)
45@opt.config_file_argument(required=True)
46def acquire(*args, **kwargs):
47 """Create a new quantum graph or read existing one from a file.
48 """
49 acquire_qgraph_driver(*args, **kwargs)
52@click.command(cls=BpsCommand)
53@opt.config_file_argument(required=True)
54def cluster(*args, **kwargs):
55 """Create a clustered quantum graph.
56 """
57 cluster_qgraph_driver(*args, **kwargs)
60@click.command(cls=BpsCommand)
61@opt.config_file_argument(required=True)
62def transform(*args, **kwargs):
63 """Transform a quantum graph to a generic workflow.
64 """
65 transform_driver(*args, **kwargs)
68@click.command(cls=BpsCommand)
69@opt.config_file_argument(required=True)
70def prepare(*args, **kwargs):
71 """Prepare a workflow for submission.
72 """
73 prepare_driver(*args, **kwargs)
76@click.command(cls=BpsCommand)
77@opt.config_file_argument(required=True)
78def submit(*args, **kwargs):
79 """Submit a workflow for execution.
80 """
81 submit_driver(*args, **kwargs)
84@click.command(cls=BpsCommand)
85@click.option("--wms", "wms_service",
86 default="lsst.ctrl.bps.wms.htcondor.htcondor_service.HTCondorService",
87 help="Workload Management System service class")
88@click.option("--id", "run_id",
89 help="Restrict report to specific WMS run id.")
90@click.option("--user",
91 help="Restrict report to specific user.")
92@click.option("--hist", "hist_days",
93 default=0.0,
94 help="Search WMS history X days for completed info.")
95@click.option("--pass-thru",
96 help="Pass the given string to the WMS service class")
97def report(*args, **kwargs):
98 """Display execution status for submitted workflows.
99 """
100 report_driver(*args, **kwargs)
103@click.command(cls=BpsCommand)
104@click.option("--wms", "wms_service",
105 default="lsst.ctrl.bps.wms.htcondor.htcondor_service.HTCondorService",
106 help="Workload Management System service class.")
107@click.option("--id", "run_id",
108 help="Run id of workflow to cancel.")
109@click.option("--user",
110 help="User for which to cancel all submitted workflows.")
111@click.option("--require-bps/--skip-require-bps", "require_bps", default=True, show_default=True,
112 help="Only cancel jobs submitted via bps.")
113@click.option("--pass-thru", "pass_thru", default=str(),
114 help="Pass the given string to the WMS service.")
115def cancel(*args, **kwargs):
116 """Cancel submitted workflow(s).
117 """
118 cancel_driver(*args, **kwargs)