dplutils.cli.cli_run

Contents

dplutils.cli.cli_run#

dplutils.cli.cli_run(pipeline: PipelineExecutor, args: Namespace | None = None, **argparse_kwargs)[source]#

Run pipeline from cli args

If args is None, this function runs the pipeline for the standard set of workload-independent arguments (e.g. those that are generic to pipleines in general; see add_generic_args()). If args is supplied, it must be an argparse.Namespace object with command line arguments to be used to configure pipline (see also set_config_grom_args()).

The pipeline is run using the PipelineExecutor.writeto method to the out-dir cli argument.

Parameters:
  • pipeline – The pipeline to configure and run

  • args – None or and argparse.Namespace object of parsed args

  • argparse_kwargs – kwargs to be passed to ArgumentParser on instantiation