thunderboltz.ThunderBoltz.describe_dist

ThunderBoltz.describe_dist(steps='last', sample_cap=500000)[source]

Generate percentile and count statistics of the electron velocity / energy distribution for various time steps.

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.

Returns:

A table with statistical descriptions of the velocity and energy distributions.

Return type:

pandas.DataFrame