b4b-dev: Python scripts: Require user to specify lon format when ambiguous

.git-blame-ignore-revs

@@ -60,3 +60,4 @@ cf433215b58ba8776ec5edfb0b0d80c0836ed3a0
 16d57ff37859b34dab005693e3085d64e2bcd95a
 e8fc526e0d7818d45f171488c78392c4ff63902a
 cdf40d265cc82775607a1bf25f5f527bacc97405
+251e389b361ba673b508e07d04ddcc06b2681989

python/ctsm/args_utils.py

@@ -7,8 +7,6 @@
 import logging
 import argparse
 
-from ctsm.config_utils import lon_range_0_to_360
-
 logger = logging.getLogger(__name__)
 
 
@@ -34,9 +32,7 @@ def plat_type(plat):
 def plon_type(plon):
     """
     Function to define lon type for the parser and
-    convert negative longitudes to 0-360 and
     raise error if lon is not between -180 and 360.
-
     Args:
         plon (str): longitude
     Raises:
@@ -49,5 +45,4 @@ def plon_type(plon):
         raise argparse.ArgumentTypeError(
             "ERROR: Longitude should be between 0 and 360 or -180 and 180."
         )
-    plon_out = lon_range_0_to_360(plon_float)
-    return plon_out
+    return plon_float

python/ctsm/config_utils.py

@@ -18,26 +18,57 @@
 _CONFIG_UNSET = "UNSET"
 
 
-def lon_range_0_to_360(lon_in):
+def convert_lon_0to360(lon_in):
     """
     Description
     -----------
-    Restrict longitude to 0 to 360 when given as -180 to 180.
+    Convert a longitude from [-180, 180] format (i.e., centered around Prime Meridian) to [0, 360]
+    format (i.e., centered around International Date Line).
     """
-    if -180 <= lon_in < 0:
-        raise NotImplementedError(
-            "A negative longitude suggests you input longitudes in the range [-180, 0)---"
-            "i.e., centered around the Prime Meridian. This code requires longitudes in the "
-            "range [0, 360)---i.e., starting at the International Date Line."
-        )
-    if not (0 <= lon_in <= 360 or lon_in is None):
-        errmsg = "lon_in needs to be in the range 0 to 360"
-        abort(errmsg)
-    lon_out = lon_in
+    if not -180 <= lon_in <= 180:
+        raise ValueError(f"lon_in needs to be in the range [-180, 180]: {lon_in}")
+    lon_out = lon_in % 360
+    logger.info(
+        "Converting longitude from [-180, 180] to [0, 360]: %s to %s",
+        str(lon_in),
+        str(lon_out),
+    )
 
     return lon_out
 
 
+def convert_lons_if_needed(lon_1, lon_2, lon_type):
+    """
+    Description
+    -----------
+    Given two longitudes, if their type is 180 (i.e., between -180 and 180), convert them to 0-360
+    """
+    if lon_type == 180:
+        lon_1 = convert_lon_0to360(lon_1)
+        lon_2 = convert_lon_0to360(lon_2)
+    elif lon_type != 360:
+        raise ValueError(f"lon_type must be either 180 or 360, not {lon_type}")
+    return lon_1, lon_2
+
+
+def check_lon1_lt_lon2(lon1, lon2, lon_type):
+    """
+    Description
+    -----------
+    Given two longitudes, check that lon1 is < lon2. Useful for avoiding CTSM Issue #2017, but note
+    that to use this function properly for that purpose, you need to have already converted
+    longitudes from lon_type 180 to 360.
+    """
+    if lon1 < lon2:
+        return
+
+    msg = f"--lon1 ({lon1}) must be < --lon2 ({lon2})\n"
+    msg += "See CTSM issue #2017: https://github.com/ESCOMP/CTSM/issues/2017"
+    if lon_type == 180:
+        msg = "After converting to --lon-type 360, " + msg
+    raise ValueError(msg)
+
+
 def get_config_value(
     config,
     section,

python/ctsm/crop_calendars/cropcal_utils.py

@@ -355,8 +355,7 @@ def safer_timeslice(ds_in, time_slice, time_var="time"):
 
 def lon_idl2pm(lons_in, fail_silently=False):
     """
