static methods return full info dict

Author: mjreno

.docs/Notebooks/netcdf01_tutorial.py

@@ -1,6 +1,6 @@
 import sys
 from pathlib import Path
-from pprint import pformat
+from pprint import pformat, pprint
 from tempfile import TemporaryDirectory
 
 import numpy as np
@@ -14,6 +14,8 @@
 DNODATA = 3.0e30
 
 
+# A FloPy simulation ASCII sim that will be updated
+# use netcdf inputs
 def create_sim(ws):
     name = "uzf01"
     perlen = [500.0]
@@ -185,6 +187,8 @@ def create_sim(ws):
     return sim
 
 
+# A subroutine that can update an xarray dataset
+# with package netcdf information stored in a dict
 def add_netcdf_vars(dataset, nc_info, dimmap):
     def _data_shape(shape):
         dims_l = []
@@ -196,18 +200,19 @@ def _data_shape(shape):
     for v in nc_info:
         varname = nc_info[v]["varname"]
         data = np.full(
-            _data_shape(nc_info[v]["nc_shape"]),
+            _data_shape(nc_info[v]["netcdf_shape"]),
             nc_info[v]["attrs"]["_FillValue"],
-            dtype=nc_info[v]["nc_type"],
+            dtype=nc_info[v]["xarray_type"],
         )
-        var_d = {varname: (nc_info[v]["nc_shape"], data)}
+        var_d = {varname: (nc_info[v]["netcdf_shape"], data)}
         dataset = dataset.assign(var_d)
         for a in nc_info[v]["attrs"]:
             dataset[varname].attrs[a] = nc_info[v]["attrs"][a]
 
     return dataset
 
 
+# create temporary directories
 temp_dir = TemporaryDirectory()
 workspace = Path(temp_dir.name)
 
@@ -228,6 +233,7 @@ def _data_shape(shape):
 
 # get model netcdf info
 nc_info = gwf.netcdf_info()
+pprint(nc_info)
 
 # update dataset with required attributes
 for a in nc_info["attrs"]:
@@ -254,6 +260,7 @@ def _data_shape(shape):
 # dis
 dis = gwf.get_package("dis")
 nc_info = dis.netcdf_info()
+pprint(nc_info)
 
 # create dis dataset variables
 ds = add_netcdf_vars(ds, nc_info, dimmap)
@@ -286,6 +293,7 @@ def _data_shape(shape):
 # npf
 npf = gwf.get_package("npf")
 nc_info = npf.netcdf_info()
+pprint(nc_info)
 
 # create npf dataset variables
 ds = add_netcdf_vars(ds, nc_info, dimmap)
@@ -306,6 +314,7 @@ def _data_shape(shape):
 # get ghbg package netcdf info
 ghbg = gwf.get_package("ghbg_0")
 nc_info = ghbg.netcdf_info()
+pprint(nc_info)
 
 # create ghbg dataset variables
 ds = add_netcdf_vars(ds, nc_info, dimmap)
@@ -320,6 +329,9 @@ def _data_shape(shape):
     istp = sum(gwf.modeltime.nstp[0:p])
     ds["ghbg_0_cond"].values[istp] = ghbg.cond.get_data()[p]
 
