cmd.commands Namespace Reference

Functions
def	convert (*args, **kwargs)
def	define_visits (*args, **kwargs)
def	ingest_raws (*args, **kwargs)
def	register_instrument (*args, **kwargs)
def	write_curated_calibrations (*args, **kwargs)
def	make_discrete_skymap (*args, **kwargs)

Variables
string	fits_re = r"\.fit[s]?\b"
	short_help
	required
	help
	multiple
	True
	callback
	split_commas
	metavar

Function Documentation

convert()

def cmd.commands.convert	(	*	args,
		**	kwargs
	)

Convert a Butler gen 2 repository into a gen 3 repository.

Definition at line 62 of file commands.py.

def convert(*args, **kwargs):
    """Convert a Butler gen 2 repository into a gen 3 repository."""
    cli_handle_exception(script.convert, *args, **kwargs)
 
 
@click.command(short_help="Define visits from exposures.")
@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()

define_visits()

def cmd.commands.define_visits	(	*	args,
		**	kwargs
	)

Define visits from exposures in the butler registry.

Definition at line 79 of file commands.py.

def define_visits(*args, **kwargs):
    """Define visits from exposures in the butler registry."""
    cli_handle_exception(script.defineVisits, *args, **kwargs)
 
 
@click.command(short_help="Ingest raw frames.")
@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()

ingest_raws()

def cmd.commands.ingest_raws	(	*	args,
		**	kwargs
	)

Ingest raw frames into from a directory into the butler registry

Definition at line 99 of file commands.py.

def ingest_raws(*args, **kwargs):
    """Ingest raw frames into from a directory into the butler registry"""
    cli_handle_exception(script.ingestRaws, *args, **kwargs)
 
 
@click.command(short_help="Add an instrument to the repository")
@repo_argument(required=True)
@instrument_argument(required=True, nargs=-1, help="The fully-qualified name of an Instrument subclass.")

make_discrete_skymap()

def cmd.commands.make_discrete_skymap	(	*	args,
		**	kwargs
	)

Define a discrete skymap from calibrated exposures in the butler registry.

Definition at line 49 of file commands.py.

def make_discrete_skymap(*args, **kwargs):
    """Define a discrete skymap from calibrated exposures in the butler registry."""
    cli_handle_exception(script.makeDiscreteSkyMap, *args, **kwargs)

register_instrument()

def cmd.commands.register_instrument	(	*	args,
		**	kwargs
	)

Add an instrument to the data repository.

Definition at line 107 of file commands.py.

def register_instrument(*args, **kwargs):
    """Add an instrument to the data repository.
    """
    cli_handle_exception(script.registerInstrument, *args, **kwargs)
 
 
@click.command(short_help="Add an instrument's curated calibrations.")
@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("--suffix", required=False,
              help=("Name suffix to append (with an automatic delimiter) to all RUN collection names "
                    "as well as the calibration collection name if it is not provided via --collection."))
@options_file_option()

write_curated_calibrations()

def cmd.commands.write_curated_calibrations	(	*	args,
		**	kwargs
	)

Add an instrument's curated calibrations to the data repository.

Definition at line 122 of file commands.py.

def write_curated_calibrations(*args, **kwargs):
    """Add an instrument's curated calibrations to the data repository.
    """
    cli_handle_exception(script.writeCuratedCalibrations, *args, **kwargs)

Variable Documentation

callback

cmd.commands.callback

Definition at line 55 of file commands.py.

fits_re

string cmd.commands.fits_re = r"\.fit[s]?\b"

Definition at line 40 of file commands.py.

help

cmd.commands.help

Definition at line 45 of file commands.py.

metavar

cmd.commands.metavar

Definition at line 55 of file commands.py.

multiple

cmd.commands.multiple

Definition at line 55 of file commands.py.

required

cmd.commands.required

Definition at line 44 of file commands.py.

short_help

cmd.commands.short_help

Definition at line 43 of file commands.py.

split_commas

cmd.commands.split_commas

Definition at line 55 of file commands.py.

True

cmd.commands.True

Definition at line 55 of file commands.py.