lsst.ctrl.bps

Changes

• lsst-ctrl-bps v28.0.0 (2024-11-21)
• lsst-ctrl-bps 27.0.0 (2024-05-29)
• lsst-ctrl-bps v26.0.0 (2023-09-25)
• lsst-ctrl-bps v25.0.0 (2023-03-01)
• lsst-ctrl-bps v24.0.0 (2022-08-29)
• ctrl_bps v23.0.1 (2022-02-02)
• ctrl_bps v23.0.0 (2021-12-10)

Using lsst.ctrl.bps

• Overview
• Workflow Management System (WMS) Plugins
• Checking status of WMS services
• Specifying the Compute site
• Defining a submission
• Submitting a run
• Submitting a custom script
• Checking status
• Canceling submitted jobs
• Restarting a failed run
• BPS precedence order
• BPS configuration file
• Managing job memory requirements
• QuantumGraph Files
• Quantum-backed Butler
• Clustering
• WMS-id softlink
• Troubleshooting
• Appendix A

Contributing

lsst.ctrl.bps is developed at https://github.com/lsst/ctrl_bps. You can find Jira issues for this module under the ctrl_bps component.

Python API reference

lsst.ctrl.bps Package

Functions

compile_job_summary(report)

Add a job summary to the run report if necessary.

Classes

BaseRunReport(fields)	The base class representing a run report.
BaseWmsService(config)	Interface for interactions with a specific WMS.
BaseWmsWorkflow(name, config)	Interface for single workflow specific to a WMS.
BpsConfig(other[, search_order, defaults, ...])	Contains the configuration for a BPS submission.
BpsFormatter()	String formatter class that allows BPS config search options.
ClusteredQuantumGraph(name, qgraph[, ...])	Graph where the data for a node is a subgraph of the full QuantumGraph represented by a list of node ids.
DetailedRunReport(fields)	A detailed run report.
ExitCodesReport(fields)	An extension of run report to give information about error handling from the wms service.
GenericWorkflow(name[, incoming_graph_data])	A generic representation of a workflow used to submit to specific workflow management systems.
GenericWorkflowExec(name[, src_uri, ...])	Information about an executable that may be needed by various workflow management services.
GenericWorkflowFile(name[, src_uri, ...])	Information about a file that may be needed by various workflow management services.
GenericWorkflowJob(name, label, ...)	Information about a job that may be needed by various workflow management services.
QuantaCluster(name, label[, tags])	Information about the cluster and Quanta belonging to it.
SummaryRunReport(fields)	A summary run report.
WmsJobReport(wms_id, name, label, state)	WMS job information to be included in detailed report output.
WmsRunReport([wms_id, global_wms_id, path, ...])	WMS run information to be included in detailed report output.
WmsSpecificInfo()	Class representing WMS specific information.
WmsStates(value[, names, module, qualname, ...])	Run and job states.