+# show the dataset
+print(ds)
+
 # write the netcdf
 ds.to_netcdf(
     workspace / "netcdf/uzf01.structured.nc", format="NETCDF4", engine="netcdf4"

.docs/Notebooks/netcdf02_tutorial.py

@@ -1,6 +1,6 @@
 import sys
 from pathlib import Path
-from pprint import pformat
+from pprint import pformat, pprint
 from tempfile import TemporaryDirectory
 
 import numpy as np
@@ -15,6 +15,8 @@
 DNODATA = 3.0e30
 
 
+# A FloPy simulation ASCII sim that will be updated
+# use netcdf inputs
 def create_sim(ws):
     name = "flow"
     gwfname = name
@@ -186,6 +188,8 @@ def create_sim(ws):
     return sim
 
 
+# A subroutine that can update an xarray dataset
+# with package netcdf information stored in a dict
 def add_netcdf_vars(dataset, nc_info, dimmap):
     def _data_shape(shape):
         dims_l = []
@@ -197,18 +201,19 @@ def _data_shape(shape):
     for v in nc_info:
         varname = nc_info[v]["varname"]
         data = np.full(
-            _data_shape(nc_info[v]["nc_shape"]),
+            _data_shape(nc_info[v]["netcdf_shape"]),
             nc_info[v]["attrs"]["_FillValue"],
-            dtype=nc_info[v]["nc_type"],
+            dtype=nc_info[v]["xarray_type"],
         )
-        var_d = {varname: (nc_info[v]["nc_shape"], data)}
+        var_d = {varname: (nc_info[v]["netcdf_shape"], data)}
         dataset = dataset.assign(var_d)
         for a in nc_info[v]["attrs"]:
             dataset[varname].attrs[a] = nc_info[v]["attrs"][a]
 
     return dataset
 
 
+# create temporary directories
 temp_dir = TemporaryDirectory()
 workspace = Path(temp_dir.name)
 
@@ -229,6 +234,7 @@ def _data_shape(shape):
 
 # get model netcdf info
 nc_info = gwf.netcdf_info()
+pprint(nc_info)
 
 # update dataset with required attributes
 for a in nc_info["attrs"]:
@@ -258,6 +264,7 @@ def _data_shape(shape):
 # update for welg
 welg = gwf.get_package("wel-1")
 nc_info = welg.netcdf_info()
+pprint(nc_info)
 
 # create welg dataset variables
 ds = add_netcdf_vars(ds, nc_info, dimmap)
@@ -292,6 +299,7 @@ def _data_shape(shape):
     # get ghbg package netcdf info
     ghbg = gwf.get_package(f"ghb-{ip}")
     nc_info = ghbg.netcdf_info()
+    pprint(nc_info)
 
     # create ghbg dataset variables
     ds = add_netcdf_vars(ds, nc_info, dimmap)
@@ -334,6 +342,7 @@ def _data_shape(shape):
     # get rivg package netcdf info
     rivg = gwf.get_package(f"riv-{ip}")
     nc_info = rivg.netcdf_info()
+    pprint(nc_info)
 
     # create rivg dataset variables
     ds = add_netcdf_vars(ds, nc_info, dimmap)
@@ -382,6 +391,7 @@ def _data_shape(shape):
     # get drng package netcdf info
     drng = gwf.get_package(f"drn-{ip}")
     nc_info = drng.netcdf_info()
+    pprint(nc_info)
 
     # create drng dataset variables
     ds = add_netcdf_vars(ds, nc_info, dimmap)
@@ -416,6 +426,9 @@ def _data_shape(shape):
         f.write("  concentration NETCDF\n")
         f.write("END period  1\n\n")
 
+# show the dataset
+print(ds)
+
 # write the netcdf
 ds.to_netcdf(
     workspace / "netcdf/flow.structured.nc", format="NETCDF4", engine="netcdf4"

flopy/mf6/mfmodel.py

@@ -2205,14 +2205,14 @@ def _resolve_idomain(idomain, botm):
         return idomain
 
     @staticmethod
-    def netcdf_attrs(mname, mtype, grid_type, mesh=None):
+    def netcdf_model(mname, mtype, grid_type, mesh=None):
         """Return dictionary of dataset (model) scoped attributes
         Parameters
         ----------
         mname : str
             model name
         mtype : str
-            model type
+            model type, e.g. GWF6
         grid_type:
             DiscretizationType
         mesh : str
@@ -2227,7 +2227,7 @@ def netcdf_attrs(mname, mtype, grid_type, mesh=None):
         elif grid_type == DiscretizationType.DISV:
             attrs["modflow_grid"] = "VERTEX"
 
-        attrs["modflow_model"] = f"{mname.upper()}: MODFLOW 6 {mtype.upper()} model"
+        attrs["modflow_model"] = f"{mtype.upper()}: {mname.upper()}"
 
         # supported => LAYERED
         if mesh:
@@ -2242,7 +2242,7 @@ def netcdf_info(self, mesh=None):
         mesh : str
             mesh type if dataset is ugrid compliant
         """
-        attrs = MFModel.netcdf_attrs(
+        attrs = MFModel.netcdf_model(
             self.name, self.model_type, self.get_grid_type(), mesh
         )
 

flopy/mf6/mfpackage.py

@@ -3455,9 +3455,9 @@ def _add_entry(tagname, iaux=None, layer=None):
             # add non-attrs to dictionary
             a["varname"] = name.lower()
             if (data_item.type) == DatumType.integer:
-                a["nc_type"] = np.int32
+                a["xarray_type"] = np.int32
             elif (data_item.type) == DatumType.double_precision:
-                a["nc_type"] = np.float64
+                a["xarray_type"] = np.float64
             dims = []
             if data_item.shape[0] == 'nodes':
                 if data_item.block_name == "griddata":
@@ -3470,7 +3470,7 @@ def _add_entry(tagname, iaux=None, layer=None):
                     for k, v in dimmap.items():
                         s = s.replace(k, v)
                     dims.append(s)
-            a["nc_shape"] = dims[::-1]
+            a["netcdf_shape"] = dims[::-1]
 
             # add variable attributes dictionary
             a["attrs"] = {}
@@ -3490,7 +3490,7 @@ def _add_entry(tagname, iaux=None, layer=None):
             # set dictionary
             attrs[key] = a
 
-        if data_item.layered and mesh == "LAYERED":
+        if data_item.layered and mesh and mesh.upper() == "LAYERED":
             if data_item.name == "aux" or data_item.name == "auxvar":
                 for n, auxname in enumerate(auxnames):
                     for l in range(nlay):
@@ -3506,7 +3506,7 @@ def _add_entry(tagname, iaux=None, layer=None):
                 _add_entry(data_item.name)
 
     @staticmethod
-    def netcdf_attrs(mtype, ptype, auxiliary=None, mesh=None, nlay=1):
+    def netcdf_package(mtype, ptype, auxiliary=None, mesh=None, nlay=1):
         from .data.mfstructure import DfnPackage, MFSimulationStructure
 
         attrs = {}
@@ -3541,11 +3541,7 @@ def netcdf_attrs(mtype, ptype, auxiliary=None, mesh=None, nlay=1):
                             nlay,
                         )
 
-        res_d = {}
-        for k in list(attrs):
-            res_d[k] = attrs[k]["attrs"]
-
-        return res_d
+        return attrs
 
     def netcdf_info(self, mesh=None):
         attrs = {}