lsst.ap.verify

The lsst.ap.verify package provides an executable python program for pipeline verification. It runs the alert production pipeline (encapsulated in the lsst.ap.pipe package) and computes lsst.verify metrics on both the pipeline’s state and its output.

ap_verify is designed to work with small, standardized datasets that can be interchanged to test the Stack’s performance under different conditions. To ensure consistent results, it runs the entire AP pipeline as a single unit, from data ingestion to source association. It produces metric values, using the lsst.verify framework, that can be used for both monitoring stack development and debugging failure cases.

Using lsst.ap.verify

• Running ap_verify from the command line
• The dataset framework
• Error-handling in ap_verify and failed runs
• Configuring metrics for ap_verify
• ap_verify command-line reference

Contributing

lsst.ap.verify is developed at https://github.com/lsst/ap_verify. You can find Jira issues for this module under the ap_verify component.

Python API reference

lsst.ap.verify Package

Functions

computeMetrics(workspace, dataIds, args)	Measure any metrics that apply to the final result of the AP pipeline, rather than to a particular processing stage.
ingestDataset(dataset, workspace)	Ingest the contents of an ap_veify dataset into a Butler repository.
ingestDatasetGen3(dataset, workspace[, …])	Ingest the contents of an ap_verify dataset into a Gen 3 Butler repository.
runApPipeGen2(workspace, parsedCmdLine[, …])	Run ap_pipe on this object’s dataset.
runApPipeGen3(workspace, parsedCmdLine[, …])	Run ap_pipe on this object’s dataset.
runApVerify([cmdLine])	Execute the AP pipeline while handling metrics.
runIngestion([cmdLine])	Ingest a dataset, but do not process it.

Classes

ApPipeParser()	An argument parser for data needed by ap_pipe activities.
Dataset(datasetId)	A dataset supported by ap_verify.
DatasetIngestConfig	Settings and defaults for DatasetIngestTask.
Gen3DatasetIngestConfig	Settings and defaults for Gen3DatasetIngestTask.
MetricsParser()	An argument parser for data needed by metrics activities.
Workspace(location)	A directory used by ap_verify to handle data and outputs.
WorkspaceGen2(location)	A directory used by ap_verify to handle data.
WorkspaceGen3(location)	A directory used by ap_verify to handle data.