BaseWmsService

class lsst.ctrl.bps.BaseWmsService(config)

Bases: object

Interface for interactions with a specific WMS.

Parameters:

config : BpsConfig

Configuration needed by the WMS service.

Methods Summary

prepare(config, generic_workflow[, out_prefix])	Create submission for a generic workflow for a specific WMS.
report([wms_workflow_id, user, hist, pass_thru])	Query WMS for status of submitted WMS workflows.
submit(workflow)	Submit a single WMS workflow

Methods Documentation

prepare(config, generic_workflow, out_prefix=None)

Create submission for a generic workflow for a specific WMS.

Parameters:

config : BpsConfig

BPS configuration.

generic_workflow : GenericWorkflow

Generic representation of a single workflow

out_prefix : str

Prefix for all WMS output files

Returns:

wms_workflow : BaseWmsWorkflow

Prepared WMS Workflow to submit for execution

report(wms_workflow_id=None, user=None, hist=0, pass_thru=None)

Query WMS for status of submitted WMS workflows.

Parameters:

wms_workflow_id : int or str, optional

Id that can be used by WMS service to look up status.

user : str, optional

Limit report to submissions by this particular user.

hist : int, optional

Number of days to expand report to include finished WMS workflows.

pass_thru : str, optional

Additional arguments to pass through to the specific WMS service.

Returns:

run_reports : dict of BaseWmsReport

Status information for submitted WMS workflows.

message : str

Message to user on how to find more status information specific to this particular WMS.

submit(workflow)

Submit a single WMS workflow

Parameters:

workflow : BaseWmsWorkflow

Prepared WMS Workflow to submit for execution