Workspace¶
- class lsst.ap.verify.Workspace(location)¶
Bases:
object
A directory used by
ap_verify
to handle data and outputs.Any object of this class represents a working directory containing (possibly empty) subdirectories for various purposes. Subclasses are typically specialized for particular workflows. Keeping such details in separate classes makes it easier to provide guarantees without forcing awkward directory structures on users.
All Workspace classes must guarantee the existence of any subdirectories inside the workspace. Directories corresponding to repositories do not need to be initialized, since creating a valid repository usually requires external information.
- Parameters:
- location
str
The location on disk where the workspace will be set up. Will be created if it does not already exist.
- location
- Raises:
- EnvironmentError
Raised if
location
is not readable or not writeable
Attributes Summary
The absolute location of an output directory for persisted alert packets (
str
, read-only).A Butler that can read pipeline outputs (read-only).
The absolute location of a directory containing custom Task config files for use with the data (
str
, read-only).The default absolute location of the source association database to be created or updated by the pipeline (
str
, read-only).A Butler that can produce pipeline inputs and outputs (read-only).
The absolute location of the workspace as a whole (
str
, read-only).Methods Summary
mkdir
(directory)Create a directory for the workspace.
Attributes Documentation
- alertLocation¶
The absolute location of an output directory for persisted alert packets (
str
, read-only).
- analysisButler¶
A Butler that can read pipeline outputs (read-only). The type is class-dependent.
The Butler should be read-only, if its type supports the restriction.
- configDir¶
The absolute location of a directory containing custom Task config files for use with the data (
str
, read-only).
- dbLocation¶
The default absolute location of the source association database to be created or updated by the pipeline (
str
, read-only).Shall be a pathname to a database suitable for the backend of
Apdb
.
- workButler¶
A Butler that can produce pipeline inputs and outputs (read-only). The type is class-dependent.
Methods Documentation