stilt.output.Output.folders

Output.folders(variants=None)

Return every settings folder in the output directory, one row each.

A settings folder holds the results of one set of settings, named after the variant that first made them and a short hash of the settings (settings=hrrr-b2399e).

Parameters:

variants (Mapping[str, Variant] | None) – A project’s variants (project.variants), to say which use each folder and how the others differ from them.

Returns:

kind (particles or footprints), folder (the settings= value), name (the variant that made it), and files (the result files it holds, every realization of an ensemble counted). With variants, also variant, the variants that use the folder (empty when none does), and differs, how an unused folder’s settings differ from those of the variant of its name.

Return type:

DataFrame

Examples

>>> project.output.folders(project.variants)