lsst.obs.base.ingest Namespace Reference

Classes
class	RawExposureData
class	RawFileData
class	RawFileDatasetInfo
class	RawIngestConfig
class	RawIngestTask

Functions
def	makeTransferChoiceField (doc="How to transfer files (None for no transfer).", default="auto")

Function Documentation

makeTransferChoiceField()

def lsst.obs.base.ingest.makeTransferChoiceField	(		doc = "How to transfer files (None for no transfer).",
			default = "auto"
	)

Create a Config field with options for how to transfer files between
data repositories.

The allowed options for the field are exactly those supported by
`lsst.daf.butler.Datastore.ingest`.

Parameters
----------
doc : `str`
    Documentation for the configuration field.

Returns
-------
field : `lsst.pex.config.ChoiceField`
    Configuration field.

Definition at line 123 of file ingest.py.

def makeTransferChoiceField(doc="How to transfer files (None for no transfer).", default="auto"):
    """Create a Config field with options for how to transfer files between
    data repositories.
 
    The allowed options for the field are exactly those supported by
    `lsst.daf.butler.Datastore.ingest`.
 
    Parameters
    ----------
    doc : `str`
        Documentation for the configuration field.
 
    Returns
    -------
    field : `lsst.pex.config.ChoiceField`
        Configuration field.
    """
    return ChoiceField(
        doc=doc,
        dtype=str,
        allowed={"move": "move",
                 "copy": "copy",
                 "auto": "choice will depend on datastore",
                 "link": "hard link falling back to symbolic link",
                 "hardlink": "hard link",
                 "symlink": "symbolic (soft) link",
                 "relsymlink": "relative symbolic link",
                 },
        optional=True,
        default=default
    )