Reorganizing subset_data.py to follow SE recommendations

python/ctsm/site_and_regional/base_case.py

@@ -0,0 +1,145 @@
+import os
+import numpy as np
+import xarray as xr
+import subprocess
+
+from datetime import date
+from getpass import getuser
+
+myname = getuser()
+
+
+class BaseCase:
+    """
+    Parent class to SinglePointCase and RegionalCase
+
+    ...
+
+    Attributes
+    ----------
+    create_domain : bool
+        flag for creating domain file
+    create_surfdata : bool
+        flag for creating surface dataset
+    create_landuse : bool
+        flag for creating landuse file
+    create_datm : bool
+        flag for creating DATM files
+
+    Methods
+    -------
+    create_1d_coord(filename, lon_varname , lat_varname,x_dim , y_dim )
+        create 1d coordinate variables to enable sel() method
+
+    add_tag_to_filename(filename, tag)
+       add a tag and timetag to a filename ending with
+       [._]cYYMMDD.nc or [._]YYMMDD.nc
+    """
+
+    def __init__(self, create_domain, create_surfdata, create_landuse, create_datm):
+        self.create_domain = create_domain
+        self.create_surfdata = create_surfdata
+        self.create_landuse = create_landuse
+        self.create_datm = create_datm
+
+    def __str__(self):
+        return (
+            str(self.__class__)
+            + "\n"
+            + "\n".join(
+                (
+                    str(item) + " = " + str(self.__dict__[item])
+                    for item in sorted(self.__dict__)
+                )
+            )
+        )
+
+    @staticmethod
+    def create_1d_coord(filename, lon_varname, lat_varname, x_dim, y_dim):
+        """
+        lon_varname : variable name that has 2d lon
+        lat_varname : variable name that has 2d lat
+        x_dim: dimension name in X -- lon
+        y_dim: dimension name in Y -- lat
+        """
+        print("Open file: " + filename)
+        f1 = xr.open_dataset(filename)
+
+        # create 1d coordinate variables to enable sel() method
+        lon0 = np.asarray(f1[lon_varname][0, :])
+        lat0 = np.asarray(f1[lat_varname][:, 0])
+        lon = xr.DataArray(lon0, name="lon", dims=x_dim, coords={x_dim: lon0})
+        lat = xr.DataArray(lat0, name="lat", dims=y_dim, coords={y_dim: lat0})
+
+        f2 = f1.assign({"lon": lon, "lat": lat})
+
+        f2.reset_coords([lon_varname, lat_varname])
+        f1.close()
+        return f2
+
+    @staticmethod
+    def add_tag_to_filename(filename, tag):
+        """
+        Add a tag and replace timetag of a filename
+        # Expects file to end with [._]cYYMMDD.nc or [._]YYMMDD.nc
+        # Add the tag to just before that ending part
+        # and change the ending part to the current time tag
+        """
+        basename = os.path.basename(filename)
+        cend = -10
+        if basename[cend] == "c":
+            cend = cend - 1
+        if (basename[cend] != ".") and (basename[cend] != "_"):
+            print("Trouble figuring out where to add tag to filename:" + filename)
+            os.abort()
+        today = date.today()
+        today_string = today.strftime("%y%m%d")
+        return basename[:cend] + "_" + tag + "_c" + today_string + ".nc"
+
+    def update_metadata(self, nc):
+        # update attributes
+        today = date.today()
+        today_string = today.strftime("%Y-%m-%d")
+
+        # get git hash
+        sha = self.get_git_sha()
+
+        nc.attrs["Created_on"] = today_string
+        nc.attrs["Created_by"] = myname
+        nc.attrs["Created_with"] = os.path.abspath(__file__) + " -- " + sha
+
+        # delete unrelated attributes if they exist
+        del_attrs = [
+            "source_code",
+            "SVN_url",
+            "hostname",
+            "history" "History_Log",
+            "Logname",
+            "Host",
+            "Version",
+            "Compiler_Optimized",
+        ]
+        attr_list = nc.attrs
+
+        for attr in del_attrs:
+            if attr in attr_list:
+                # print ("This attr should be deleted:", attr)
+                del nc.attrs[attr]
+
+        # for attr, value in attr_list.items():
+        #    print (attr + " = "+str(value))
+
+    @staticmethod
+    def get_git_sha():
+        """
+        Returns Git short SHA for the currect directory.
+        """
+        try:
+            sha = (
+                subprocess.check_output(["git", "rev-parse", "--short", "HEAD"])
+                .strip()
+                .decode()
+            )
+        except subprocess.CalledProcessError:
+            sha = "NOT-A-GIT-REPOSITORY"
+        return sha

