roms-tools 1.6.0__py3-none-any.whl → 1.6.1__py3-none-any.whl

roms_tools/_version.py

@@ -1,2 +1,2 @@
 # Do not change! Do not track in version control!
-__version__ = "1.6.0"
+__version__ = "1.6.1"

roms_tools/setup/boundary_forcing.py

@@ -649,7 +649,14 @@ class BoundaryForcing:
         if var_name not in self.ds:
             raise ValueError(f"Variable '{var_name}' is not found in dataset.")
 
-        field = self.ds[var_name].isel(bry_time=time).load()
+        field = self.ds[var_name].isel(bry_time=time)
+
+        if self.use_dask:
+            from dask.diagnostics import ProgressBar
+
+            with ProgressBar():
+                field = field.load()
+
         title = field.long_name
 
         if "s_rho" in field.dims:
@@ -699,24 +706,26 @@ class BoundaryForcing:
             _line_plot(field, title=title)
 
     def save(
-        self, filepath: Union[str, Path], np_eta: int = None, np_xi: int = None
+        self,
+        filepath: Union[str, Path],
+        np_eta: int = None,
+        np_xi: int = None,
+        group: bool = False,
     ) -> None:
-        """Save the boundary forcing fields to netCDF4 files.
-
-        This method saves the dataset by grouping it into subsets based on the data frequency. The subsets are then written
-        to one or more netCDF4 files. The filenames of the output files reflect the temporal coverage of the data.
+        """Save the boundary forcing fields to one or more netCDF4 files.
 
-        There are two modes of saving the dataset:
+        This method saves the dataset either as a single file or as multiple files depending on the partitioning and grouping options.
+        The dataset can be saved in two modes:
 
-          1. **Single File Mode (default)**:
+        1. **Single File Mode (default)**:
+            - If both `np_eta` and `np_xi` are `None`, the entire dataset is saved as a single netCDF4 file.
+            - The file is named based on the `filepath`, with `.nc` automatically appended.
 
-            If both `np_eta` and `np_xi` are `None`, the entire dataset, divided by temporal subsets, is saved as a single netCDF4 file
-            with the base filename specified by `filepath.nc`.
+        2. **Partitioned Mode**:
+            - If either `np_eta` or `np_xi` is specified, the dataset is partitioned into spatial tiles along the `eta` and `xi` axes.
+            - Each tile is saved as a separate netCDF4 file, and filenames are modified with an index (e.g., `"filepath_YYYYMM.0.nc"`, `"filepath_YYYYMM.1.nc"`).
 
-          2. **Partitioned Mode**:
-
-            - If either `np_eta` or `np_xi` is specified, the dataset is divided into spatial tiles along the eta-axis and xi-axis.
-            - Each spatial tile is saved as a separate netCDF4 file.
+        Additionally, if `group` is set to `True`, the dataset is first grouped into temporal subsets, resulting in multiple grouped files before partitioning and saving.
 
         Parameters
         ----------
@@ -728,6 +737,8 @@ class BoundaryForcing:
             The number of partitions along the `eta` direction. If `None`, no spatial partitioning is performed.
         np_xi : int, optional
             The number of partitions along the `xi` direction. If `None`, no spatial partitioning is performed.
+        group: bool, optional
+            If `True`, groups the dataset into multiple files based on temporal data frequency. Defaults to `False`.
 
         Returns
         -------
@@ -742,7 +753,18 @@ class BoundaryForcing:
         if filepath.suffix == ".nc":
             filepath = filepath.with_suffix("")
 
-        dataset_list, output_filenames = group_dataset(self.ds.load(), str(filepath))
+        if self.use_dask:
+            from dask.diagnostics import ProgressBar
+
+            with ProgressBar():
+                self.ds.load()
+
+        if group:
+            dataset_list, output_filenames = group_dataset(self.ds, str(filepath))
+        else:
+            dataset_list = [self.ds]
+            output_filenames = [str(filepath)]
+
         saved_filenames = save_datasets(
             dataset_list, output_filenames, np_eta=np_eta, np_xi=np_xi
         )
@@ -796,7 +818,7 @@ class BoundaryForcing:
             # Write header
             file.write(header)
             # Write YAML data
-            yaml.dump(yaml_data, file, default_flow_style=False)
+            yaml.dump(yaml_data, file, default_flow_style=False, sort_keys=False)
 
     @classmethod
     def from_yaml(

roms_tools/setup/grid.py

@@ -679,7 +679,7 @@ class Grid:
             # Write header
             file.write(header)
             # Write YAML data
-            yaml.dump(yaml_data, file, default_flow_style=False)
+            yaml.dump(yaml_data, file, default_flow_style=False, sort_keys=False)
 
     @classmethod
     def from_yaml(cls, filepath: Union[str, Path]) -> "Grid":

roms_tools/setup/initial_conditions.py

@@ -518,7 +518,12 @@ class InitialConditions:
         ):
             raise ValueError("For 2D fields, specify either eta or xi, not both.")
 
