lsst.obs.base  20.0.0-16-gd6747cf
Functions
lsst.obs.base.script.convert Namespace Reference

Functions

def convert (repo, gen2root, instrument, skymap_name, skymap_config, calibs, reruns, config_file, transfer)
 

Function Documentation

◆ convert()

def lsst.obs.base.script.convert.convert (   repo,
  gen2root,
  instrument,
  skymap_name,
  skymap_config,
  calibs,
  reruns,
  config_file,
  transfer 
)
Implements the command line interface `butler convert` subcommand,
should only be called by command line tools and unit test code that tests
this function.

Convert the gen 2 Butler repo at `gen2root` into a gen 3 repo
living at `repo`.

Parameters
----------
repo : `str`
    URI to the gen 3 repository.
gen2root : `str`
    URI to the gen 2 repository.
instrument : `str`
    The fully-qualified name of the Instrument subclass being converted.
skymap_name : `str` or None
    Name of the skymap to be converted in the repo.
skymap_config : `str` or None
    Path to the `lsst.skymap.BaseSkyMapConfig` of the gen2 skymap to be
    converted.
calibs : `str` or None
    Path to the gen2 calibration repository to be converted.
    If a relative path, it is assumed to be relative to `gen2root`.
reruns : `list` [`str`] or None
    List of reruns to convert. They will be placed in the
    ``shared/INSTRUMENT/RERUN`` collection.
config_file : `str` or None
    Path to `lsst.obs.base.ConvertRepoConfig` configuration to load
    after all default/instrument configurations.
transfer : `str` or None
    Mode to use when transferring data into the gen3 repository.

Definition at line 34 of file convert.py.