-    Convert a longitude axis that's -180 to 180 around the international date line to one that's 0
-    to 360 around the prime meridian.
+    Convert a longitude axis that's -180 to 180 to one that's 0 to 360
 
     - If you pass in a Dataset or DataArray, the "lon" coordinates will be changed. Otherwise, it
       assumes you're passing in numeric data.

python/ctsm/modify_input_files/fsurdat_modifier.py

@@ -498,6 +498,13 @@ def read_cfg_required_basic_opts(config, section, cfg_path):
         file_path=cfg_path,
         convert_to_type=float,
     )
+    lon_type = get_config_value(
+        config=config,
+        section=section,
+        item="lon_type",
+        file_path=cfg_path,
+        convert_to_type=int,
+    )
 
     landmask_file = get_config_value(
         config=config,
@@ -513,7 +520,16 @@ def read_cfg_required_basic_opts(config, section, cfg_path):
     lon_dimname = get_config_value(
         config=config, section=section, item="lon_dimname", file_path=cfg_path, can_be_unset=True
     )
-    return (lnd_lat_1, lnd_lat_2, lnd_lon_1, lnd_lon_2, landmask_file, lat_dimname, lon_dimname)
+    return (
+        lnd_lat_1,
+        lnd_lat_2,
+        lnd_lon_1,
+        lnd_lon_2,
+        landmask_file,
+        lat_dimname,
+        lon_dimname,
+        lon_type,
+    )
 
 
 def fsurdat_modifier(parser):
@@ -568,6 +584,7 @@ def fsurdat_modifier(parser):
         landmask_file,
         lat_dimname,
         lon_dimname,
+        lon_type,
     ) = read_cfg_required_basic_opts(config, section, cfg_path)
     # Create ModifyFsurdat object
     modify_fsurdat = ModifyFsurdat.init_from_file(
@@ -579,6 +596,7 @@ def fsurdat_modifier(parser):
         landmask_file,
         lat_dimname,
         lon_dimname,
+        lon_type,
     )
 
     # Read control information about the optional sections

python/ctsm/modify_input_files/mesh_mask_modifier.py

@@ -66,10 +66,11 @@ def mesh_mask_modifier(cfg_path):
     lon_varname = get_config_value(
         config=config, section=section, item="lon_varname", file_path=cfg_path
     )
+    lon_type = get_config_value(config=config, section=section, item="lon_type", file_path=cfg_path)
 
     # Create ModifyMeshMask object
     modify_mesh_mask = ModifyMeshMask.init_from_file(
-        mesh_mask_in, landmask_file, lat_dimname, lon_dimname, lat_varname, lon_varname
+        mesh_mask_in, landmask_file, lat_dimname, lon_dimname, lat_varname, lon_varname, lon_type
     )
 
     # If output file exists, abort before starting work

python/ctsm/modify_input_files/modify_fsurdat.py

@@ -14,7 +14,7 @@
 
 from ctsm.utils import abort, update_metadata
 from ctsm.git_utils import get_ctsm_git_short_hash
-from ctsm.config_utils import lon_range_0_to_360
+from ctsm.config_utils import convert_lons_if_needed
 
 logger = logging.getLogger(__name__)
 