-        self.ds[var_name].load()
+        if self.use_dask:
+            from dask.diagnostics import ProgressBar
+
+            with ProgressBar():
+                self.ds[var_name].load()
+
         field = self.ds[var_name].squeeze()
 
         if all(dim in field.dims for dim in ["eta_rho", "xi_rho"]):
@@ -681,7 +686,13 @@ class InitialConditions:
         if filepath.suffix == ".nc":
             filepath = filepath.with_suffix("")
 
-        dataset_list = [self.ds.load()]
+        if self.use_dask:
+            from dask.diagnostics import ProgressBar
+
+            with ProgressBar():
+                self.ds.load()
+
+        dataset_list = [self.ds]
         output_filenames = [str(filepath)]
 
         saved_filenames = save_datasets(
@@ -719,15 +730,18 @@ class InitialConditions:
 
         initial_conditions_data = {
             "InitialConditions": {
-                "source": self.source,
                 "ini_time": self.ini_time.isoformat(),
-                "model_reference_date": self.model_reference_date.isoformat(),
+                "source": self.source,
             }
         }
         # Include bgc_source if it's not None
         if self.bgc_source is not None:
             initial_conditions_data["InitialConditions"]["bgc_source"] = self.bgc_source
 
+        initial_conditions_data["InitialConditions"][
+            "model_reference_date"
+        ] = self.model_reference_date.isoformat()
+
         yaml_data = {
             **grid_yaml_data,
             **initial_conditions_data,
@@ -737,7 +751,7 @@ class InitialConditions:
             # Write header
             file.write(header)
             # Write YAML data
-            yaml.dump(yaml_data, file, default_flow_style=False)
+            yaml.dump(yaml_data, file, default_flow_style=False, sort_keys=False)
 
     @classmethod
     def from_yaml(

roms_tools/setup/surface_forcing.py

@@ -462,7 +462,13 @@ class SurfaceForcing:
         if var_name not in self.ds:
             raise ValueError(f"Variable '{var_name}' is not found in dataset.")
 
-        field = self.ds[var_name].isel(time=time).load()
+        field = self.ds[var_name].isel(time=time)
+        if self.use_dask:
+            from dask.diagnostics import ProgressBar
+
+            with ProgressBar():
+                field = field.load()
+
         title = field.long_name
 
         # assign lat / lon
@@ -502,24 +508,26 @@ class SurfaceForcing:
         )
 
     def save(
-        self, filepath: Union[str, Path], np_eta: int = None, np_xi: int = None
+        self,
+        filepath: Union[str, Path],
+        np_eta: int = None,
+        np_xi: int = None,
+        group: bool = False,
     ) -> None:
-        """Save the surface forcing fields to netCDF4 files.
-
-        This method saves the dataset by grouping it into subsets based on the data frequency. The subsets are then written
-        to one or more netCDF4 files. The filenames of the output files reflect the temporal coverage of the data.
-
-        There are two modes of saving the dataset:
+        """Save the surface forcing fields to one or more netCDF4 files.
 
-          1. **Single File Mode (default)**:
+        This method saves the dataset either as a single file or as multiple files depending on the partitioning and grouping options.
+        The dataset can be saved in two modes:
 
-            If both `np_eta` and `np_xi` are `None`, the entire dataset, divided by temporal subsets, is saved as a single netCDF4 file
-            with the base filename specified by `filepath.nc`.
+        1. **Single File Mode (default)**:
+            - If both `np_eta` and `np_xi` are `None`, the entire dataset is saved as a single netCDF4 file.
+            - The file is named based on the `filepath`, with `.nc` automatically appended.
 
-          2. **Partitioned Mode**:
+        2. **Partitioned Mode**:
+            - If either `np_eta` or `np_xi` is specified, the dataset is partitioned into spatial tiles along the `eta` and `xi` axes.
+            - Each tile is saved as a separate netCDF4 file, and filenames are modified with an index (e.g., `"filepath_YYYYMM.0.nc"`, `"filepath_YYYYMM.1.nc"`).
 
-            - If either `np_eta` or `np_xi` is specified, the dataset is divided into spatial tiles along the eta-axis and xi-axis.
-            - Each spatial tile is saved as a separate netCDF4 file.
+        Additionally, if `group` is set to `True`, the dataset is first grouped into temporal subsets, resulting in multiple grouped files before partitioning and saving.
 
         Parameters
         ----------
@@ -531,6 +539,8 @@ class SurfaceForcing:
             The number of partitions along the `eta` direction. If `None`, no spatial partitioning is performed.
         np_xi : int, optional
             The number of partitions along the `xi` direction. If `None`, no spatial partitioning is performed.
+        group: bool, optional
+            If `True`, groups the dataset into multiple files based on temporal data frequency. Defaults to `False`.
 
         Returns
         -------
@@ -545,7 +555,18 @@ class SurfaceForcing:
         if filepath.suffix == ".nc":
             filepath = filepath.with_suffix("")
 
-        dataset_list, output_filenames = group_dataset(self.ds.load(), str(filepath))
+        if self.use_dask:
+            from dask.diagnostics import ProgressBar
+
+            with ProgressBar():
+                self.ds.load()
+
+        if group:
+            dataset_list, output_filenames = group_dataset(self.ds, str(filepath))
+        else:
+            dataset_list = [self.ds]
+            output_filenames = [str(filepath)]
+
         saved_filenames = save_datasets(
             dataset_list, output_filenames, np_eta=np_eta, np_xi=np_xi
         )
@@ -603,7 +624,7 @@ class SurfaceForcing:
             # Write header
             file.write(header)
             # Write YAML data
-            yaml.dump(yaml_data, file, default_flow_style=False)
+            yaml.dump(yaml_data, file, default_flow_style=False, sort_keys=False)
 
     @classmethod
     def from_yaml(

roms_tools/setup/tides.py

@@ -300,7 +300,14 @@ class TidalForcing:
         >>> tidal_forcing.plot("ssh_Re", nc=0)
         """
 
-        field = self.ds[var_name].isel(ntides=ntides).compute()
+        field = self.ds[var_name].isel(ntides=ntides)
+
+        if self.use_dask:
+            from dask.diagnostics import ProgressBar
+
+            with ProgressBar():
+                field = field.load()
+
         if all(dim in field.dims for dim in ["eta_rho", "xi_rho"]):
             field = field.where(self.grid.ds.mask_rho)
             field = field.assign_coords(
@@ -378,7 +385,13 @@ class TidalForcing:
         if filepath.suffix == ".nc":
             filepath = filepath.with_suffix("")
 
-        dataset_list = [self.ds.load()]
+        if self.use_dask:
+            from dask.diagnostics import ProgressBar
+
+            with ProgressBar():
+                self.ds.load()
+
+        dataset_list = [self.ds]
         output_filenames = [str(filepath)]
 
         saved_filenames = save_datasets(
@@ -419,8 +432,8 @@ class TidalForcing:
             "TidalForcing": {
                 "source": self.source,
                 "ntides": self.ntides,
-                "model_reference_date": self.model_reference_date.isoformat(),
                 "allan_factor": self.allan_factor,
+                "model_reference_date": self.model_reference_date.isoformat(),
             }
         }
 
@@ -431,7 +444,7 @@ class TidalForcing:
             # Write header
             file.write(header)
             # Write YAML data
-            yaml.dump(yaml_data, file, default_flow_style=False)
+            yaml.dump(yaml_data, file, default_flow_style=False, sort_keys=False)
 
     @classmethod
     def from_yaml(

roms_tools/tests/test_setup/test_boundary_forcing.py

@@ -85,8 +85,8 @@ def test_boundary_forcing_creation_with_bgc(boundary_forcing_fixture, request):
     assert hasattr(boundary_forcing.ds, "climatology")
 
 
-def test_boundary_forcing_plot_save(boundary_forcing, tmp_path):
-    """Test plot and save methods."""
+def test_boundary_forcing_plot(boundary_forcing):
+    """Test plot."""
 
     boundary_forcing.plot(var_name="temp_south", layer_contours=True)
     boundary_forcing.plot(var_name="temp_east", layer_contours=True)
@@ -99,6 +99,10 @@ def test_boundary_forcing_plot_save(boundary_forcing, tmp_path):
     boundary_forcing.plot(var_name="vbar_north")
     boundary_forcing.plot(var_name="ubar_west")
 
+
+def test_boundary_forcing_save(boundary_forcing, tmp_path):
+    """Test save method."""
+
     for file_str in ["test_bf", "test_bf.nc"]:
         # Create a temporary filepath using the tmp_path fixture
         for filepath in [
@@ -106,9 +110,19 @@ def test_boundary_forcing_plot_save(boundary_forcing, tmp_path):
             str(tmp_path / file_str),
         ]:  # test for Path object and str
 
-            # Test saving without partitioning
+            # Test saving without partitioning and grouping
             saved_filenames = boundary_forcing.save(filepath)
 
+            filepath_str = str(Path(filepath).with_suffix(""))
+            expected_filepath = Path(f"{filepath_str}.nc")
+
+            assert saved_filenames == [expected_filepath]
+            assert expected_filepath.exists()
+            expected_filepath.unlink()
+
+            # Test saving without partitioning but with grouping
+            saved_filenames = boundary_forcing.save(filepath, group=True)
+
             filepath_str = str(Path(filepath).with_suffix(""))
             expected_filepath = Path(f"{filepath_str}_202106.nc")
 
@@ -116,8 +130,8 @@ def test_boundary_forcing_plot_save(boundary_forcing, tmp_path):
             assert expected_filepath.exists()
             expected_filepath.unlink()
 
-            # Test saving with partitioning
-            saved_filenames = boundary_forcing.save(filepath, np_eta=2)
+            # Test saving with partitioning and grouping
+            saved_filenames = boundary_forcing.save(filepath, np_eta=2, group=True)
             expected_filepath_list = [
                 Path(filepath_str + f"_202106.{index}.nc") for index in range(2)
             ]
@@ -129,16 +143,18 @@ def test_boundary_forcing_plot_save(boundary_forcing, tmp_path):
                 expected_filepath.unlink()
 
 
-def test_bgc_boundary_forcing_plot_save(
-    bgc_boundary_forcing_from_climatology, tmp_path
-):
-    """Test plot and save methods."""
+def test_bgc_boundary_forcing_plot(bgc_boundary_forcing_from_climatology):
+    """Test plot method."""
 
     bgc_boundary_forcing_from_climatology.plot(var_name="ALK_south")
     bgc_boundary_forcing_from_climatology.plot(var_name="ALK_east")
     bgc_boundary_forcing_from_climatology.plot(var_name="ALK_north")
     bgc_boundary_forcing_from_climatology.plot(var_name="ALK_west")
 
+
+def test_bgc_boundary_forcing_save(bgc_boundary_forcing_from_climatology, tmp_path):
+    """Test save method."""
+
     for file_str in ["test_bf", "test_bf.nc"]:
         # Create a temporary filepath using the tmp_path fixture
         for filepath in [
@@ -146,9 +162,20 @@ def test_bgc_boundary_forcing_plot_save(
             str(tmp_path / file_str),
         ]:  # test for Path object and str
 
-            # Test saving without partitioning
+            # Test saving without partitioning and grouping
             saved_filenames = bgc_boundary_forcing_from_climatology.save(filepath)
 
+            filepath_str = str(Path(filepath).with_suffix(""))
+            expected_filepath = Path(f"{filepath_str}.nc")
+            assert saved_filenames == [expected_filepath]
+            assert expected_filepath.exists()
+            expected_filepath.unlink()
+
+            # Test saving without partitioning but with grouping
+            saved_filenames = bgc_boundary_forcing_from_climatology.save(
+                filepath, group=True
+            )
+
             filepath_str = str(Path(filepath).with_suffix(""))
             expected_filepath = Path(f"{filepath_str}_clim.nc")
             assert saved_filenames == [expected_filepath]
@@ -157,7 +184,7 @@ def test_bgc_boundary_forcing_plot_save(
 
             # Test saving with partitioning
             saved_filenames = bgc_boundary_forcing_from_climatology.save(
-                filepath, np_xi=2
+                filepath, np_xi=2, group=True
             )
 
             expected_filepath_list = [
@@ -207,9 +234,9 @@ def test_files_have_same_hash(boundary_forcing, tmp_path, use_dask):
     filepath2 = tmp_path / "test2.nc"
 
     boundary_forcing.to_yaml(yaml_filepath)
-    boundary_forcing.save(filepath1)
+    boundary_forcing.save(filepath1, group=True)
     bdry_forcing_from_file = BoundaryForcing.from_yaml(yaml_filepath, use_dask=use_dask)
-    bdry_forcing_from_file.save(filepath2)
+    bdry_forcing_from_file.save(filepath2, group=True)
 
     filepath_str1 = str(Path(filepath1).with_suffix(""))
     filepath_str2 = str(Path(filepath2).with_suffix(""))
@@ -235,9 +262,9 @@ def test_files_have_same_hash_clim(
     filepath2 = tmp_path / "test2.nc"
 
     bgc_boundary_forcing_from_climatology.to_yaml(yaml_filepath)
-    bgc_boundary_forcing_from_climatology.save(filepath1)
+    bgc_boundary_forcing_from_climatology.save(filepath1, group=True)
     bdry_forcing_from_file = BoundaryForcing.from_yaml(yaml_filepath, use_dask=use_dask)
-    bdry_forcing_from_file.save(filepath2)
+    bdry_forcing_from_file.save(filepath2, group=True)
 
     filepath_str1 = str(Path(filepath1).with_suffix(""))
     filepath_str2 = str(Path(filepath2).with_suffix(""))

roms_tools/tests/test_setup/test_initial_conditions.py

@@ -176,10 +176,8 @@ def test_interpolation_from_climatology(
     )
 
 
-def test_initial_conditions_plot_save(
-    initial_conditions_with_bgc_from_climatology, tmp_path
-):
-    """Test plot and save methods."""
+def test_initial_conditions_plot(initial_conditions_with_bgc_from_climatology):
+    """Test plot method."""
 
     initial_conditions_with_bgc_from_climatology.plot(var_name="temp", s=0)
     initial_conditions_with_bgc_from_climatology.plot(
@@ -213,6 +211,12 @@ def test_initial_conditions_plot_save(
     initial_conditions_with_bgc_from_climatology.plot(var_name="ALK", s=0, xi=0)
     initial_conditions_with_bgc_from_climatology.plot(var_name="ALK", eta=0, xi=0)
 
+
+def test_initial_conditions_save(
+    initial_conditions_with_bgc_from_climatology, tmp_path
+):
+    """Test save method."""
+
     for file_str in ["test_ic", "test_ic.nc"]:
         # Create a temporary filepath using the tmp_path fixture
         for filepath in [

roms_tools/tests/test_setup/test_surface_forcing.py

@@ -187,12 +187,6 @@ def grid_that_straddles_180_degree_meridian():
 def test_successful_initialization_with_regional_data(grid_fixture, request, use_dask):
     """Test the initialization of SurfaceForcing with regional ERA5 data.
 
-    This test checks the following:
-    1. SurfaceForcing object initializes successfully with provided regional data.
-    2. Attributes such as `start_time`, `end_time`, and `source` are set correctly.
-    3. The dataset contains expected variables, including "uwnd", "vwnd", "swrad", "lwrad", "Tair", "qair", and "rain".
-    4. Surface forcing plots for "uwnd", "vwnd", and "rain" are generated without errors.
-
     The test is performed twice:
     - First with the default fine grid.
     - Then with the coarse grid enabled.
@@ -513,8 +507,8 @@ def test_surface_forcing_pco2_replication(sfc_forcing_fixture, request):
         "coarse_surface_forcing",
     ],
 )
-def test_surface_forcing_plot_save(sfc_forcing_fixture, request, tmp_path):
-    """Test plot and save methods."""
+def test_surface_forcing_save(sfc_forcing_fixture, request, tmp_path):
+    """Test save method."""
     sfc_forcing = request.getfixturevalue(sfc_forcing_fixture)
     sfc_forcing.plot(var_name="uwnd", time=0)
 
@@ -525,16 +519,24 @@ def test_surface_forcing_plot_save(sfc_forcing_fixture, request, tmp_path):
             str(tmp_path / file_str),
         ]:  # test for Path object and str
 
