roms-tools 2.7.0__py3-none-any.whl → 3.1.0__py3-none-any.whl

roms_tools/plot.py

@@ -1,23 +1,65 @@
+from typing import Any, Literal
+
 import cartopy.crs as ccrs
 import matplotlib.pyplot as plt
-import xarray as xr
 import numpy as np
+import xarray as xr
+from matplotlib.axes import Axes
+from matplotlib.figure import Figure
 
+from roms_tools.regrid import LateralRegridFromROMS, VerticalRegridFromROMS
+from roms_tools.utils import (
+    _generate_coordinate_range,
+    _remove_edge_nans,
+    infer_nominal_horizontal_resolution,
+    normalize_longitude,
+)
+from roms_tools.vertical_coordinate import compute_depth_coordinates
 
-def _plot(
-    field,
-    depth_contours=False,
-    c="red",
-    title="",
-    with_dim_names=False,
-    plot_data=True,
-    add_colorbar=True,
-    kwargs={},
-    ax=None,
-):
-    """Plots a grid or field on a map with optional depth contours.
+LABEL_COLOR = "k"
+LABEL_SZ = 10
+FONT_SZ = 10
+EDGE_POS_START = "start"
+EDGE_POS_END = "end"
 
-    This function plots a map using Cartopy projections. It supports plotting a grid, a field, and adding depth contours if desired.
+
+def _add_gridlines(ax: Axes) -> None:
+    """Add styled gridlines with latitude and longitude labels to the plot.
+
+    Parameters
+    ----------
+    ax : matplotlib.axes.Axes
+        The axes to which gridlines will be added.
+    """
+    gridlines = ax.gridlines(
+        draw_labels=True, linewidth=0.5, color="gray", alpha=0.7, linestyle="--"
+    )
+    gridlines.top_labels = False  # Hide top labels
+    gridlines.right_labels = False  # Hide right labels
+    gridlines.xlabel_style = {
+        "size": LABEL_SZ,
+        "color": LABEL_COLOR,
+    }  # Customize longitude label style
+    gridlines.ylabel_style = {
+        "size": LABEL_SZ,
+        "color": LABEL_COLOR,
+    }  # Customize latitude label style
+
+
+def plot_2d_horizontal_field(
+    field: xr.DataArray,
+    depth_contours: bool = False,
+    c: str = "k",
+    title: str = "",
+    with_dim_names: bool = False,
+    plot_data: bool = True,
+    add_colorbar: bool = True,
+    kwargs: dict[str, Any] | None = None,
+    ax: Axes | None = None,
+) -> Figure | None:
+    """Plot a grid or field on a map using Cartopy projection.
+
+    Supports adding depth contours, if desired.
 
     Parameters
     ----------
