- class pybamm.QuickPlot(solutions, output_variables=None, labels=None, colors=None, linestyles=None, shading='auto', figsize=None, n_rows=None, time_unit=None, spatial_unit='um', variable_limits='fixed')#
Generates a quick plot of a subset of key outputs of the model so that the model outputs can be easily assessed.
shading (str, optional) – The shading to use for 2D plots. Defaults to “auto”.
figsize (tuple of floats, optional) – The size of the figure to make
n_rows (int, optional) – The number of rows to use. If None (default), floor(n // sqrt(n)) is used where n = len(output_variables) so that the plot is as square as possible
time_unit (str, optional) – Format for the time output (“hours”, “minutes”, or “seconds”)
spatial_unit (str, optional) – Format for the spatial axes (“m”, “mm”, or “um”)
How to set the axis limits (for 0D or 1D variables) or colorbar limits (for 2D variables). Options are:
”fixed” (default): keep all axes fixes so that all data is visible
”tight”: make axes tight to plot at each time
dictionary: fine-grain control for each variable, can be either “fixed” or “tight” or a specific tuple (lower, upper).
- create_gif(number_of_images=80, duration=0.1, output_filename='plot.gif')#
Generates x plots over a time span of max_t - min_t and compiles them to create a GIF.
- dynamic_plot(testing=False, step=None)#
Generate a dynamic plot with a slider to control the time.
- get_spatial_var(key, variable, dimension)#
Return the appropriate spatial variable(s)
- plot(t, dynamic=False)#
Produces a quick plot with the internal states at time t.
t (float) – Dimensional time (in ‘time_units’) at which to plot.
Reset the axis limits to the default values. These are calculated to fit around the minimum and maximum values of all the variables in each subplot
Update the plot in self.plot() with values at new time
- pybamm.dynamic_plot(*args, **kwargs)#
pybamm.QuickPlotobject (with arguments ‘args’ and keyword arguments ‘kwargs’) and then calls
pybamm.QuickPlot.dynamic_plot(). The key-word argument ‘testing’ is passed to the ‘dynamic_plot’ method, not the QuickPlot class.
plot – The ‘QuickPlot’ object that was created
- Return type: