commands.py

Go to the documentation of this file.

# This file is part of obs_base.
#
# Developed for the LSST Data Management System.
# This product includes software developed by the LSST Project
# (http://www.lsst.org).
# See the COPYRIGHT file at the top-level directory of this distribution
# for details of code ownership.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
import click
 
from lsst.daf.butler.cli.opt import (repo_argument,
                                     config_option,
                                     config_file_option,
                                     locations_argument,
                                     options_file_option,
                                     processes_option,
                                     regex_option,
                                     run_option,
                                     transfer_option
                                     )
from lsst.daf.butler.cli.utils import (
    ButlerCommand,
    split_commas,
    typeStrAcceptsMultiple
)
from ..opt import instrument_argument
from ... import script
 
 
# regular expression that can be used to find supported fits file extensions.
fits_re = r"\.fit[s]?\b"
 
 
@click.command(short_help="Convert a gen2 repo to gen3.", cls=ButlerCommand)
@repo_argument(required=True,
               help="REPO is the URI or path to the gen3 repository. Will be created if it does not already "
               "exist")
@click.option("--gen2root", required=True,
              help="Root path of the gen 2 repo to be converted.")
@click.option("--skymap-name",
              help="Name of the new gen3 skymap (e.g. 'discrete/ci_hsc').")
@click.option("--skymap-config",
              help="Path to skymap config file defining the new gen3 skymap.")
@click.option("--calibs",
              help="Path to the gen 2 calibration repo. It can be absolute or relative to gen2root.")
@click.option("--reruns", multiple=True, callback=split_commas, metavar=typeStrAcceptsMultiple,
              help=("List of rerun paths to convert.  Output collection names will be "
                    "guessed, which can fail if the Gen2 repository paths do not follow a "
                    "recognized convention.  In this case, the command-line interface cannot "
                    "be used."))
@transfer_option(help="Mode to use to transfer files into the new repository.")
@processes_option()
@config_file_option(help="Path to a `ConvertRepoConfig` override to be included after the Instrument config "
                    "overrides are applied.")
@options_file_option()
def convert(*args, **kwargs):
    """Convert one or more Butler gen 2 repositories into a gen 3 repository.
 
    This is a highly simplified interface that should only be used to convert
    suites of gen 2 repositories that contain at most one calibration repo and
    has no chained reruns.  Custom scripts that call ConvertRepoTask should be
    used on more complex suites of repositories.
    """
    script.convert(*args, **kwargs)
 
 
@click.command(short_help="Define visits from exposures.", cls=ButlerCommand)
@repo_argument(required=True)
@instrument_argument(required=True)
@config_file_option(help="Path to a pex_config override to be included after the Instrument config overrides "
                         "are applied.")
@click.option("--collections",
              help="The collections to be searched (in order) when reading datasets.",
              multiple=True,
              callback=split_commas,
              metavar=typeStrAcceptsMultiple)
@processes_option()
@options_file_option()
def define_visits(*args, **kwargs):
    """Define visits from exposures in the butler registry."""
    script.defineVisits(*args, **kwargs)
 
 
@click.command(short_help="Ingest raw frames.", cls=ButlerCommand)
@repo_argument(required=True)
@locations_argument(help="LOCATIONS specifies files to ingest and/or locations to search for files.",
                    required=True)
@regex_option(default=fits_re,
              help="Regex string used to find files in directories listed in LOCATIONS. "
                   "Searches for fits files by default.")
@config_option(metavar="TEXT=TEXT", multiple=True)
@config_file_option(type=click.Path(exists=True, writable=False, file_okay=True, dir_okay=False))
@run_option(required=False)
@transfer_option()
@processes_option()
@click.option("--ingest-task", default="lsst.obs.base.RawIngestTask", help="The fully qualified class name "
              "of the ingest task to use.")
@options_file_option()
def ingest_raws(*args, **kwargs):
    """Ingest raw frames into from a directory into the butler registry"""
    script.ingestRaws(*args, **kwargs)
 
 
@click.command(short_help="Add an instrument to the repository", cls=ButlerCommand)
@repo_argument(required=True)
@instrument_argument(required=True, nargs=-1, help="The fully-qualified name of an Instrument subclass.")
def register_instrument(*args, **kwargs):
    """Add an instrument to the data repository.
    """
    script.registerInstrument(*args, **kwargs)
 
 
@click.command(short_help="Add an instrument's curated calibrations.", cls=ButlerCommand)
@repo_argument(required=True)
@instrument_argument(required=True)
@click.option("--collection", required=False,
              help="Name of the calibration collection that associates datasets with validity ranges.")
@click.option("--label", "labels", multiple=True,
              help=("Extra strings to include (with automatic delimiters) in all RUN collection names, "
                    "as well as the calibration collection name if it is not provided via --collection."))
@options_file_option()
def write_curated_calibrations(*args, **kwargs):
    """Add an instrument's curated calibrations to the data repository.
    """
    script.writeCuratedCalibrations(*args, **kwargs)