DiFfRG.phasediagram#

Functions#

get_all_sims(→ list)

Reads every simulation in a folder.

sim_exists(→ bool)

get_command(→ str)

run_point([suppress])

get_name(→ str)

Module Contents#

DiFfRG.phasediagram.get_all_sims(folder, pool_size=None, cache=True) → list#

Reads every simulation in a folder.

Only the config and the scalars are read here, in parallel; the fem frames of a run stay on disk until they are indexed (see DiFfRG.file_io.hdf5). A scan of long runs is mostly fem frames, and an analysis of it usually looks at the last frame of each or at none at all, so reading them all up front costs orders of magnitude more time and memory than the answer needs.

Parameters:

  • folder (str) – The folder to read, with a trailing separator.

  • pool_size (int, optional) – The number of worker processes. Defaults to the number of cores this process may run on.

  • cache (bool, optional) – Whether to reuse what previous calls read of files that have not changed since. Defaults to True.

Returns:

One SimulationData per readable file. A file that cannot be read – a run writing its output at this very moment, most likely – is skipped and reported.

Return type:

list

DiFfRG.phasediagram.sim_exists(sim_set, param_list) → bool#
DiFfRG.phasediagram.get_command(exe, param_list, folder='', add_params='') → str#
DiFfRG.phasediagram.run_point(exe, param_list, add_params='', folder='', cwdir=os.getcwd(), suppress=True) → str#
DiFfRG.phasediagram.get_name(param_list) → str#