Public Member Functions
None	guessCollectionNames (self, Instrument instrument, str root)

Public Attributes
	chainName

	runName

Detailed Description

Specification for a Gen2 processing-output repository to convert.

Definition at line 84 of file convertRepo.py.

Member Function Documentation

◆ guessCollectionNames()

None lsst.obs.base.gen2to3.convertRepo.Rerun.guessCollectionNames	(		self,
		Instrument	instrument,
		str	root
	)

Update `runName` and `chainName` with guesses that match Gen3 naming
conventions.

If `chainName` is not `None`, and `runName` is, `runName` will be set
from it.  If `runName` is already set, nothing will be changed, and
if `chainName` is `None`, no chained collection will be created.

Parameters
----------
instrument : `Instrument`
    Instrument object for the repository being converted.
root : `str`
    Path to the root repository.  If this is present at the start of
    ``self.path``, it will be stripped as part of generating the run
    name.

Raises
------
ValueError
    Raised if the appropriate collection names cannot be inferred.

Definition at line 116 of file convertRepo.py.

     def guessCollectionNames(self, instrument: Instrument, root: str) -> None:
         """Update `runName` and `chainName` with guesses that match Gen3 naming
         conventions.
  
         If `chainName` is not `None`, and `runName` is, `runName` will be set
         from it.  If `runName` is already set, nothing will be changed, and
         if `chainName` is `None`, no chained collection will be created.
  
         Parameters
         ----------
         instrument : `Instrument`
             Instrument object for the repository being converted.
         root : `str`
             Path to the root repository.  If this is present at the start of
             ``self.path``, it will be stripped as part of generating the run
             name.
  
         Raises
         ------
         ValueError
             Raised if the appropriate collection names cannot be inferred.
         """
         if self.runName is not None:
             return
         if self.chainName is None:
             if os.path.isabs(self.path):
                 rerunURI = ButlerURI(self.path)
                 rootURI = ButlerURI(root)
                 chainName = rerunURI.relative_to(rootURI)
                 if chainName is None:
                     raise ValueError(
                         f"Cannot guess run name collection for rerun at '{self.path}': "
                         f"no clear relationship to root '{root}'."
                     )
             else:
                 chainName = self.path
             chainName, _ = _dropPrefix(chainName, "rerun/")
             chainName, isPersonal = _dropPrefix(chainName, "private/")
             if isPersonal:
                 chainName = f"u/{chainName}"
             else:
                 chainName, _ = _dropPrefix(chainName, "shared/")
                 chainName = instrument.makeCollectionName("runs", chainName)
             self.chainName = chainName
         self.runName = f"{self.chainName}/direct"
  
  
 @dataclass

Member Data Documentation

◆ chainName

lsst.obs.base.gen2to3.convertRepo.Rerun.chainName

Definition at line 159 of file convertRepo.py.

◆ runName

lsst.obs.base.gen2to3.convertRepo.Rerun.runName

Definition at line 160 of file convertRepo.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/0.2.1/Linux64/obs_base/21.0.0-27-gbbd0d29+ae871e0f33/python/lsst/obs/base/gen2to3/convertRepo.py