field module

This module contains a field visualization function

src.visualization.field.save_field_animation(field: ndarray, output_path: str | Path, bound_mult_factor: float = 0.2, interval: float = 400)

Shows and saves to file an animation of the provided field over time.

Parameters:

fieldnp.ndarray of shape [n_timesteps, height, width]

ndarray containing the field values

output_pathstr | Path

path in which to save the field animation. If None, then only shows it.

bound_mult_factorfloat, default: 0.2

multiplication factor to apply to the min/max values for the visualization.

intervalfloat, default: 400

time interval between frames to use for the animation.