lsst.obs.base.script.convert Namespace Reference

Functions
def	convert (repo, gen2root, skymap_name, skymap_config, calibs, reruns, config_file, transfer, processes=1)

Function Documentation

convert()

def lsst.obs.base.script.convert.convert	(		repo,
			gen2root,
			skymap_name,
			skymap_config,
			calibs,
			reruns,
			config_file,
			transfer,
			processes = 1
	)

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.
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 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.
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.
processess : `int`
    Number of processes to use for conversion.

Definition at line 35 of file convert.py.

def convert(repo, gen2root, skymap_name, skymap_config, calibs, reruns, config_file, transfer, processes=1):
    """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.
    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 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.
    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.
    processess : `int`
        Number of processes to use for conversion.
    """
    # Allow a gen3 butler to be reused
    try:
        butlerConfig = lsst.daf.butler.Butler.makeRepo(repo)
    except FileExistsError:
        # Use the existing butler configuration
        butlerConfig = repo
 
    butler = lsst.daf.butler.Butler(butlerConfig)
 
    # Derive the gen3 instrument from the gen2root
    # This requires we instantiate a gen2 butler solely to get its mapper
    # Hide all logging -- the later call will show them
    with temporaryLogLevel("", Log.ERROR):
        butler2 = Butler2(gen2root)
        gen2mapperClass = butler2.getMapperClass(gen2root)
        del butler2
 
    instrument = gen2mapperClass.getGen3Instrument()()
 
    convertRepoConfig = ConvertRepoTask.ConfigClass()
    instrument.applyConfigOverrides(ConvertRepoTask._DefaultName, convertRepoConfig)
    convertRepoConfig.raws.transfer = transfer
    if skymap_name is not None:
        convertRepoConfig.skyMaps[skymap_name] = ConvertRepoSkyMapConfig()
        convertRepoConfig.skyMaps[skymap_name].load(skymap_config)
        convertRepoConfig.rootSkyMapName = skymap_name
    if config_file is not None:
        convertRepoConfig.load(config_file)
 
    if reruns is None:
        rerunsArg = []
    else:
        rerunsArg = [Rerun(rerun, runName=None, chainName=None, parents=[]) for rerun in reruns]
 
    # create a new butler instance for running the convert repo task
    butler = lsst.daf.butler.Butler(butlerConfig, run=instrument.makeDefaultRawIngestRunName())
    convertRepoTask = ConvertRepoTask(config=convertRepoConfig, butler3=butler, instrument=instrument)
    convertRepoTask.run(
        root=gen2root,
        reruns=rerunsArg,
        calibs=None if calibs is None else [CalibRepo(path=calibs)],
        processes=processes,
    )