LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
LSSTDataManagementBasePackage
Classes | Functions
lsst.obs.base.ingest Namespace Reference

Classes

class  RawExposureData
 
class  RawFileData
 
class  RawIngestConfig
 
class  RawIngestTask
 

Functions

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

Function Documentation

◆ makeTransferChoiceField()

def lsst.obs.base.ingest.makeTransferChoiceField (   doc = "How to transfer files (None for no transfer).",
  default = None 
) 
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 115 of file ingest.py.

115 def makeTransferChoiceField(doc="How to transfer files (None for no transfer).", default=None):
116  """Create a Config field with options for how to transfer files between
117  data repositories.
118 
119  The allowed options for the field are exactly those supported by
120  `lsst.daf.butler.Datastore.ingest`.
121 
122  Parameters
123  ----------
124  doc : `str`
125  Documentation for the configuration field.
126 
127  Returns
128  -------
129  field : `lsst.pex.config.ChoiceField`
130  Configuration field.
131  """
132  return ChoiceField(
133  doc=doc,
134  dtype=str,
135  allowed={"move": "move",
136  "copy": "copy",
137  "hardlink": "hard link",
138  "symlink": "symbolic (soft) link"},
139  optional=True,
140  default=default
141  )
142 
143 
lsst.obs.base.ingest.makeTransferChoiceField
def makeTransferChoiceField(doc="How to transfer files (None for no transfer).", default=None)
Definition: ingest.py:115
Generated on Sat Nov 16 2019 09:15:47 for LSSTApplications by   doxygen 1.8.13