roms_tools.RiverForcing.plot

roms_tools.RiverForcing.plot#

RiverForcing.plot(var_name: str = 'river_volume', river_names: list[str] | str = 'all')#

Plots the river flux (e.g., volume, temperature, or salinity) over time for all rivers.

This method generates a time-series plot for a specified river-related variable (such as river volume, river temperature, or river salinity) for each river in the dataset. It can handle climatology data as well as time series data, and customizes the x-axis and labels accordingly.

Parameters:

  • var_name (str, optional) –

    The variable to plot. It can be one of the following:

    • ’river_volume’ : river volume flux.

    • ’river_temp’ : river temperature (from river_tracer).

    • ’river_salt’ : river salinity (from river_tracer).

    • ’river_PO4’ : river PO4 (from river_tracer).

    • ’river_NO3’ : river NO3 (from river_tracer).

    • ’river_SiO3’ : river SiO3 (from river_tracer).

    • ’river_NH4’ : river NH4 (from river_tracer).

    • ’river_Fe’ : river Fe (from river_tracer).

    • ’river_Lig’ : river Lig (from river_tracer).

    • ’river_O2’ : river O2 (from river_tracer).

    • ’river_DIC’ : river DIC (from river_tracer).

    • ’river_DIC_ALT_CO2’ : river DIC_ALT_CO2 (from river_tracer).

    • ’river_ALK’ : river ALK (from river_tracer).

    • ’river_ALK_ALT_CO2’ : river ALK_ALT_CO2 (from river_tracer).

    • ’river_DOC’ : river DOC (from river_tracer).

    • ’river_DON’ : river DON (from river_tracer).

    • ’river_DOP’ : river DOP (from river_tracer).

    • ’river_DOPr’ : river DOPr (from river_tracer).

    • ’river_DONr’ : river DONr (from river_tracer).

    • ’river_DOCr’ : river DOCr (from river_tracer).

    • ’river_zooC’ : river zooC (from river_tracer).

    • ’river_spChl’ : river sphChl (from river_tracer).

    • ’river_spC’ : river spC (from river_tracer).

    • ’river_spP’ : river spP (from river_tracer).

    • ’river_spFe’ : river spFe (from river_tracer).

    • ’river_spCaCO3’ : river spCaCO3 (from river_tracer).

    • ’river_diatChl’ : river diatChl (from river_tracer).

    • ’river_diatC’ : river diatC (from river_tracer).

    • ’river_diatP’ : river diatP (from river_tracer).

    • ’river_diatFe’ : river diatFe (from river_tracer).

    • ’river_diatSi’ : river diatSi (from river_tracer).

    • ’river_diazChl’ : river diazChl (from river_tracer).

    • ’river_diazC’ : river diazC (from river_tracer).

    • ’river_diazP’ : river diazP (from river_tracer).

    • ’river_diazFe’ : river diazFe (from river_tracer).

    The default is ‘river_volume’.

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