@@ -26,7 +26,7 @@ class ModifyFsurdat:
     """
 
     def __init__(
-        self, my_data, lon_1, lon_2, lat_1, lat_2, landmask_file, lat_dimname, lon_dimname
+        self, my_data, lon_1, lon_2, lat_1, lat_2, landmask_file, lat_dimname, lon_dimname, lon_type
     ):
 
         self.numurbl = 3  # Number of urban density types
@@ -36,13 +36,15 @@ def __init__(
         else:
             abort("numurbl is not a dimension on the input surface dataset file and needs to be")
 
+        self.lon_type = lon_type
         self.rectangle = self._get_rectangle(
             lon_1=lon_1,
             lon_2=lon_2,
             lat_1=lat_1,
             lat_2=lat_2,
             longxy=self.file.LONGXY,
             latixy=self.file.LATIXY,
+            lon_type=self.lon_type,
         )
 
         if landmask_file is not None:
@@ -72,23 +74,33 @@ def __init__(
 
     @classmethod
     def init_from_file(
-        cls, fsurdat_in, lon_1, lon_2, lat_1, lat_2, landmask_file, lat_dimname, lon_dimname
+        cls,
+        fsurdat_in,
+        lon_1,
+        lon_2,
+        lat_1,
+        lat_2,
+        landmask_file,
+        lat_dimname,
+        lon_dimname,
+        lon_type,
     ):
         """Initialize a ModifyFsurdat object from file fsurdat_in"""
         logger.info("Opening fsurdat_in file to be modified: %s", fsurdat_in)
         my_file = xr.open_dataset(fsurdat_in)
-        return cls(my_file, lon_1, lon_2, lat_1, lat_2, landmask_file, lat_dimname, lon_dimname)
+        return cls(
+            my_file, lon_1, lon_2, lat_1, lat_2, landmask_file, lat_dimname, lon_dimname, lon_type
+        )
 
     @staticmethod
-    def _get_rectangle(lon_1, lon_2, lat_1, lat_2, longxy, latixy):
+    def _get_rectangle(lon_1, lon_2, lat_1, lat_2, longxy, latixy, lon_type):
         """
         Description
         -----------
         """
 
         # ensure that lon ranges 0-360 in case user entered -180 to 180
-        lon_1 = lon_range_0_to_360(lon_1)
-        lon_2 = lon_range_0_to_360(lon_2)
+        lon_1, lon_2 = convert_lons_if_needed(lon_1, lon_2, lon_type)
 
         # determine the rectangle(s)
         # TODO This is not really "nearest" for the edges but isel didn't work

python/ctsm/modify_input_files/modify_mesh_mask.py

@@ -12,7 +12,7 @@
 import xarray as xr
 
 from ctsm.utils import abort
-from ctsm.config_utils import lon_range_0_to_360
+from ctsm.config_utils import convert_lon_0to360
 
 logger = logging.getLogger(__name__)
 
@@ -29,7 +29,9 @@ class ModifyMeshMask:
     # /glade/work/slevis/git/mksurfdata_toolchain/tools/modify_input_files ...
     # ... /islas_examples/modify_fsurdat/fill_indian_ocean/
     # Read mod_lnd_props here only for consistency checks
-    def __init__(self, my_data, landmask_file, lat_dimname, lon_dimname, lat_varname, lon_varname):
+    def __init__(
+        self, my_data, landmask_file, lat_dimname, lon_dimname, lat_varname, lon_varname, lon_type
+    ):
 
         self.file = my_data
 
@@ -46,6 +48,7 @@ def __init__(self, my_data, landmask_file, lat_dimname, lon_dimname, lat_varname
         self.lonvar = self._landmask_file[lon_varname][..., :]
         self.lsmlat = self._landmask_file.dims[lat_dimname]
         self.lsmlon = self._landmask_file.dims[lon_dimname]
+        self.lon_type = lon_type
 
         lonvar_first = self.lonvar[..., 0].data.max()
         lonvar_last = self.lonvar[..., -1].data.max()
@@ -75,12 +78,14 @@ def __init__(self, my_data, landmask_file, lat_dimname, lon_dimname, lat_varname
 
     @classmethod
     def init_from_file(
-        cls, file_in, landmask_file, lat_dimname, lon_dimname, lat_varname, lon_varname
+        cls, file_in, landmask_file, lat_dimname, lon_dimname, lat_varname, lon_varname, lon_type
     ):
         """Initialize a ModifyMeshMask object from file_in"""
         logger.info("Opening file to be modified: %s", file_in)
         my_file = xr.open_dataset(file_in)
-        return cls(my_file, landmask_file, lat_dimname, lon_dimname, lat_varname, lon_varname)
+        return cls(
+            my_file, landmask_file, lat_dimname, lon_dimname, lat_varname, lon_varname, lon_type
+        )
 
     def set_mesh_mask(self, var):
         """
