roms-tools 3.2.0__py3-none-any.whl → 3.3.0__py3-none-any.whl

roms_tools/__init__.py

@@ -20,7 +20,7 @@ from roms_tools.setup.river_forcing import RiverForcing  # noqa: F401
 from roms_tools.setup.surface_forcing import SurfaceForcing  # noqa: F401
 from roms_tools.setup.tides import TidalForcing  # noqa: F401
 from roms_tools.tiling.partition import partition_netcdf  # noqa: F401
-from roms_tools.setup.datasets import get_glorys_bounds  # noqa: F401
+from roms_tools.setup.lat_lon_datasets import get_glorys_bounds  # noqa: F401
 from roms_tools.tiling.join import open_partitions, join_netcdf  # noqa: F401
 
 

roms_tools/plot.py

@@ -96,12 +96,6 @@ def plot_2d_horizontal_field(
     lon_deg = field.lon
     lat_deg = field.lat
 
-    # check if North or South pole are in domain
-    if lat_deg.max().values > 89 or lat_deg.min().values < -89:
-        raise NotImplementedError(
-            "Plotting is not implemented for the case that the domain contains the North or South pole."
-        )
-
     trans = get_projection(lon_deg, lat_deg)
 
     if ax is None:
@@ -186,25 +180,8 @@ def plot_nesting(parent_grid_ds, child_grid_ds, parent_straddle, with_dim_names=
         with_dim_names=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,
-        field,
-        add_colorbar=False,
-        kwargs=kwargs,
-    )
-
     _add_gridlines(ax)
+    ax.coastlines()
 
     ax.legend(loc="best")
 
@@ -659,7 +636,7 @@ def _add_field_to_ax(
     proj = ccrs.PlateCarree()
 
     p = ax.pcolormesh(lon_deg, lat_deg, field, transform=proj, **kwargs)
-    if hasattr(field, "long_name"):
+    if hasattr(field, "long_name") and hasattr(field, "units"):
         label = f"{field.long_name} [{field.units}]"
     elif hasattr(field, "Long_name"):
         # this is the case for matlab generated grids
@@ -674,10 +651,36 @@ def _add_field_to_ax(
         ax.clabel(cs, inline=True, fontsize=FONT_SZ)
 
 
-def get_projection(lon, lat):
-    return ccrs.NearsidePerspective(
-        central_longitude=lon.mean().values, central_latitude=lat.mean().values
-    )
+def get_projection(lon: xr.DataArray, lat: xr.DataArray):
+    """
+    Return a Cartopy projection appropriate for the given lon/lat domain.
+
+    - Raises an error if the domain includes either pole.
+    - Uses PlateCarree if the longitudinal span > 90°.
+    - Otherwise uses NearsidePerspective centered on the domain.
+
+    Parameters
+    ----------
+    lon, lat : xr.DataArray
+        Longitude and latitude values in degrees.
+
+    Returns
+    -------
+    cartopy.crs.Projection
+        The chosen Cartopy projection.
+    """
+    # check if North or South pole are in domain
+    if lat.max() > 89 or lat.min() < -89:
+        raise NotImplementedError(
+            "Plotting is not implemented for the case that the domain contains the North or South pole."
+        )
+
+    if lon.max() - lon.min() > 90:
+        return ccrs.PlateCarree(central_longitude=lon.mean().values)
+    else:
+        return ccrs.NearsidePerspective(
+            central_longitude=lon.mean().values, central_latitude=lat.mean().values
+        )
 
 
 def _validate_plot_inputs(
@@ -816,6 +819,7 @@ def plot(
     yincrease: bool | None = None,
     use_coarse_grid: bool = False,
     with_dim_names: bool = False,
+    apply_mask: bool = True,
     ax: Axes | None = None,
     save_path: str | None = None,
     cmap_name: str = "YlOrRd",
@@ -889,6 +893,9 @@ def plot(
     with_dim_names : bool, optional
         Add grid dimension names (`xi`, `eta`) to the outer plot edges. Only for 2D plots. Default is False.
 
+    apply_mask: bool, optional
+        Whether to apply the land mask to the field. Default is True.
+
     ax : Axes, optional
         Matplotlib axes object. If None, a new figure is created. Default is None.
 
@@ -971,7 +978,8 @@ def plot(
     field = field.assign_coords({"lon": lon_deg, "lat": lat_deg})
 
     # Mask the field
-    field = field.where(mask)
+    if apply_mask:
+        field = field.where(mask)
 
     # Assign eta and xi as coordinates
     coords_to_assign = {dim: field[dim] for dim in horizontal_dims.values()}

roms_tools/setup/boundary_forcing.py

@@ -13,14 +13,14 @@ from scipy.ndimage import label
 from roms_tools import Grid
 from roms_tools.plot import line_plot, section_plot
 from roms_tools.regrid import LateralRegridToROMS, VerticalRegridToROMS
-from roms_tools.setup.datasets import (
+from roms_tools.setup.lat_lon_datasets import (
     CESMBGCDataset,
     GLORYSDataset,
     GLORYSDefaultDataset,
-    RawDataSource,
     UnifiedBGCDataset,
 )
 from roms_tools.setup.utils import (
+    RawDataSource,
     add_time_info_to_ds,
     compute_barotropic_velocity,
     compute_missing_bgc_variables,

roms_tools/setup/grid.py

@@ -201,13 +201,19 @@ class Grid:
             self.mask_shapefile = mask_shapefile
 
     def update_topography(
-        self, topography_source=None, hmin=None, verbose=False
+        self,
+        topography_source: dict | None = None,
+        hmin: float | None = None,
+        verbose: bool = False,
     ) -> None:
         """Update the grid dataset with processed topography.
 
-        This method performs several key operations, including regridding the topography, smoothing the
-        topography over the entire domain and locally.
-        The processed topography is then added to the grid's dataset.
+        This method performs the following operations:
+
+        1. Regrids the topography from the specified source.
+        2. Applies domain-wide and local smoothing.
+        3. Enforces the minimum depth constraint ``hmin``.
+        4. Updates the internal dataset (``self.ds``) with the processed bathymetry.
 
         Parameters
         ----------
@@ -236,11 +242,13 @@ class Grid:
         topography_source = topography_source or self.topography_source
         hmin = hmin or self.hmin
 
+        name = topography_source["name"]  # type: ignore[index]
+
         # Extract target coordinates for processing
         target_coords = get_target_coords(self)
 
         with Timed(
-            f"=== Generating the topography using {topography_source['name']} data and hmin = {hmin} meters ===",
+            f"=== Generating the topography using {name} data and hmin = {hmin} meters ===",
             verbose=verbose,
         ):
             ds = add_topography(

roms_tools/setup/initial_conditions.py

@@ -13,15 +13,15 @@ from matplotlib.axes import Axes
 from roms_tools import Grid
 from roms_tools.plot import plot
 from roms_tools.regrid import LateralRegridToROMS, VerticalRegridToROMS
-from roms_tools.setup.datasets import (
+from roms_tools.setup.lat_lon_datasets import (
     CESMBGCDataset,
-    Dataset,
     GLORYSDataset,
     GLORYSDefaultDataset,
-    RawDataSource,
+    LatLonDataset,
     UnifiedBGCDataset,
 )
 from roms_tools.setup.utils import (
+    RawDataSource,
     compute_barotropic_velocity,
     compute_missing_bgc_variables,
     from_yaml,
@@ -326,7 +326,7 @@ class InitialConditions:
                 "Sea surface height will NOT be used to adjust depth coordinates."
             )
 
-    def _get_data(self, forcing_type=Literal["physics", "bgc"]) -> Dataset:
+    def _get_data(self, forcing_type=Literal["physics", "bgc"]) -> LatLonDataset:
         """Determine the correct `Dataset` type and return an instance.
 
         forcing_type : str
@@ -339,7 +339,7 @@ class InitialConditions:
         Dataset
             The `Dataset` instance
         """
-        dataset_map: dict[str, dict[str, dict[str, type[Dataset]]]] = {
+        dataset_map: dict[str, dict[str, dict[str, type[LatLonDataset]]]] = {
             "physics": {
                 "GLORYS": {
                     "external": GLORYSDataset,