roms_tools.CDRForcing.plot_volume_flux

roms_tools.CDRForcing.plot_volume_flux#

CDRForcing.plot_volume_flux(start: datetime | None = None, end: datetime | None = None, release_names: list[str] | str = 'all')#

Plot the volume flux for each specified release within the given time range.

Parameters:

  • start (datetime or None) – Start datetime for the plot. If None, defaults to self.start_time.

  • end (datetime or None) – End datetime for the plot. If None, defaults to self.end_time.

  • release_names (list[str], or str, optional) – A list of release names to plot. If a string equal to “all”, all releases will be plotted. Defaults to “all”.

Raises:

ValueError – If self.releases are not of type VolumeRelease. If release_names is not a list of strings or “all”. If any of the specified release names do not exist in self.releases.