PlasmaCalcs.multi_run_analysis.multi_run_tools.canon_runs

PlasmaCalcs.multi_run_analysis.multi_run_tools.canon_runs(dir='.', *, exclude=[], singles=False)

returns dict of “canonical” runs within directory (and subdirectories).

“canonical” if appearing within ‘run’ or ‘runs’ parameter of a _canon.txt file.

keys are abspaths to directories containing the _canon.txt.

values are lists of “canonical” runs within that directory.

run paths within _canon.txt are interpreted from within the _canon.txt’s directory.

dir: str

directory to search in.

exclude: str, or list of strs

exclude any subdirectories whose name equals one of these strings or re.fullmatch one of these strings.

E.g. exclude=’*[.]io’ will exclude all subdirectories whose name ends with ‘.io’;

exclude=’parallel’ will exclude all subdirectories whose name equals ‘parallel’.

singles: bool

if True, assert all run lists in result have length 1,

and replace each runlist with runlist[0].