run_pipeline#

caput.pipeline.runner.run_pipeline(configfile: os.PathLike, profile: bool, profiler: Literal['cprofile', 'pyinstrument'], mpi_abort: bool, psutil: bool) None[source]#

Run a pipeline immediately from the given configfile.

Parameters:
configfileos.PathLike

Path to a pipeline config file.

profilebool

Whether to enable profiling.

profiler{“cprofile”, “pyinstrument”}

Which profiler to use (cprofile or pyinstrument).

mpi_abortbool

Whether to enable MPI-aware exception handling. If True, any uncaught exceptions will cause an MPI_Abort to be called, terminating all processes in the MPI job.

psutilbool

Whether to enable psutil-based memory profiling inside the pipeline manager.