Pipeline

class ionworkspipeline.Pipeline(components, output_file=None)

A pipeline is a sequence of pipeline elements, each of which takes a set of parameters as input and returns a set of parameters as output. The output of one element is the input of the next. The pipeline can be run to generate a set of parameters, and a report can be generated to document the pipeline.

Parameters

componentsdict of {str: _PipelineElement}

A dictionary of pipeline elements. The name is used to identify the element in the report.

output_filestr, optional

The file to save the parameters to. If None, the parameters are not saved.

run()

Run the pipeline to generate a set of parameters.

Returns

parameter_valuesiwp.ParameterValues

The generated parameter values.

Common pipelines

Collections of pre-defined pipelines for common tasks.