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, run_option
from lsst.daf.butler.cli.utils import cli_handle_exception, split_commas
from ..opt import instrument_option, transfer_option
from ... import script
 
 
@click.command()
@repo_argument(required=True,
               help="REPO is the URI or path to the gen3 repository. Will be created if it does not already "
               "exist")
@instrument_option(required=True,
                   help="The fully-qualified name of the gen3 Instrument subclass for this camera.")
@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,
              help="List of gen 2 reruns to convert.")
@transfer_option(help="Mode to use to transfer files into the new repository.")
@config_file_option(help="Path to a `ConvertRepoConfig` override to be included after the Instrument config "
                    "overrides are applied.")
def convert(*args, **kwargs):
    """Convert a Butler gen 2 repository into a gen 3 repository."""
    cli_handle_exception(script.convert, *args, **kwargs)
 
 
@click.command()
@repo_argument(required=True)
@config_option()
@config_file_option()
@run_option(required=True)
@click.option("-d", "--dir", "directory",
              help="The path to the directory containing the raws to ingest.")
@click.option("-f", "--file", help="The name of a file containing raws to ingest.")
@transfer_option()
@click.option("--ingest-task", default="lsst.obs.base.RawIngestTask", help="The fully qualified class name "
              "of the ingest task to use.")
def ingest_raws(*args, **kwargs):
    cli_handle_exception(script.ingestRaws, *args, **kwargs)
 
 
@click.command()
@repo_argument(required=True)
@instrument_option(required=True, help="The fully-qualified name of an Instrument subclass.")
def register_instrument(*args, **kwargs):
    """Add an instrument to the data repository.
    """
    cli_handle_exception(script.registerInstrument, *args, **kwargs)
 
 
@click.command()
@repo_argument(required=True)
@instrument_option(required=True)
@run_option(required=True)
def write_curated_calibrations(*args, **kwargs):
    """Add an instrument's curated calibrations to the data repository.
    """
    cli_handle_exception(script.writeCuratedCalibrations, *args, **kwargs)