python/ctsm/site_and_regional/regional_case.py

@@ -0,0 +1,113 @@
+from ctsm.site_and_regional.base_case import BaseCase
+
+import numpy as np
+import xarray as xr
+
+
+class RegionalCase(BaseCase):
+    """
+    A case to encapsulate regional cases.
+    """
+
+    def __init__(
+        self,
+        lat1,
+        lat2,
+        lon1,
+        lon2,
+        reg_name,
+        create_domain,
+        create_surfdata,
+        create_landuse,
+        create_datm,
+    ):
+        super().__init__(create_domain, create_surfdata, create_landuse, create_datm)
+        self.lat1 = lat1
+        self.lat2 = lat2
+        self.lon1 = lon1
+        self.lon2 = lon2
+        self.reg_name = reg_name
+
+    def create_tag(self):
+        if self.reg_name:
+            self.tag = self.reg_name
+        else:
+            self.tag = (
+                str(self.lon1)
+                + "-"
+                + str(self.lon2)
+                + "_"
+                + str(self.lat1)
+                + "-"
+                + str(self.lat2)
+            )
+
+    def create_domain_at_reg(self):
+        # print ("Creating domain file at region", self.lon1+"-"+self.lat2,self.lat1+"-"+self.lat2)
+        print("Creating domain file at region:", self.tag)
+        # create 1d coordinate variables to enable sel() method
+        f2 = self.create_1d_coord(self.fdomain_in, "xc", "yc", "ni", "nj")
+        lat = f2["lat"]
+        lon = f2["lon"]
+        # subset longitude and latitude arrays
+        xind = np.where((lon >= self.lon1) & (lon <= self.lon2))[0]
+        yind = np.where((lat >= self.lat1) & (lat <= self.lat2))[0]
+        f3 = f2.isel(nj=yind, ni=xind)
+
+        # update attributes
+        self.update_metadata(f3)
+        f3.attrs["Created_from"] = self.fdomain_in
+
+        wfile = self.fdomain_out
+        # mode 'w' overwrites file
+        f3.to_netcdf(path=wfile, mode="w")
+        print("Successfully created file (fdomain_out)" + self.fdomain_out)
+        f2.close()
+        f3.close()
+
+    def create_surfdata_at_reg(self):
+        # print ("Creating surface dataset file at region", self.lon1+"-"+self.lat2,self.lat1+"-"+self.lat2)
+        print("Creating surface dataset file at region:", self.tag)
+        # create 1d coordinate variables to enable sel() method
+        filename = self.fsurf_in
+        f2 = self.create_1d_coord(filename, "LONGXY", "LATIXY", "lsmlon", "lsmlat")
+        lat = f2["lat"]
+        lon = f2["lon"]
+        # subset longitude and latitude arrays
+        xind = np.where((lon >= self.lon1) & (lon <= self.lon2))[0]
+        yind = np.where((lat >= self.lat1) & (lat <= self.lat2))[0]
+        f3 = f2.isel(lsmlat=yind, lsmlon=xind)
+
+        # update attributes
+        self.update_metadata(f3)
+        f3.attrs["Created_from"] = self.fsurf_in
+
+        # mode 'w' overwrites file
+        f3.to_netcdf(path=self.fsurf_out, mode="w")
+        print("created file (fsurf_out)" + self.fsurf_out)
+        # f1.close();
+        f2.close()
+        f3.close()
+
+    def create_landuse_at_reg(self):
+        # print ("Creating surface dataset file at region", self.lon1+"-"+self.lat2,self.lat1+"-"+self.lat2)
+        print("Creating surface dataset file at region:", self.tag)
+        # create 1d coordinate variables to enable sel() method
+        f2 = self.create_1d_coord(self.fluse_in, "LONGXY", "LATIXY", "lsmlon", "lsmlat")
+        lat = f2["lat"]
+        lon = f2["lon"]
+        # subset longitude and latitude arrays
+        xind = np.where((lon >= self.lon1) & (lon <= self.lon2))[0]
+        yind = np.where((lat >= self.lat1) & (lat <= self.lat2))[0]
+        f3 = f2.isel(lsmlat=yind, lsmlon=xind)
+
+        # update attributes
+        self.update_metadata(f3)
+        f3.attrs["Created_from"] = self.fluse_in
+
+        wfile = self.fluse_out
+        # mode 'w' overwrites file
+        f3.to_netcdf(path=wfile, mode="w")
+        print("Successfully created file (fdomain_out)" + self.fdomain_out)
+        f2.close()
+        f3.close()