roms_tools.SurfaceForcing.plot

SurfaceForcing.plot(var_name: str, time: int = 0, save_path: str | None = None) → None

Plot the specified surface forcing field for a given time slice.

Parameters:

• var_name (str) –

  The name of the surface forcing field to plot. Options include:

  • ”uwnd”: 10 meter wind in x-direction.

  • ”vwnd”: 10 meter wind in y-direction.

  • ”swrad”: Downward short-wave (solar) radiation.

  • ”lwrad”: Downward long-wave (thermal) radiation.

  • ”Tair”: Air temperature at 2m.

  • ”qair”: Absolute humidity at 2m.

  • ”rain”: Total precipitation.

  • ”xco2_air”: CO2 in Marine boundary layer.

  • ”xco2_air_alt”: CO2 in Marine boundary layer, alternative CO2.

  • ”iron”: Iron decomposition.

  • ”dust”: Dust decomposition.

  • ”nox”: NOx decomposition.

  • ”nhy”: NHy decomposition.

• time (int, optional) – The time index to plot. Default is 0, which corresponds to the first time slice.

• save_path (str, optional) – Path to save the generated plot. If None, the plot is shown interactively. Default is None.

Returns:

None – This method does not return any value. It generates and displays a plot.

Raises:

ValueError – If the specified var_name is not found in dataset.

Examples

>>> atm_forcing.plot("uwnd", time=0)