cached_pout

bigmultipipe.cached_pout(pipe_code, poutname=None, read_pout=False, write_pout=False, create_outdir=False, **kwargs)

Write/read BigMultiPipe.pipeline() metadata output (“pout”) to/from a file using pickle

Parameters

pipe_codefunction

Function that executes bigmultipipe pipeline if read_pout is False or poutname cannot be read. Must return pipeline metadata output (“pout”)

poutnamestr

Filename to be read/written

read_poutbool

If True read pipeline output from poutname Default is False

write_poutbool

If True write pipeline output to poutname Default is False

create_outdirbool, optional

If True, create any needed parent directories into which poutname is to be saved. This parameter is passed along to pipe_code because it need not write the pipeline output files to the same directory as poutname Default is False

**kwargskeyword arguments to pass to pipe_code

Returns

poutdict

Pipeline metadata output