@@ -134,13 +139,13 @@ def set_mesh_mask(self, var):
                         + f"{len(self.latvar.sizes)}"
                     )
                     abort(errmsg)
-                # ensure lon range of 0-360 rather than -180 to 180
-                lonvar_scalar = lon_range_0_to_360(lonvar_scalar)
                 # lon and lat from the mesh file
                 lat_mesh = float(self.file["centerCoords"][ncount, 1])
                 lon_mesh = float(self.file["centerCoords"][ncount, 0])
                 # ensure lon range of 0-360 rather than -180 to 180
-                lon_mesh = lon_range_0_to_360(lon_mesh)
+                if self.lon_type == 180:
+                    lonvar_scalar = convert_lon_0to360(lonvar_scalar)
+                    lon_mesh = convert_lon_0to360(lon_mesh)
 
                 errmsg = (
                     "Must be equal: "

python/ctsm/site_and_regional/regional_case.py

@@ -17,6 +17,7 @@
 from ctsm.site_and_regional.mesh_type import MeshType
 from ctsm.utils import add_tag_to_filename
 from ctsm.utils import abort
+from ctsm.config_utils import check_lon1_lt_lon2
 
 logger = logging.getLogger(__name__)
 
@@ -36,6 +37,8 @@ class RegionalCase(BaseCase):
         first (bottom) longitude of a region.
     lon2 : float
         second (top) longitude of a region.
+    lon_type : int
+        180 if longitudes are in [-180, 180], 360 if they're in [0, 360]
     reg_name: str -- default = None
         Region's name
     create_domain : bool
@@ -64,9 +67,6 @@ class RegionalCase(BaseCase):
     check_region_bounds
         Check for the regional bounds
 
-    check_region_lons
-        Check for the regional lons
-
     check_region_lats
         Check for the regional lats
 
@@ -116,6 +116,7 @@ def __init__(
             create_user_mods,
             overwrite,
         )
+
         self.lat1 = lat1
         self.lat2 = lat2
         self.lon1 = lon1
@@ -146,27 +147,18 @@ def check_region_bounds(self):
         """
         Check for the regional bounds
         """
-        self.check_region_lons()
-        self.check_region_lats()
-
-    def check_region_lons(self):
-        """
-        Check for the regional lon bounds
-        """
-        if self.lon1 >= self.lon2:
-            err_msg = """
-            \n
-            ERROR: lon1 is bigger than lon2.
-            lon1 points to the westernmost longitude of the region. {}
-            lon2 points to the easternmost longitude of the region. {}
-            Please make sure lon1 is smaller than lon2.
-
-            Please note that if longitude in -180-0, the code automatically
-            convert it to 0-360.
-            """.format(
-                self.lon1, self.lon2
+        # If you're calling this, lat/lon bounds need to have been provided
+        if any(x is None for x in [self.lon1, self.lon2, self.lat1, self.lat2]):
+            raise argparse.ArgumentTypeError(
+                "Latitude and longitude bounds must be provided and not None.\n"
+                + f"   lon1: {self.lon1}\n"
+                + f"   lon2: {self.lon2}\n"
+                + f"   lat1: {self.lat1}\n"
+                + f"   lat2: {self.lat2}"
             )
-            raise argparse.ArgumentTypeError(err_msg)
+        # By now, you need to have already converted to longitude [0, 360]
+        check_lon1_lt_lon2(self.lon1, self.lon2, 360)
+        self.check_region_lats()
 
     def check_region_lats(self):
         """