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[, butler])

Execute complete QuantumGraph.

showInfo(args, pipeline[, graph])

Display useful info about pipeline and environment.

Attributes Documentation

MP_TIMEOUT = 2592000

Methods Documentation

makeGraph(pipeline: Pipeline, args: SimpleNamespace) QuantumGraph | None

Build a graph from command line arguments.

Parameters:
pipelinePipeline

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

argstypes.SimpleNamespace

Parsed command line

Returns:
graphQuantumGraph or None

If resulting graph is empty then None is returned.

makePipeline(args: SimpleNamespace) Pipeline

Build a pipeline from command line arguments.

Parameters:
argstypes.SimpleNamespace

Parsed command line

Returns:
pipelinePipeline
runPipeline(graph: QuantumGraph, taskFactory: TaskFactory, args: SimpleNamespace, butler: Butler | None = None) None

Execute complete QuantumGraph.

Parameters:
graphQuantumGraph

Execution graph.

taskFactoryTaskFactory

Task factory

argstypes.SimpleNamespace

Parsed command line

butlerButler, optional

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

showInfo(args: SimpleNamespace, pipeline: Pipeline, graph: QuantumGraph | None = None) None

Display useful info about pipeline and environment.

Parameters:
argstypes.SimpleNamespace

Parsed command line

pipelinePipeline

Pipeline definition

graphQuantumGraph, optional

Execution graph