thunderboltz.ThunderBoltz.plot_timeseries

ThunderBoltz.plot_timeseries(series=None, save=None, stamp=[], v=0, update=True)[source]

Create a diagnostic plot of ThunderBoltz time series data.

Parameters:
  • series (list[str]) – The y-parameters to plot onto the time series figure.

  • save (str) – Option to save the plot to a file path.

  • stamp (list[str]) – Option to stamp the figure with the value of descriptive parameters, e.g. the field, or initial number of particles. See TBParameters and WrapParameters.

  • v (int) – Verbosity – 0: silent, 1: print file paths before plotting.

  • update (bool) – If set to False, assume required data has already been parsed into ThunderBoltz frames.

Returns:

The timeseries figure object.

Return type:

matplotlib.figure.Figure