Pipeline

Import in python using from mcutils.pipe import Pipeline

Documentation

class mcutils.pipe.Pipeline(tree: fsl.utils.filetree.filetree.FileTree, all_values, parents=None)[source]

Pipeline function containing one or more scripts

__init__(tree: fsl.utils.filetree.filetree.FileTree, all_values, parents=None)[source]

Creates a new pipeline to generate the files in tree

Parameters
  • tree – Templates for the input/output filenames

  • all_values – All possible values that the variables in the tree templates can take

  • parents – Parent pipeline that might produce some of the dependencies

Methods

add(script)

Adds a script to the pipeline

cli([description])

Runs the pipeline from the command line

get_graph_filenames(filenames)

get_target(filename)

Finds the target describing how filename gets produced

print_missing_runs(filenames, all_short_names)

run([short_name, catch, overwrite, …])

Generates all files matching the short_name and variables

streamlit([title])