Plot shapefile/catchment utility function

[BSchilperoort]

For demo notebooks or in a student thesis it can be nice to show the catchment that is being modeled on a map. This would reduce the clutter and can implement a consistent and clean API to plot.

Something like;

def plot_catchment(
    shape: Path | str,
    lat_bounds: tuple[float, float] | None,
    lon_bounds: tuple[float, float] | None,
    ax: matplotlib.axis.Axis | None,
) -> tuple[matplotlib.figure.Figure, matplotlib.axis.Axis] | None:
    # Load shape / geometry

    if ax:
        # plot in existing axis
    else:
        # create cartopy mat plot, add shapefile
        # also add country borders, coastline, sea, rivers.

    if lat_bounds and lon_bounds:
        # apply bounds (set_xlim, set_ylim)
    else:
        # infer appropriate bounds, apply

    if ax is None:
        return fig, axis # return figure and axis so users can add to/modify plot

[BSchilperoort]

Following code is nice for a base map;

import matplotlib.pyplot as plt
import cartopy.crs as ccrs
import cartopy.feature as cfeature

plt.figure(figsize=(8, 5))
ax = plt.axes(projection=ccrs.PlateCarree())
ax.add_feature(cfeature.COASTLINE, linewidth=1)
ax.add_feature(cfeature.RIVERS, linewidth=1)
ax.add_feature(cfeature.OCEAN, edgecolor="none", facecolor="#a2daff")

Example plot, should run on any eWaterCycle environment;

import cartopy
from ewatercycle.testing.fixtures import rhine_shape

catchment_shape = next(cartopy.io.shapereader.Reader(rhine_shape()).records()).geometry

plt.figure(figsize=(8, 5))
ax = plt.axes(projection=cartopy.crs.PlateCarree())
ax.add_feature(cartopy.feature.COASTLINE, linewidth=1)
ax.add_feature(cartopy.feature.OCEAN, edgecolor="none", facecolor="#a2daff")
ax.add_geometries(catchment_shape, crs=cartopy.crs.PlateCarree(), color="red")
ax.set_xlim([3,12])
ax.set_ylim([45,55])