-            # Test saving without partitioning
+            # Test saving without partitioning and grouping
             saved_filenames = sfc_forcing.save(filepath)
             filepath_str = str(Path(filepath).with_suffix(""))
+            expected_filepath = Path(f"{filepath_str}.nc")
+            assert saved_filenames == [expected_filepath]
+            assert expected_filepath.exists()
+            expected_filepath.unlink()
+
+            # Test saving without partitioning but with grouping
+            saved_filenames = sfc_forcing.save(filepath, group=True)
+            filepath_str = str(Path(filepath).with_suffix(""))
             expected_filepath = Path(f"{filepath_str}_202002.nc")
             assert saved_filenames == [expected_filepath]
             assert expected_filepath.exists()
             expected_filepath.unlink()
 
             # Test saving with partitioning
-            saved_filenames = sfc_forcing.save(filepath, np_eta=1)
+            saved_filenames = sfc_forcing.save(filepath, np_eta=1, group=True)
 
             expected_filepath_list = [
                 Path(filepath_str + f"_202002.{index}.nc") for index in range(1)
@@ -545,12 +547,15 @@ def test_surface_forcing_plot_save(sfc_forcing_fixture, request, tmp_path):
                 expected_filepath.unlink()
 
 
-def test_surface_forcing_bgc_plot_save(bgc_surface_forcing, tmp_path):
-    """Test plot and save methods."""
+def test_surface_forcing_bgc_plot(bgc_surface_forcing):
+    """Test plot method."""
 
-    # Check the values in the dataset
     bgc_surface_forcing.plot(var_name="pco2_air", time=0)
 
+
+def test_surface_forcing_bgc_save(bgc_surface_forcing, tmp_path):
+    """Test save method."""
+
     for file_str in ["test_sf", "test_sf.nc"]:
         # Create a temporary filepath using the tmp_path fixture
         for filepath in [
@@ -558,16 +563,24 @@ def test_surface_forcing_bgc_plot_save(bgc_surface_forcing, tmp_path):
             str(tmp_path / file_str),
         ]:  # test for Path object and str
 
-            # Test saving without partitioning
+            # Test saving without partitioning and grouping
             saved_filenames = bgc_surface_forcing.save(filepath)
             filepath_str = str(Path(filepath).with_suffix(""))
+            expected_filepath = Path(f"{filepath_str}.nc")
+            assert saved_filenames == [expected_filepath]
+            assert expected_filepath.exists()
+            expected_filepath.unlink()
+
+            # Test saving without partitioning but with grouping
+            saved_filenames = bgc_surface_forcing.save(filepath, group=True)
+            filepath_str = str(Path(filepath).with_suffix(""))
             expected_filepath = Path(f"{filepath_str}_202002.nc")
             assert saved_filenames == [expected_filepath]
             assert expected_filepath.exists()
             expected_filepath.unlink()
 
             # Test saving with partitioning
-            saved_filenames = bgc_surface_forcing.save(filepath, np_xi=5)
+            saved_filenames = bgc_surface_forcing.save(filepath, np_xi=5, group=True)
 
             expected_filepath_list = [
                 Path(filepath_str + f"_202002.{index}.nc") for index in range(5)
@@ -578,13 +591,10 @@ def test_surface_forcing_bgc_plot_save(bgc_surface_forcing, tmp_path):
                 expected_filepath.unlink()
 
 
-def test_surface_forcing_bgc_from_clim_plot_save(
+def test_surface_forcing_bgc_from_clim_save(
     bgc_surface_forcing_from_climatology, tmp_path
 ):
-    """Test plot and save methods."""
-
-    # Check the values in the dataset
-    bgc_surface_forcing_from_climatology.plot(var_name="pco2_air", time=0)
+    """Test save method."""
 
     for file_str in ["test_sf", "test_sf.nc"]:
         # Create a temporary filepath using the tmp_path fixture
@@ -593,17 +603,27 @@ def test_surface_forcing_bgc_from_clim_plot_save(
             str(tmp_path / file_str),
         ]:  # test for Path object and str
 
-            # Test saving without partitioning
+            # Test saving without partitioning and grouping
             saved_filenames = bgc_surface_forcing_from_climatology.save(filepath)
             filepath_str = str(Path(filepath).with_suffix(""))
+            expected_filepath = Path(f"{filepath_str}.nc")
+            assert saved_filenames == [expected_filepath]
+            assert expected_filepath.exists()
+            expected_filepath.unlink()
+
+            # Test saving without partitioning but with grouping
+            saved_filenames = bgc_surface_forcing_from_climatology.save(
+                filepath, group=True
+            )
+            filepath_str = str(Path(filepath).with_suffix(""))
             expected_filepath = Path(f"{filepath_str}_clim.nc")
             assert saved_filenames == [expected_filepath]
             assert expected_filepath.exists()
             expected_filepath.unlink()
 
-            # Test saving with partitioning
+            # Test saving with partitioning and grouping
             saved_filenames = bgc_surface_forcing_from_climatology.save(
-                filepath, np_eta=5
+                filepath, np_eta=5, group=True
             )
 
             expected_filepath_list = [
@@ -666,9 +686,9 @@ def test_files_have_same_hash(sfc_forcing_fixture, request, tmp_path, use_dask):
     filepath2 = tmp_path / "test2.nc"
 
     sfc_forcing.to_yaml(yaml_filepath)
-    sfc_forcing.save(filepath1)
+    sfc_forcing.save(filepath1, group=True)
     sfc_forcing_from_file = SurfaceForcing.from_yaml(yaml_filepath, use_dask=use_dask)
-    sfc_forcing_from_file.save(filepath2)
+    sfc_forcing_from_file.save(filepath2, group=True)
 
     filepath_str1 = str(Path(filepath1).with_suffix(""))
     filepath_str2 = str(Path(filepath2).with_suffix(""))
@@ -694,9 +714,9 @@ def test_files_have_same_hash_clim(
     filepath2 = tmp_path / "test2.nc"
 
     bgc_surface_forcing_from_climatology.to_yaml(yaml_filepath)
-    bgc_surface_forcing_from_climatology.save(filepath1)
+    bgc_surface_forcing_from_climatology.save(filepath1, group=True)
     sfc_forcing_from_file = SurfaceForcing.from_yaml(yaml_filepath, use_dask=use_dask)
-    sfc_forcing_from_file.save(filepath2)
+    sfc_forcing_from_file.save(filepath2, group=True)
 
     filepath_str1 = str(Path(filepath1).with_suffix(""))
     filepath_str2 = str(Path(filepath2).with_suffix(""))

roms_tools/tests/test_setup/test_tides.py

@@ -169,13 +169,15 @@ def test_insufficient_number_of_consituents(grid_that_straddles_dateline, use_da
         )
 
 
-def test_tidal_forcing_plot_save(tidal_forcing, tmp_path):
-    """Test plot and save methods in the same test since we dask arrays are already
-    computed."""
-    tidal_forcing.ds.load()
+def test_tidal_forcing_plot(tidal_forcing):
+    """Test plot method."""
 
     tidal_forcing.plot(var_name="ssh_Re", ntides=0)
 
+
+def test_tidal_forcing_save(tidal_forcing, tmp_path):
+    """Test save method."""
+
     for file_str in ["test_tides", "test_tides.nc"]:
         # Create a temporary filepath using the tmp_path fixture
         for filepath in [

{roms_tools-1.6.0.dist-info → roms_tools-1.6.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: roms-tools
-Version: 1.6.0
+Version: 1.6.1
 Summary: Tools for running and analysing UCLA-ROMS simulations
 Author-email: Nora Loose <nora.loose@gmail.com>, Thomas Nicholas <tom@cworthy.org>
 License: Apache-2
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE

{roms_tools-1.6.0.dist-info → roms_tools-1.6.1.dist-info}/RECORD

@@ -1,32 +1,32 @@
 ci/environment.yml,sha256=2daWGcAMUMMuc4tNZ9BMivFIE6lh3Vz5ggPykhQPHio,191
 roms_tools/__init__.py,sha256=PQ7jWQ97DYS5b6YIFZVE2PYaRwXjN0Ykfhq0PKqN9ME,560
-roms_tools/_version.py,sha256=19-IoPJ1y0nMwmoLYAcRjMxXDRU1ZkTpc3XEXl66lNI,72
+roms_tools/_version.py,sha256=R0F125tMbDXigLRrvuXWTAoA4KLSeQY0vbgGyoN8FRk,72
 roms_tools/utils.py,sha256=hlopIyqN-TLnglOvEPQm5H4EkUdV1QjL9CIu0v45d8E,12105
 roms_tools/setup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-roms_tools/setup/boundary_forcing.py,sha256=FX1O3MMy2E2DjISQ40RWssWcdQVPr6afJTchpUQ80Eo,36967
+roms_tools/setup/boundary_forcing.py,sha256=SM6mOb48mhCsJzcT0ibdMH1HTn7RpwyNwKg3HA3TPrE,37754
 roms_tools/setup/datasets.py,sha256=xtphonHTFGo1WqrqkxxP97iLYErVrzcfcDE_Vm-hfe4,58560
 roms_tools/setup/download.py,sha256=JD48Xi5VT4oEBaBSCoGd08g46MVMl3_UW1KowSQI6ak,5102
 roms_tools/setup/fill.py,sha256=YQes_9uADZ-XZ6dBqXyvG7OAp7UrWhX-p3pR1gD6Od4,11120
-roms_tools/setup/grid.py,sha256=B0eKhLUT1LH25AesGlBfkLAR71khNvUJrGsUHGDMfws,45074
-roms_tools/setup/initial_conditions.py,sha256=zowJCh3a_9SHjRthj-lG5yUY2G-0whee5AVfahPCaWw,30639
+roms_tools/setup/grid.py,sha256=IWzGwbWQlA3xugo-uc8jxoMXv9BLKrg7HKlpUUM9Ejg,45091
+roms_tools/setup/initial_conditions.py,sha256=9pDuELgxOaGcEbERAjwECiivWDoffdND5EV7TjMRIds,30975
 roms_tools/setup/plot.py,sha256=g7jezPGQr8lPkIG9dCQwKqdEStFNu5k8Wz2afl-UNZQ,4856
 roms_tools/setup/regrid.py,sha256=moJWjqz5QCEYHYPgzfwtmDif39KUf2wGstTlV9BxUHU,5096
-roms_tools/setup/surface_forcing.py,sha256=I4naXwlQi5L661jRnwH57Oc8reoZDgvUhPlQjyA5xX0,23713
-roms_tools/setup/tides.py,sha256=1ZrGO0TUoPLxbHnF8Dan-gO_0ATijuKJVkDBUttiUR0,28652
+roms_tools/setup/surface_forcing.py,sha256=0qb1-DtnO-CeEbCAbo88RBCNgKDs8HOuxHkRYIf8U3M,24499
+roms_tools/setup/tides.py,sha256=DiLeBAQxRlUJNYUUyzUMxbHgMG-NOjzQ7coAlnuGqYI,28947
 roms_tools/setup/topography.py,sha256=E_gDNbMxbVn08fCCVL0eRfiWFXaq8UTknONrCIC5hX8,10348
 roms_tools/setup/utils.py,sha256=nJ9H9NWiacEyt1m76F1LAsFlvygXx2aEzzfwCs81ZXc,32651
 roms_tools/setup/vertical_coordinate.py,sha256=6Y6a1ouIZjorawzTFlJqZKQInoWQtvxQXXCI9iRZfKE,3023
 roms_tools/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 roms_tools/tests/test_utils.py,sha256=X16UHYzd8KmUgxBHJqmVP6cIHfOtScCdXPw905bgGMk,7966
 roms_tools/tests/test_setup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-roms_tools/tests/test_setup/test_boundary_forcing.py,sha256=DLCiGzSItMIr_xlJCJlYHd_7Rg5mb4zGrOnE-Y_WUNk,10307
+roms_tools/tests/test_setup/test_boundary_forcing.py,sha256=B0GJHL30mIeq6q_0wSWb04GOojyoOIMnNoDNZBBuRZE,11424
 roms_tools/tests/test_setup/test_datasets.py,sha256=cFGtPdPIAMZlYEX1f_97KLiUJd8aAs6Cv29z6wctQPY,16267
 roms_tools/tests/test_setup/test_fill.py,sha256=gDHuM58d3ECQE317ZntChYt4hWCfo4eVhkW13NiZ1V4,3735
 roms_tools/tests/test_setup/test_grid.py,sha256=xaZcu0rM1hKOU93NcaBMX5gL8WqfTNvVhrX00h2IHjA,12177
-roms_tools/tests/test_setup/test_initial_conditions.py,sha256=tPKSKYAkGrK5Ypc57bBg8MxZzDHKNJShAC_DzR9RxEk,11095
+roms_tools/tests/test_setup/test_initial_conditions.py,sha256=qjG7R6QwsisokqUGVEaWdSkmjoz4Vdc7uiqNHgLpIHw,11190
 roms_tools/tests/test_setup/test_regrid.py,sha256=NMzMkPHaFfO_9H0SbIpFL3VHlzhd71gUVLu81QmU-bs,1891
-roms_tools/tests/test_setup/test_surface_forcing.py,sha256=IH3q-v1DS39M8vjJrLQAa5pCll46RRhxLMbYASTk3lg,24493
-roms_tools/tests/test_setup/test_tides.py,sha256=p41hM6qU_UMXA2kgpawcjk8U5ShLerX05vmVwoiItCM,8604
+roms_tools/tests/test_setup/test_surface_forcing.py,sha256=rRe0QqIfi7ffHbNSy-yR_gDE4c6Z8qfV5DD3sI49Di4,25367
+roms_tools/tests/test_setup/test_tides.py,sha256=sLtImkSjZl9TFcOFnFdRSZKbG4-qzqIh-xo3G3_aCkI,8572
 roms_tools/tests/test_setup/test_topography.py,sha256=le0_yDCIOcbpfB4wWpAWEZC9okhJQufNcZvowYaWdM4,2581
 roms_tools/tests/test_setup/test_utils.py,sha256=lVeeiEEk_nR0zdmAdRHMlkBUNrAZMiZFrHaLQNy_lPE,585
 roms_tools/tests/test_setup/test_validation.py,sha256=RVSOgv2C6v-H7UtJA5zSsRUL8UnKjVIzjQ2gC8235Ds,2146
@@ -1018,8 +1018,8 @@ roms_tools/tests/test_setup/test_data/tidal_forcing.zarr/v_Im/0.0.0,sha256=60jWZ
 roms_tools/tests/test_setup/test_data/tidal_forcing.zarr/v_Re/.zarray,sha256=2P8kKjSgdw5-3udU-vGJ3bzhNuRn7fZmWN811qBJn34,357
 roms_tools/tests/test_setup/test_data/tidal_forcing.zarr/v_Re/.zattrs,sha256=2z7WUPvCT9VfFs8VCBltFHLWgaGj1jcw3yZ4n0viLRg,197
 roms_tools/tests/test_setup/test_data/tidal_forcing.zarr/v_Re/0.0.0,sha256=33Gl8otBmgqVarmAnZuEqTYS2_hVJUJh-iN1HzvaDuo,96
-roms_tools-1.6.0.dist-info/LICENSE,sha256=CV14VH8hnprGy6SN5GqFIxNNxt5V9D2ev_kBUW6lsBE,11313
-roms_tools-1.6.0.dist-info/METADATA,sha256=9EXxmH9O3aEDEK330t0QG77KM2OLKxTFu0PxnRTi114,4030
-roms_tools-1.6.0.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-roms_tools-1.6.0.dist-info/top_level.txt,sha256=aAf4T4nYQSkay5iKJ9kmTjlDgd4ETdp9OSlB4sJdt8Y,19
-roms_tools-1.6.0.dist-info/RECORD,,
+roms_tools-1.6.1.dist-info/LICENSE,sha256=CV14VH8hnprGy6SN5GqFIxNNxt5V9D2ev_kBUW6lsBE,11313
+roms_tools-1.6.1.dist-info/METADATA,sha256=xd6a1V-bxvYo8EZT_mF9kowZK5K1FMhgrQfLT_W_XFc,4081
+roms_tools-1.6.1.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+roms_tools-1.6.1.dist-info/top_level.txt,sha256=aAf4T4nYQSkay5iKJ9kmTjlDgd4ETdp9OSlB4sJdt8Y,19
+roms_tools-1.6.1.dist-info/RECORD,,