@@ -26,7 +68,7 @@ def _plot(
     depth_contours : bool, optional
         If True, adds depth contours to the plot.
     c : str, optional
-        Color for the boundary plot (default is 'red').
+        Color for the boundary plot (default is "k").
     title : str, optional
         Title of the plot.
     plot_data : bool, optional
@@ -41,14 +83,15 @@ def _plot(
 
     Returns
     -------
-    matplotlib.figure.Figure
-        The generated figure with the plotted data, if a new figure was created.
+    matplotlib.figure.Figure, optional
+        The generated figure with the plotted data, only returned if `ax` is None.
 
     Raises
     ------
     NotImplementedError
         If the domain contains the North or South Pole.
     """
+    fig: Figure | None = None
 
     field = field.squeeze()
     lon_deg = field.lon
@@ -60,18 +103,12 @@ def _plot(
             "Plotting is not implemented for the case that the domain contains the North or South pole."
         )
 
-    trans = _get_projection(lon_deg, lat_deg)
+    trans = get_projection(lon_deg, lat_deg)
 
     if ax is None:
         fig, ax = plt.subplots(1, 1, figsize=(13, 7), subplot_kw={"projection": trans})
 
-    lon_deg = lon_deg.values
-    lat_deg = lat_deg.values
-
-    if c is not None:
-        _add_boundary_to_ax(
-            ax, lon_deg, lat_deg, trans, c, with_dim_names=with_dim_names
-        )
+    _add_boundary_to_ax(ax, lon_deg, lat_deg, trans, c, with_dim_names=with_dim_names)
 
     if plot_data:
         _add_field_to_ax(
@@ -84,33 +121,14 @@ def _plot(
             kwargs=kwargs,
         )
 
-    ax.coastlines(
-        resolution="50m", linewidth=0.5, color="black"
-    )  # add map of coastlines
-
-    # Add gridlines with labels for latitude and longitude
-    gridlines = ax.gridlines(
-        draw_labels=True, linewidth=0.5, color="gray", alpha=0.7, linestyle="--"
-    )
-    gridlines.top_labels = False  # Hide top labels
-    gridlines.right_labels = False  # Hide right labels
-    gridlines.xlabel_style = {
-        "size": 10,
-        "color": "black",
-    }  # Customize longitude label style
-    gridlines.ylabel_style = {
-        "size": 10,
-        "color": "black",
-    }  # Customize latitude label style
+    _add_gridlines(ax)
 
     ax.set_title(title)
 
-    # Only return fig if it was created inside the function (i.e., ax was not provided)
-    if ax is None:
-        return fig
+    return fig
 
 
-def _plot_nesting(parent_grid_ds, child_grid_ds, parent_straddle, with_dim_names=False):
+def plot_nesting(parent_grid_ds, child_grid_ds, parent_straddle, with_dim_names=False):
     """Plots nested parent and child grids with boundary overlays and grid masking.
 
     Parameters
@@ -131,7 +149,6 @@ def _plot_nesting(parent_grid_ds, child_grid_ds, parent_straddle, with_dim_names
         The generated figure displaying the parent and child grid boundaries, mask,
         and additional map features.
     """
-
     parent_lon_deg = parent_grid_ds["lon_rho"]
     parent_lat_deg = parent_grid_ds["lat_rho"]
 
@@ -146,12 +163,7 @@ def _plot_nesting(parent_grid_ds, child_grid_ds, parent_straddle, with_dim_names
             child_lon_deg > 180, child_lon_deg - 360, child_lon_deg
         )
 
-    trans = _get_projection(parent_lon_deg, parent_lat_deg)
-
-    parent_lon_deg = parent_lon_deg.values
-    parent_lat_deg = parent_lat_deg.values
-    child_lon_deg = child_lon_deg.values
-    child_lat_deg = child_lat_deg.values
+    trans = get_projection(parent_lon_deg, parent_lat_deg)
 
     fig, ax = plt.subplots(1, 1, figsize=(13, 7), subplot_kw={"projection": trans})
 
@@ -178,42 +190,29 @@ def _plot_nesting(parent_grid_ds, child_grid_ds, parent_straddle, with_dim_names
     vmax = 3
     vmin = 0
     cmap = plt.colormaps.get_cmap("Blues")
+    cmap.set_bad(color="gray")
     kwargs = {"vmax": vmax, "vmin": vmin, "cmap": cmap}
 
+    field = parent_grid_ds.mask_rho
+    field = field.where(field)
+
     _add_field_to_ax(
         ax,
         parent_lon_deg,
         parent_lat_deg,
-        parent_grid_ds.mask_rho,
+        field,
         add_colorbar=False,
         kwargs=kwargs,
     )
 
-    ax.coastlines(
-        resolution="50m", linewidth=0.5, color="black"
-    )  # add map of coastlines
-
-    # Add gridlines with labels for latitude and longitude
-    gridlines = ax.gridlines(
-        draw_labels=True, linewidth=0.5, color="gray", alpha=0.7, linestyle="--"
-    )
-    gridlines.top_labels = False  # Hide top labels
-    gridlines.right_labels = False  # Hide right labels
-    gridlines.xlabel_style = {
-        "size": 10,
-        "color": "black",
-    }  # Customize longitude label style
-    gridlines.ylabel_style = {
-        "size": 10,
-        "color": "black",
-    }  # Customize latitude label style
+    _add_gridlines(ax)
 
     ax.legend(loc="best")
 
     return fig
 
 
-def _section_plot(field, interface_depth=None, title="", kwargs={}, ax=None):
+def section_plot(field, interface_depth=None, title="", kwargs={}, ax=None):
     """Plots a vertical section of a field with optional interface depths.
 
     Parameters
@@ -232,8 +231,8 @@ def _section_plot(field, interface_depth=None, title="", kwargs={}, ax=None):
 
     Returns
     -------
-    matplotlib.figure.Figure
-        The generated figure with the plotted section.
+    matplotlib.figure.Figure, optional
+        The generated figure with the plotted section, only returned if `ax` is None.
 
     Raises
     ------
@@ -247,7 +246,6 @@ def _section_plot(field, interface_depth=None, title="", kwargs={}, ax=None):
     -----
     - NaN values at the horizontal ends are dropped before plotting.
     """
-
     if ax is None:
         fig, ax = plt.subplots(1, 1, figsize=(9, 5))
 
@@ -292,6 +290,13 @@ def _section_plot(field, interface_depth=None, title="", kwargs={}, ax=None):
             ax.plot(
                 interface_depth[xdim], interface_depth.isel({layer_key: i}), color="k"
             )
+    # Fill everything below the bathymetry line in gray
+    ax.fill_between(
+        field[xdim],
+        field[depth_label][0],
+        y2=ax.get_ylim()[0],
+        color="gray",
+    )
 
     ax.set_title(title)
     ax.set_ylabel("Depth [m]")
@@ -304,10 +309,11 @@ def _section_plot(field, interface_depth=None, title="", kwargs={}, ax=None):
         xlabel = xdim
     ax.set_xlabel(xlabel)
 
-    return fig
+    if ax is None:
+        return fig
 
 
-def _profile_plot(field, title="", ax=None):
+def profile_plot(field, title="", ax=None):
     """Plots a vertical profile of the given field against depth.
 
     This function generates a profile plot by plotting the field values against
@@ -326,7 +332,7 @@ def _profile_plot(field, title="", ax=None):
     Returns
     -------
     matplotlib.figure.Figure
-        The generated figure with the plotted profile.
+        The generated figure with the plotted profile, only returned if `ax` is None.
 
     Raises
     ------
@@ -337,7 +343,6 @@ def _profile_plot(field, title="", ax=None):
     -----
     - The y-axis is inverted to ensure that depth increases downward.
     """
-
     depths_to_check = [
         "layer_depth",
         "interface_depth",
@@ -361,10 +366,11 @@ def _profile_plot(field, title="", ax=None):
     ax.set_ylabel("Depth [m]")
     ax.grid()
 
-    return fig
+    if ax is None:
+        return fig
 
 
-def _line_plot(field, title="", ax=None):
+def line_plot(field, title="", ax=None):
     """Plots a line graph of the given field with grey vertical bars indicating NaN
     regions.
 
@@ -380,7 +386,8 @@ def _line_plot(field, title="", ax=None):
     Returns
     -------
     matplotlib.figure.Figure
-        The generated figure with the plotted data and highlighted NaN regions.
+        The generated figure with the plotted data and highlighted NaN regions, only
+        returned if `ax` is None.
 
     Raises
     ------
@@ -392,7 +399,6 @@ def _line_plot(field, title="", ax=None):
     -----
     - NaN regions are identified and marked using `axvspan` with a grey shade.
     """
-
     if ax is None:
         fig, ax = plt.subplots(1, 1, figsize=(7, 4))
 
@@ -447,11 +453,25 @@ def _line_plot(field, title="", ax=None):
         xlabel = xdim
     ax.set_xlabel(xlabel)
 
-    return fig
+    if ax is None:
+        return fig
+
+
+def _get_edge(
+    arr: xr.DataArray, dim_name: str, pos: Literal[EDGE_POS_START, EDGE_POS_END]
+) -> xr.DataArray:
+    """Extract the first ("start") or last ("end") slice along the given dimension."""
+    if pos == EDGE_POS_START:
+        return arr.isel({dim_name: 0})
+
+    if pos == EDGE_POS_END:
+        return arr.isel({dim_name: -1})
+
+    raise ValueError(f"pos must be {EDGE_POS_START} or {EDGE_POS_END}")
 
 
 def _add_boundary_to_ax(
-    ax, lon_deg, lat_deg, trans, c="red", label="", with_dim_names=False
+    ax, lon_deg, lat_deg, trans, c="k", label="", with_dim_names=False
 ):
     """Plots a grid or field on a map with optional depth contours.
 
@@ -470,67 +490,85 @@ def _add_boundary_to_ax(
         The projection for transforming coordinates.
 
     c : str, optional
-        Color of the grid boundary (default is 'red').
+        Color of the grid boundary (default is 'k').
     """
     proj = ccrs.PlateCarree()
 
-    # find corners
-    corners = [
-        (lon_deg[0, 0], lat_deg[0, 0]),
-        (lon_deg[0, -1], lat_deg[0, -1]),
-        (lon_deg[-1, -1], lat_deg[-1, -1]),
-        (lon_deg[-1, 0], lat_deg[-1, 0]),
+    xi_dim = next(d for d in lon_deg.dims if d.startswith("xi_"))
+    eta_dim = next(d for d in lon_deg.dims if d.startswith("eta_"))
+
+    edges = [
+        (
+            _get_edge(lon_deg, xi_dim, EDGE_POS_START),
+            _get_edge(lat_deg, xi_dim, EDGE_POS_START),
+            r"$\eta$",
+        ),  # left
+        (
+            _get_edge(lon_deg, xi_dim, EDGE_POS_END),
+            _get_edge(lat_deg, xi_dim, EDGE_POS_END),
+            r"$\eta$",
+        ),  # right
+        (
+            _get_edge(lon_deg, eta_dim, EDGE_POS_START),
+            _get_edge(lat_deg, eta_dim, EDGE_POS_START),
+            r"$\xi$",
+        ),  # bottom
+        (
+            _get_edge(lon_deg, eta_dim, EDGE_POS_END),
+            _get_edge(lat_deg, eta_dim, EDGE_POS_END),
+            r"$\xi$",
+        ),  # top
     ]
 
-    # transform coordinates to projected space
-    transformed_corners = [trans.transform_point(lo, la, proj) for lo, la in corners]
-    transformed_lons, transformed_lats = zip(*transformed_corners)
-
-    ax.plot(
-        list(transformed_lons) + [transformed_lons[0]],
-        list(transformed_lats) + [transformed_lats[0]],
-        "o-",
-        c=c,
-        label=label,
-    )
-
-    if with_dim_names:
-        for i in range(len(corners)):
-            if i in [0, 2]:
-                dim_name = r"$\xi$"
-            else:
-                dim_name = r"$\eta$"
-            # Define start and end points for each edge
-            start_lon, start_lat = transformed_corners[i]
-            end_lon, end_lat = transformed_corners[(i + 1) % len(corners)]
-
-            # Compute midpoint
-            mid_lon = (start_lon + end_lon) / 2
-            mid_lat = (start_lat + end_lat) / 2
-
-            # Compute vector direction for arrow
-            arrow_dx = (end_lon - start_lon) * 0.4  # Scale arrow size
-            arrow_dy = (end_lat - start_lat) * 0.4
-
-            # Reverse arrow direction for edges 2 and 3
-            if i in [2, 3]:
-                arrow_dx *= -1
-                arrow_dy *= -1
-
-            # Add arrow
+    for i, (lon, lat, dim_name) in enumerate(edges):
+        ax.plot(lon, lat, transform=proj, c=c, label=label if i == 0 else None)
+
+        if with_dim_names:
+            # Get start and end point
+            start_lon = float(lon[0])
+            start_lat = float(lat[0])
+            end_lon = float(lon[-1])
+            end_lat = float(lat[-1])
+
+            # Midpoint of the edge
+            mid_lon = float(lon[len(lon) // 2])
+            mid_lat = float(lat[len(lat) // 2])
+
+            # Direction of edge (unit vector)
+            dx = end_lon - start_lon
+            dy = end_lat - start_lat
+            norm = np.hypot(dx, dy)
+            if norm == 0:
+                continue
+            ux = dx / norm
+            uy = dy / norm
+
+            # Arrowhead only (zero-length shaft)
+            head_size = 0.02 * norm
             ax.annotate(
                 "",
-                xy=(mid_lon + arrow_dx, mid_lat + arrow_dy),
-                xytext=(mid_lon - arrow_dx, mid_lat - arrow_dy),
-                arrowprops=dict(arrowstyle="->", color=c, lw=1.5),
+                xy=(mid_lon + ux * head_size, mid_lat + uy * head_size),
+                xytext=(mid_lon, mid_lat),
+                transform=proj,
+                arrowprops=dict(
+                    arrowstyle="->",
+                    color=c,
+                    lw=1.5,
+                    mutation_scale=20,
+                ),
             )
 
+            # Label position on edge
+            label_lon = float(lon[len(lon) // 4 * 3])
+            label_lat = float(lat[len(lat) // 4 * 3])
+
             ax.text(
-                mid_lon,
-                mid_lat,
+                label_lon,
+                label_lat,
                 dim_name,
+                transform=proj,
                 color=c,
-                fontsize=10,
+                fontsize=FONT_SZ,
                 ha="center",
                 va="center",
                 bbox=dict(
@@ -578,7 +616,7 @@ def _add_field_to_ax(
 
     Notes
     -----
-    - If `depth_contours` is True, the field’s `layer_depth` is used to add contours.
+    - If `depth_contours` is True, the `layer_depth` of `field` is used to add contours.
     """
     proj = ccrs.PlateCarree()
 
@@ -593,13 +631,469 @@ def _add_field_to_ax(
     if add_colorbar:
         plt.colorbar(p, label=label)
 
-    if depth_contours:
+    if depth_contours and "layer_depth" in field.coords:
         cs = ax.contour(lon_deg, lat_deg, field.layer_depth, transform=proj, colors="k")
-        ax.clabel(cs, inline=True, fontsize=10)
-
+        ax.clabel(cs, inline=True, fontsize=FONT_SZ)
 
-def _get_projection(lon, lat):
 
+def get_projection(lon, lat):
     return ccrs.NearsidePerspective(
         central_longitude=lon.mean().values, central_latitude=lat.mean().values
     )
+
+
+def _validate_plot_inputs(
+    field: xr.DataArray,
+    s: int | None,
+    eta: int | None,
+    xi: int | None,
+    depth: float | None,
+    lat: float | None,
+    lon: float | None,
+    include_boundary: bool,
+) -> None:
+    """Validate input parameters for the plot method.
+
+    Parameters
+    ----------
+    field : xr.DataArray
+        Input data to be plotted.
+    s : int, float, or None
+        Depth level index or value for the s-coordinate. Use None for surface plotting.
+    eta : int or None
+        Eta index for ROMS grid selection. Must be within bounds.
+    xi : int or None
+        Xi index for ROMS grid selection. Must be within bounds.
+    depth : int, float, or None
+        Depth value for slicing. Not yet implemented.
+    lat : float or None
+        Latitude value for slicing. Must be specified with `lon` if provided.
+    lon : float or None
+        Longitude value for slicing. Must be specified with `lat` if provided.
+    include_boundary : bool
+        Whether to include boundary points when selecting grid indices.
+
+    Raises
+    ------
+    ValueError
+        If conflicting dimensions are specified.
+        If eta or xi indices are out of bounds.
+        If eta or xi lie on the boundary when `include_boundary=False`.
+    """
+    # Check conflicting dimension choices
+    if s is not None and depth is not None:
+        raise ValueError(
+            "Conflicting input: You cannot specify both 's' and 'depth' at the same time."
+        )
+    if any([eta is not None, xi is not None]) and any(
+        [lat is not None, lon is not None]
+    ):
+        raise ValueError(
+            "Conflicting input: You cannot specify 'lat' or 'lon' simultaneously with 'eta' or 'xi'."
+        )
+
+    # 3D fields: Check for valid dimension specification
+    if len(field.dims) == 3:
+        if all(val is None for val in [s, eta, xi, depth, lat, lon]):
+            raise ValueError(
+                "Invalid input: For 3D fields, you must specify at least one of the dimensions 's', 'eta', 'xi', 'depth', 'lat', or 'lon'."
+            )
+        if sum([dim is not None for dim in [s, eta, xi, depth, lat, lon]]) > 2:
+            raise ValueError(
+                "Ambiguous input: For 3D fields, specify at most two of 's', 'eta', 'xi', 'depth', 'lat', or 'lon'. Specifying more than two is not allowed."
+            )
+
+    # 2D fields: Check for conflicts in dimension choices
+    if len(field.dims) == 2:
+        if s is not None:
+            raise ValueError("Vertical dimension 's' should be None for 2D fields.")
+        if depth is not None:
+            raise ValueError("Vertical dimension 'depth' should be None for 2D fields.")
+        if all([eta is not None, xi is not None]):
+            raise ValueError(
+                "Conflicting input: For 2D fields, specify only one dimension, either 'eta' or 'xi', not both."
+            )
+        if all([lat is not None, lon is not None]):
+            raise ValueError(
+                "Conflicting input: For 2D fields, specify only one dimension, either 'lat' or 'lon', not both."
+            )
+
+    # Check that indices are within bounds
+    if eta is not None:
+        dim = "eta_rho" if "eta_rho" in field.dims else "eta_v"
+        if eta >= len(field[dim]):
+            raise ValueError(
+                f"Invalid eta index: {eta} is out of bounds. Must be less than {len(field[dim])}."
+            )
+        if not include_boundary:
+            if eta == 0 or eta == len(field[dim]) - 1:
+                raise ValueError(
+                    f"Invalid eta index: {eta} lies on the boundary, which is excluded when `include_boundary = False`. "
+                    "Either set `include_boundary = True`, or adjust eta to avoid boundary values."
+                )
+
+    if xi is not None:
+        dim = "xi_rho" if "xi_rho" in field.dims else "xi_u"
+        if not xi < len(field[dim]):
+            raise ValueError(
+                f"Invalid eta index: {xi} is out of bounds. Must be less than {len(field[dim])}."
+            )
+        if not include_boundary:
+            if xi == 0 or xi == len(field[dim]) - 1:
+                raise ValueError(
+                    f"Invalid xi index: {xi} lies on the boundary, which is excluded when `include_boundary = False`. "
+                    "Either set `include_boundary = True`, or adjust eta to avoid boundary values."
+                )
+
+
+def _set_plotting_kwargs(field: xr.DataArray, cmap_name: str) -> dict[str, Any]:
+    """Return vmin, vmax, and colormap for plotting."""
+    if cmap_name == "RdBu_r":
+        vmax = max(field.max().values, -field.min().values)
+        vmin = -vmax
+    else:
+        vmax = field.max().values
+        vmin = field.min().values
+
+    cmap = plt.colormaps.get_cmap(cmap_name)
+    cmap.set_bad(color="gray")
+
+    return {"vmax": vmax, "vmin": vmin, "cmap": cmap}
+
+
+def plot(
+    field: xr.DataArray,
+    grid_ds: xr.DataArray,
+    zeta: xr.DataArray | float = 0.0,
+    s: int | None = None,
+    eta: int | None = None,
+    xi: int | None = None,
+    depth: float | None = None,
+    lat: float | None = None,
+    lon: float | None = None,
+    include_boundary: bool = True,
+    depth_contours: bool = False,
+    layer_contours: bool = False,
+    max_nr_layer_contours: int | None = 10,
+    use_coarse_grid: bool = False,
+    with_dim_names: bool = False,
+    ax: Axes | None = None,
+    save_path: str | None = None,
+    cmap_name: str | None = "YlOrRd",
+    add_colorbar: bool = True,
+) -> None:
+    """Generate a plot of a 2D or 3D ROMS field for a horizontal or vertical slice.
+
+    This function supports plotting:
+
+    - horizontal slices at a specific vertical level or depth,
+    - vertical sections along constant indices or geographic lines,
+    - or 2D fields directly.
+
+    Parameters
+    ----------
+    field : xr.DataArray
+        ROMS variable already selected at a single time index.
+
+    grid_ds : xr.DataArray
+        ROMS grid dataset containing the grid geometry, including latitude/longitude,
+        inverse grid spacing (`pm`, `pn`), depth (`h`), and land/sea mask.
+        It must also include the attribute `"straddle"` to indicate whether
+        the grid crosses the dateline.
+
+    zeta : xr.DataArray or float, optional
+        Sea surface height for computing vertical coordinates. Defaults to 0.0 (flat surface).
+
+    s : int, optional
+        Vertical layer index (`s_rho`) to plot. Cannot be used with `depth`. Default is None.
+
+    eta : int, optional
+        Eta index for vertical sections or constant-eta horizontal slices.
+        Cannot be used with `lat` or `lon`. Default is None.
+
+    xi : int, optional
+        Xi index for vertical sections or constant-xi horizontal slices.
+        Cannot be used with `lat` or `lon`. Default is None.
+
+    depth : float, optional
+        Physical depth (in meters) for horizontal slices. Cannot be used with `s`. Default is None.
+
+    lat : float, optional
+        Latitude (in degrees) for vertical sections. Cannot be combined with `eta` or `xi`. Default is None.
+
+    lon : float, optional
+        Longitude (in degrees) for vertical sections. Cannot be combined with `eta` or `xi`. Default is None.
+
+    include_boundary : bool, optional
+        Whether to include the outermost grid cells along the `eta`- and `xi`-boundaries in the plot.
+        Useful to exclude ghost points. Default is True.
+
+    depth_contours : bool, optional
+        If True, add contours of constant bathymetry to horizontal plots. Ignored otherwise.
+        Default is False.
+
+    layer_contours : bool, optional
+        If True, show vertical layer boundaries in vertical sections. Default is False.
+
+    max_nr_layer_contours : int, optional
+        Maximum number of vertical layer contours to draw. Default is 10.
+
+    use_coarse_grid : bool, optional
+        Use precomputed coarse-resolution grid. Default is False.
+
+    with_dim_names : bool, optional
+        Add grid dimension names (`xi`, `eta`) to the outer plot edges. Only for 2D plots. Default is False.
+
+    ax : Axes, optional
+        Matplotlib axes object. If None, a new figure is created. Default is None.
+
+    save_path : str, optional
+        File path to save the plot. If None, the plot is shown interactively. Default is None.
+
+    cmap_name : str, optional
+        Name of matplotlib colormap. Default is "YlOrRd".
+
+    add_colorbar : bool, optional
+        Whether to add a colorbar to the plot. Default is True.
+
+    Returns
+    -------
+    None
+        The function generates and shows or saves a plot. No value is returned.
+
+    Raises
+    ------
+    ValueError
+        - If no plotting dimensions are specified for 3D fields.
+        - If conflicting dimensions are specified (e.g., both `s` and `depth`).
+        - If incompatible combinations of grid indices and geographic coordinates are provided.
+        - If specified `eta` or `xi` indices are out of bounds.
+        - If boundary indices are used when `include_boundary=False`.
+    """
+    # Input checks
+    _validate_plot_inputs(field, s, eta, xi, depth, lat, lon, include_boundary)
+
+    if "straddle" not in grid_ds.attrs:
+        raise AttributeError("Grid dataset must have a 'straddle' attribute.")
+
+    straddle = grid_ds.attrs["straddle"]
+    straddle = straddle == "True"  # convert string 'True' / 'False' into boolean
+
+    # Get horizontal dimensions and grid location
+    horizontal_dims_dict = {
+        "rho": {"eta": "eta_rho", "xi": "xi_rho"},
+        "u": {"eta": "eta_rho", "xi": "xi_u"},
+        "v": {"eta": "eta_v", "xi": "xi_rho"},
+    }
+    for loc, horizontal_dims in horizontal_dims_dict.items():
+        if all(dim in field.dims for dim in horizontal_dims.values()):
+            break
+
+    def _get_absolute_index(idx, field, dim_name):
+        index = field[dim_name].isel(**{dim_name: idx}).item()
+        return index
+
+    if eta is not None and eta < 0:
+        eta = _get_absolute_index(eta, field, horizontal_dims["eta"])
+    if xi is not None and xi < 0:
+        xi = _get_absolute_index(xi, field, horizontal_dims["xi"])
+    if s is not None and s < 0:
+        s = _get_absolute_index(s, field, "s_rho")
+
+    # Set spatial coordinates
+    if use_coarse_grid:
+        if loc != "rho":
+            raise ValueError("If using coarse grid, can only plot on rho-points.")
+        lat_deg = grid_ds["lat_coarse"].rename(
+            {"eta_coarse": "eta_rho", "xi_coarse": "xi_rho"}
+        )
+        lon_deg = grid_ds["lon_coarse"].rename(
+            {"eta_coarse": "eta_rho", "xi_coarse": "xi_rho"}
+        )
+        mask = grid_ds["mask_coarse"].rename(
+            {"eta_coarse": "eta_rho", "xi_coarse": "xi_rho"}
+        )
+    else:
+        lat_deg = grid_ds[f"lat_{loc}"]
+        lon_deg = grid_ds[f"lon_{loc}"]
+        mask = grid_ds[f"mask_{loc}"]
+
+    if straddle:
+        lon_deg = xr.where(lon_deg > 180, lon_deg - 360, lon_deg)
+    if lon is not None:
+        lon = normalize_longitude(lon, straddle)
+
+    field = field.assign_coords({"lon": lon_deg, "lat": lat_deg})
+
+    # Mask the field
+    field = field.where(mask)
+
+    # Assign eta and xi as coordinates
+    coords_to_assign = {dim: field[dim] for dim in horizontal_dims.values()}
+    field = field.assign_coords(**coords_to_assign)
+
+    # Remove horizontal boundary if desired
+    slice_dict = {
+        "rho": {"eta_rho": slice(1, -1), "xi_rho": slice(1, -1)},
+        "u": {"eta_rho": slice(1, -1), "xi_u": slice(1, -1)},
+        "v": {"eta_v": slice(1, -1), "xi_rho": slice(1, -1)},
+    }
+    if not include_boundary:
+        field = field.isel(**slice_dict[loc])
+
+    # Prepare figure title
+    if "abs_time" in field.coords:
+        formatted_time = np.datetime_as_string(field.abs_time.values, unit="m")
+        title = f"time: {formatted_time}"
+    elif "ntides" in field.coords:
+        title = f"constituent: {field.ntides.values.item().decode('utf-8')}"
+    elif "long_name" in field.attrs:
+        title = field.long_name
+    else:
+        title = ""
+
+    def _slice_along_dimension(field, title, dim_name, idx):
+        field = field.sel(**{dim_name: idx})
+        title = title + f", {dim_name} = {idx}"
+        return field, title
+
+    if eta is not None:
+        field, title = _slice_along_dimension(field, title, horizontal_dims["eta"], eta)
+    if xi is not None:
+        field, title = _slice_along_dimension(field, title, horizontal_dims["xi"], xi)
+    if s is not None:
+        field, title = _slice_along_dimension(field, title, "s_rho", s)
+
+    # Compute layer and interface depth if necessary
+    compute_layer_depth = ("s_rho" in field.dims) or (
+        depth_contours and s is not None and lat is None and lon is None
+    )
+    compute_interface_depth = (
+        len(field.dims) == 2
+        and "s_rho" in field.dims
+        and layer_contours
+        and (lat is None)
+        and (lon is None)
+        and (depth is None)
+    )
+
+    def _compute_and_slice_depth(depth_type):
+        depth = compute_depth_coordinates(
+            grid_ds, zeta, depth_type=depth_type, location=loc, eta=eta, xi=xi
+        )
+        if not include_boundary:
+            depth = depth.isel(
+                **{
+                    dim: i
+                    for dim, i in slice_dict.get(loc, {}).items()
+                    if dim in depth.dims
+                }
+            )
+        if s is not None:
+            depth = depth.isel(s_rho=s)
+        return depth.load()
+
+    if compute_layer_depth:
+        layer_depth = _compute_and_slice_depth("layer")
+
+    if compute_interface_depth:
+        interface_depth = _compute_and_slice_depth("interface")
+
+    # Regrid laterally
+    if lat is not None or lon is not None:
+        if lat is not None:
+            lats = [lat]
+            title = title + f", lat = {lat}°N"
+        else:
+            resolution = infer_nominal_horizontal_resolution(grid_ds)
+            lats = _generate_coordinate_range(
+                field.lat.min().values, field.lat.max().values, resolution
+            )
+        lats = xr.DataArray(lats, dims=["lat"], attrs={"units": "°N"})
+
+        if lon is not None:
+            lons = [lon]
+            title = title + f", lon = {lon}°E"
+        else:
+            resolution = infer_nominal_horizontal_resolution(grid_ds, lat)
+            lons = _generate_coordinate_range(
+                field.lon.min().values, field.lon.max().values, resolution
+            )
+        lons = xr.DataArray(lons, dims=["lon"], attrs={"units": "°E"})
+
+        target_coords = {"lat": lats, "lon": lons}
+        lateral_regrid = LateralRegridFromROMS(field, target_coords)
+        field = lateral_regrid.apply(field).squeeze()
+
+        if compute_layer_depth:
+            layer_depth = lateral_regrid.apply(layer_depth).squeeze()
+
+    # Assign depth as coordinate
+    if compute_layer_depth:
+        field = field.assign_coords({"layer_depth": layer_depth})
+
+    if lat is not None:
+        field, layer_depth = _remove_edge_nans(
+            field, "lon", layer_depth if "layer_depth" in locals() else None
+        )
+    if lon is not None:
+        field, layer_depth = _remove_edge_nans(
+            field, "lat", layer_depth if "layer_depth" in locals() else None
+        )
+
+    # Regrid vertically
+    if depth is not None:
+        ds = xr.Dataset()
+        ds["s_rho"] = field["s_rho"]
+        vertical_regrid = VerticalRegridFromROMS(ds)
+        # Save attributes before vertical regridding
+        attrs = field.attrs
+        field = vertical_regrid.apply(field, layer_depth, np.array([depth])).squeeze()
+        # Reset attributes
+        field.attrs = attrs
+        title = title + f", depth = {depth}m"
+        depth_contours = False
+
+    # Plotting
+    kwargs = _set_plotting_kwargs(field, cmap_name)
+
+    if (eta is None and xi is None) and (lat is None and lon is None):
+        fig = plot_2d_horizontal_field(
+            field=field,
+            depth_contours=depth_contours,
+            with_dim_names=with_dim_names,
+            title=title,
+            kwargs=kwargs,
+            add_colorbar=add_colorbar,
+        )
+    else:
+        if len(field.dims) == 2:
+            if compute_interface_depth:
+                if max_nr_layer_contours:
+                    # restrict number of layer_contours for the sake of plot clearity
+                    nr_layers = len(interface_depth["s_w"])
+                    selected_layers = np.linspace(
+                        0,
+                        nr_layers - 1,
+                        min(nr_layers, max_nr_layer_contours),
+                        dtype=int,
+                    )
+                    interface_depth = interface_depth.isel(s_w=selected_layers)
+            else:
+                interface_depth = None
+
+            fig = section_plot(
+                field,
+                interface_depth=interface_depth,
+                title=title,
+                kwargs={**kwargs, "add_colorbar": add_colorbar},
+                ax=ax,
+            )
+        else:
+            if "s_rho" in field.dims:
+                fig = profile_plot(field, title=title, ax=ax)
+            else:
+                fig = line_plot(field, title=title, ax=ax)
+
+    if save_path:
+        plt.savefig(save_path, dpi=300, bbox_inches="tight")