Merge pull request #3560 from samsrabin/ndims-error-in-set_paramfile

set_paramfile: Allow simply setting all of a parameter to a single value

Author: samsrabin

doc/source/users_guide/using-clm-tools/paramfile-tools.md

@@ -57,9 +57,14 @@ Change a one-dimensional parameter (`mimics_fmet` has the `segment` dimension, l
 tools/param_utils/set_paramfile -i paramfile.nc -o output.nc mimics_fmet=0.1,0.2,0.3,0.4
 ```
 
+Change a one-dimensional parameter to be all one value (`mxmat` has the `pft` dimension, length 79):
+```bash
+tools/param_utils/set_paramfile -i paramfile.nc -o output.nc mxmat=360
+```
+
 Change a parameter for specific PFTs:
 ```bash
-tools/param_utils/set_paramfile -i paramfile.nc -o output.nc -p needleleaf_evergreen_temperate_tree,c4_grass medlynintercept=99.9,100.1 medlynslope=2.99,1.99
+tools/param_utils/set_paramfile -i paramfile.nc -o output.nc -p needleleaf_evergreen_temperate_tree,c4_grass medlynintercept=99.9,100.1 medlynslope=2.99,1.99 mxmat=199
 ```
 
 Set a parameter to the fill value:

python/ctsm/param_utils/set_paramfile.py

@@ -130,7 +130,7 @@ def check_correct_ndims(da, new_value, throw_error=False):
     """
     expected = da.ndim
     actual = np.array(new_value).ndim
-    is_ndim_correct = expected == actual
+    is_ndim_correct = actual in (0, expected)  # If actual 0, apply it to all
     if throw_error and not is_ndim_correct:
         raise RuntimeError(f"Incorrect N dims: Expected {expected}, got {actual}")
     return is_ndim_correct
@@ -323,11 +323,12 @@ def apply_new_value_to_parameter(args, ds_out, var, new_value, var_encoding, *,
     # Ensure that any NaNs are replaced with the fill value
     new_value = _replace_nans_with_fill(var_encoding, new_value, chg=chg)
 
-    # This can be needed if, e.g., you're selecting and changing just one PFT
+    # This can be needed if, (a) you're selecting and changing just one PFT or (b) you're changing
+    # all values in a dimensioned parameter to match one value.
     if ds_out[var].values.ndim > 0 and new_value.ndim == 0:
-        new_value = np.atleast_1d(new_value)
-
-    ds_out[var].values = new_value
+        ds_out[var].values[:] = new_value
+    else:
+        ds_out[var].values = new_value
     return ds_out
 
 

python/ctsm/test/test_sys_set_paramfile.py

@@ -121,19 +121,65 @@ def test_set_paramfile_changeparams_scalar_errors_given_list(self):
         with self.assertRaisesRegex(RuntimeError, "Incorrect N dims"):
             sp.main()
 
-    def test_set_paramfile_changeparam_1d_errors_given_scalar(self):
-        """Test that set_paramfile errors if given a scalar for a 1-d parameter"""
+    def test_set_paramfile_changeparam_1d_given_scalar(self):
+        """
+        Test that set_paramfile works correctly if given a scalar for a 1-d parameter. We want it
+        to set all members of the 1d array to the given scalar.
+        """
         output_path = os.path.join(self.tempdir, "output.nc")
         sys.argv = [
             "set_paramfile",
             "-i",
             PARAMFILE,
             "-o",
             output_path,
-            "xl=0.724",
+            "mxmat=1987",
         ]
-        with self.assertRaisesRegex(RuntimeError, "Incorrect N dims"):
-            sp.main()
+        sp.main()
+        self.assertTrue(os.path.exists(output_path))
+        ds_in = open_paramfile(PARAMFILE)
+        ds_out = open_paramfile(output_path)
+
+        for var in ds_in.variables:
+            # Check that all variables/coords are equal except the ones we changed, which should be
+            # set to what we asked
+            if var == "mxmat":
+                self.assertTrue(np.all(ds_out[var].values == 1987))
+            else:
+                self.assertTrue(are_paramfile_dataarrays_identical(ds_in[var], ds_out[var]))
+
+    def test_set_paramfile_changeparam_1d_given_scalar_and_pftlist(self):
+        """
+        Test that set_paramfile works correctly if given a scalar for a 1-d parameter. We want it
+        to set all members of the 1d array to the given scalar. As
+        test_set_paramfile_changeparam_1d_given_scalar, but here we give a pft list.
+        """
+        output_path = os.path.join(self.tempdir, "output.nc")
+        sys.argv = [
+            "set_paramfile",
+            "-i",
+            PARAMFILE,
+            "-o",
+            output_path,
+            "-p",
+            "temperate_corn,irrigated_temperate_corn",
+            "mxmat=1987",
+        ]
+        sp.main()
+        self.assertTrue(os.path.exists(output_path))
+        ds_in = open_paramfile(PARAMFILE)
+        ds_out = open_paramfile(output_path)
+
+        for var in ds_in.variables:
+            # Check that all variables/coords are equal except the ones we changed, which should be
+            # set to what we asked
+            if var == "mxmat":
+                # First, check that they weren't 1987 before
+                self.assertFalse(np.any(ds_in[var].values[17:18] == 1987))
+                # Now check that they are 1987
+                self.assertTrue(np.all(ds_out[var].values[17:18] == 1987))
+            else:
+                self.assertTrue(are_paramfile_dataarrays_identical(ds_in[var], ds_out[var]))
 
     def test_set_paramfile_changeparams_scalar_double(self):
         """Test that set_paramfile can copy to a new file with some scalar double params changed"""

python/ctsm/test/test_unit_set_paramfile.py

@@ -65,14 +65,14 @@ def test_checkcorrectndims_0d_int_np(self):
         self.assertTrue(sp.check_correct_ndims(da, np.int32(1)))
 
     def test_checkcorrectndims_1d_int(self):
-        """Check False when given a standard int for a 0d parameter"""
+        """Check True when given a standard int for a 0d parameter"""
         da = xr.DataArray(data=[1, 2])
-        self.assertFalse(sp.check_correct_ndims(da, 1))
+        self.assertTrue(sp.check_correct_ndims(da, 1))
 
     def test_checkcorrectndims_1d_int_np(self):
-        """Check False when given a numpy int for a 0d parameter"""
+        """Check True when given a numpy int for a 0d parameter"""
         da = xr.DataArray(data=[1, 2])
-        self.assertFalse(sp.check_correct_ndims(da, np.int32(1)))
+        self.assertTrue(sp.check_correct_ndims(da, np.int32(1)))
 
     def test_checkcorrectndims_0d_list(self):
         """Check False when given a list for a 0d parameter"""