thunderboltz.ThunderBoltz.plot_vdfs

ThunderBoltz.plot_vdfs(steps='last', save=None, bins=100, sample_cap=500000)[source]

Plot the joint distribution heat map between the x-y and x-z velocities.

Parameters:

  • steps (str, list[int], or int) –

    Options for which time steps to read:

    • "last": Only read the VDF of the last time step

    • "first": Only read the VDF of the first time step

    • "all": Read a separate VDF for each time step.

    • list[int]: Read VDF for each time step included in list.

    • int: read VDF at one specific time step.

  • sample_cap (int) – Limit the number of samples read from the dump file for very large files. Default is 500000. If bool(sample_cap) evaluates to False, then no cap will be imposed.

  • bins (int) – Total number of bins to divide the energy space into.

  • save (str) – Optional location of directory to save the figure in.

Returns:

The list of figures and a list of their corresponding step indices.

Return type:

(Tuple[list[matplotlib.figure.Figure], list[int])