CmdLineFwk

class lsst.ctrl.mpexec.CmdLineFwk

Bases: object

PipelineTask framework which executes tasks from command line.

In addition to executing tasks this activator provides additional methods for task management like dumping configuration or execution chain.

Attributes Summary

MP_TIMEOUT

Methods Summary

makeGraph(pipeline, args)	Build a graph from command line arguments.
makePipeline(args)	Build a pipeline from command line arguments.
runPipeline(graph, taskFactory, args, …)	Execute complete QuantumGraph.
showInfo(args, pipeline, graph, None] = None)	Display useful info about pipeline and environment.

Attributes Documentation

MP_TIMEOUT = 2592000

Methods Documentation

makeGraph(pipeline: lsst.pipe.base.pipeline.Pipeline, args: types.SimpleNamespace) → Optional[lsst.pipe.base.graph.graph.QuantumGraph, None]

Build a graph from command line arguments.

Parameters:

pipeline : Pipeline

Pipeline, can be empty or None if graph is read from a file.

args : types.SimpleNamespace

Parsed command line

Returns:

graph : QuantumGraph or None

If resulting graph is empty then None is returned.

makePipeline(args: types.SimpleNamespace) → lsst.pipe.base.pipeline.Pipeline

Build a pipeline from command line arguments.

Parameters:

args : types.SimpleNamespace

Parsed command line

Returns:

pipeline : Pipeline

runPipeline(graph: lsst.pipe.base.graph.graph.QuantumGraph, taskFactory: lsst.pipe.base.taskFactory.TaskFactory, args: types.SimpleNamespace, butler: Optional[lsst.daf.butler._butler.Butler, None] = None) → None

Execute complete QuantumGraph.

Parameters:

graph : QuantumGraph

Execution graph.

taskFactory : TaskFactory

Task factory

args : types.SimpleNamespace

Parsed command line

butler : Butler, optional

Data Butler instance, if not defined then new instance is made using command line options.

showInfo(args: types.SimpleNamespace, pipeline: lsst.pipe.base.pipeline.Pipeline, graph: Optional[lsst.pipe.base.graph.graph.QuantumGraph, None] = None) → None

Display useful info about pipeline and environment.

Parameters:

args : types.SimpleNamespace

Parsed command line

pipeline : Pipeline

Pipeline definition

graph : QuantumGraph, optional

Execution graph