sme_contrib.plot.concentration_heatmap_animation

sme_contrib.plot.concentration_heatmap_animation(simulation_results, species, z_slice: int = 0, title=None, figsize=None, interval=200)

Plot 2d animated heatmap of species concentration

Plots the concentration of species in the list species from the supplied list simulation_results as an animated 2d heatmap.

Parameters:

  • simulation_results (List of sme.SimulationResult) – A simulation result to plot

  • species (List of str) – The species to plot

  • z_slice (int) – The z-slice to plot

  • title (str) – Optionally specify the title

  • figsize ((float, float)) – Optionally specify the figure size

  • interval – Optionally specify the interval in ms between images

Returns:

the matplotlib animation

Return type:

matplotlib.animation.ArtistAnimation