Coverage for python/lsst/obs/base/cli/cmd/commands.py : 89%

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 obs_base.
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/>.
22import click
24from lsst.daf.butler.cli.opt import (repo_argument,
25 config_option,
26 config_file_option,
27 locations_argument,
28 options_file_option,
29 processes_option,
30 regex_option,
31 run_option,
32 transfer_option
33 )
34from lsst.daf.butler.cli.utils import (cli_handle_exception, split_commas, typeStrAcceptsMultiple)
35from ..opt import instrument_argument, instrument_option
36from ... import script
39# regular expression that can be used to find supported fits file extensions.
40fits_re = r"\.fit[s]?\b"
43@click.command(short_help="Convert a gen2 repo to gen3.")
44@repo_argument(required=True,
45 help="REPO is the URI or path to the gen3 repository. Will be created if it does not already "
46 "exist")
47@click.option("--gen2root", required=True,
48 help="Root path of the gen 2 repo to be converted.")
49@click.option("--skymap-name",
50 help="Name of the new gen3 skymap (e.g. 'discrete/ci_hsc').")
51@click.option("--skymap-config",
52 help="Path to skymap config file defining the new gen3 skymap.")
53@click.option("--calibs",
54 help="Path to the gen 2 calibration repo. It can be absolute or relative to gen2root.")
55@click.option("--reruns", multiple=True, callback=split_commas, metavar=typeStrAcceptsMultiple,
56 help="List of gen 2 reruns to convert.")
57@transfer_option(help="Mode to use to transfer files into the new repository.")
58@config_file_option(help="Path to a `ConvertRepoConfig` override to be included after the Instrument config "
59 "overrides are applied.")
60@options_file_option()
61def convert(*args, **kwargs):
62 """Convert a Butler gen 2 repository into a gen 3 repository."""
63 cli_handle_exception(script.convert, *args, **kwargs)
66@click.command(short_help="Define visits from exposures.")
67@repo_argument(required=True)
68@config_file_option(help="Path to a pex_config override to be included after the Instrument config overrides "
69 "are applied.")
70@click.option("--collections",
71 help="The collections to be searched (in order) when reading datasets.",
72 multiple=True,
73 callback=split_commas,
74 metavar=typeStrAcceptsMultiple)
75@instrument_option(required=True)
76@options_file_option()
77def define_visits(*args, **kwargs):
78 """Define visits from exposures in the butler registry."""
79 cli_handle_exception(script.defineVisits, *args, **kwargs)
82@click.command(short_help="Ingest raw frames.")
83@repo_argument(required=True)
84@locations_argument(help="LOCATIONS specifies files to ingest and/or locations to search for files.",
85 required=True)
86@regex_option(default=fits_re,
87 help="Regex string used to find files in directories listed in LOCATIONS. "
88 "Searches for fits files by default.")
89@config_option(metavar="TEXT=TEXT", multiple=True)
90@config_file_option(type=click.Path(exists=True, writable=False, file_okay=True, dir_okay=False))
91@run_option(required=False)
92@transfer_option()
93@processes_option()
94@click.option("--ingest-task", default="lsst.obs.base.RawIngestTask", help="The fully qualified class name "
95 "of the ingest task to use.")
96@options_file_option()
97def ingest_raws(*args, **kwargs):
98 """Ingest raw frames into from a directory into the butler registry"""
99 cli_handle_exception(script.ingestRaws, *args, **kwargs)
102@click.command(short_help="Add an instrument to the repository")
103@repo_argument(required=True)
104@instrument_argument(required=True, nargs=-1, help="The fully-qualified name of an Instrument subclass.")
105def register_instrument(*args, **kwargs):
106 """Add an instrument to the data repository.
107 """
108 cli_handle_exception(script.registerInstrument, *args, **kwargs)
111@click.command(short_help="Add an instrument's curated calibrations.")
112@repo_argument(required=True)
113@instrument_option(required=True)
114@click.option("--collection", required=False,
115 help="Name of the calibration collection that associates datasets with validity ranges.")
116@click.option("--suffix", required=False,
117 help=("Name suffix to append (with an automatic delimiter) to all RUN collection names "
118 "as well as the calibration collection name if it is not provided via --collection."))
119@options_file_option()
120def write_curated_calibrations(*args, **kwargs):
121 """Add an instrument's curated calibrations to the data repository.
122 """
123 cli_handle_exception(script.writeCuratedCalibrations, *args, **kwargs)