Officially change boundary function names to verb names

CROCODILE-CESM · Sep 25, 2024 · eabbc8c · eabbc8c
1 parent 3d5c61c
commit eabbc8c
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 33 deletions.
diff --git a/demos/reanalysis-forced.ipynb b/demos/reanalysis-forced.ipynb
@@ -301,7 +301,7 @@
     "    )    \n",
     "\n",
     "# Set up the four boundary conditions. Remember that in the glorys_path, we have four boundary files names north_unprocessed.nc etc. \n",
-    "expt.rectangular_boundaries(\n",
+    "expt.setup_ocean_state_rectangular_boundaries(\n",
     "        glorys_path,\n",
     "        ocean_varnames,\n",
     "        boundaries = [\"south\", \"north\", \"west\", \"east\"],\n",

diff --git a/regional_mom6/regional_mom6.py b/regional_mom6/regional_mom6.py
@@ -1053,25 +1053,6 @@ def get_glorys_rectangular(
         )
         return
 
-    def rectangular_boundaries(
-        self,
-        raw_boundaries_path,
-        varnames,
-        boundaries=["south", "north", "west", "east"],
-        arakawa_grid="A",
-    ):
-        warnings.filterwarnings("default")  # Set warnings back to on
-        warnings.warn(
-            'The rectangular_boundaries function has been changed in favor of a verb format, more description, and to accomodate tides. Drop-in replace with "setup_ocean_state_rectangular_boundaries"'
-        )
-        warnings.filterwarnings("ignore")  # Set warnings back off
-        return self.setup_ocean_state_rectangular_boundaries(
-            raw_boundaries_path,
-            varnames,
-            boundaries=boundaries,
-            arakawa_grid=arakawa_grid,
-        )
-
     def setup_ocean_state_rectangular_boundaries(
         self,
         raw_boundaries_path,
@@ -1124,18 +1105,6 @@ def setup_ocean_state_rectangular_boundaries(
                 arakawa_grid=arakawa_grid,
             )
 
-    def simple_boundary(
-        self, path_to_bc, varnames, orientation, segment_number, arakawa_grid="A"
-    ):
-        warnings.filterwarnings("default")  # Set warnings back to on
-        warnings.warn(
-            'The simple_boundary function has been changed in favor of a verb format, more description, and to accomodate tides. Drop-in replace with "setup_ocean_state_simple_boundary"'
-        )
-        warnings.filterwarnings("ignore")  # Turn warnings off
-        return self.setup_ocean_state_simple_boundary(
-            path_to_bc, varnames, orientation, segment_number, arakawa_grid="A"
-        )
-
     def setup_ocean_state_simple_boundary(
         self, path_to_bc, varnames, orientation, segment_number, arakawa_grid="A"
     ):

diff --git a/tests/test_expt_class.py b/tests/test_expt_class.py
@@ -470,4 +470,4 @@ def test_rectangular_boundaries(
         "tracers": {"temp": "temp", "salt": "salt"},
     }
 
-    expt.rectangular_boundaries(tmp_path, varnames, ["east"])
+    expt.setup_ocean_state_rectangular_boundaries(tmp_path, varnames, ["east"])