netcdf attr dicts for package and model

Author: mjreno

flopy/mf6/data/mfstructure.py

@@ -594,6 +594,7 @@ def __init__(self):
         self.parameter_name = None
         self.one_per_pkg = False
         self.jagged_array = None
+        self.netcdf = False
 
     def set_value(self, line, common):
         arr_line = line.strip().split()
@@ -771,6 +772,8 @@ def set_value(self, line, common):
                 self.one_per_pkg = bool(arr_line[1])
             elif arr_line[0] == "jagged_array":
                 self.jagged_array = arr_line[1]
+            elif arr_line[0] == "netcdf":
+                self.netcdf = arr_line[1]
 
     def get_type_string(self):
         return f"[{self.type_string}]"
@@ -1089,6 +1092,7 @@ def __init__(self, data_item, model_data, package_type, dfn_list):
             or "nodes" in data_item.shape
             or len(data_item.layer_dims) > 1
         )
+        self.netcdf = data_item.netcdf
         self.num_data_items = len(data_item.data_items)
         self.record_within_record = False
         self.file_data = False

flopy/mf6/mfmodel.py

@@ -808,6 +808,32 @@ def export(self, f, **kwargs):
 
         return utils.model_export(f, self, **kwargs)
 
+    def netcdf_attrs(self, mesh=None):
+        """Return dictionary of dataset (model) scoped attributes
+        Parameters
+        ----------
+        mesh : str
+            mesh type if dataset is ugrid complient
+        """
+        attrs = {
+            "modflow_grid": "",
+            "modflow_model": "",
+        }
+        if self.get_grid_type() == DiscretizationType.DIS:
+            attrs["modflow_grid"] = "STRUCTURED"
+        elif self.get_grid_type() == DiscretizationType.DISV:
+            attrs["modflow_grid"] = "VERTEX"
+
+        attrs["modflow_model"] = (
+            f"{self.name.upper()}: MODFLOW 6 {self.model_type.upper()[0:3]} model"
+        )
+
+        # supported => LAYERED
+        if mesh:
+            attrs["mesh"] = mesh
+
+        return attrs
+
     @property
     def verbose(self):
         """Verbose setting for model operations (True/False)"""

flopy/mf6/mfpackage.py

@@ -2086,6 +2086,72 @@ def package_filename_dict(self):
         )
         return self._package_container.package_filename_dict
 
+    def netcdf_attrs(self, mesh=None):
+        attrs = {}
+
+        def attr_d(tagname, iaux=None, layer=None):
+            tag = tagname
+            name = f"{self.package_name}"
+            if iaux:
+                auxvar = self.dimensions.get_aux_variables()[0]
+                tag = f"{tag}/{iaux}"
+                name = f"{name}_{auxvar[iaux]}"
+            else:
+                name = f"{name}_{tagname}"
+            if layer:
+                tag = f"{tag}/layer{layer}"
+                name = f"{name}_l{layer}"
+
+            a = {}
+            a["varname"] = name
+            a["attrs"] = {}
+            a["attrs"]["modflow_input"] = (
+                f"{self.model_name}/{self.package_name}/{tagname}"
+            ).upper()
+            if iaux:
+                a["attrs"]["modflow_iaux"] = iaux
+            if layer:
+                a["attrs"]["layer"] = layer
+            return tag, a
+
+        for key, block in self.blocks.items():
+            if key != "griddata" and key != "period":
+                continue
+            for dataset in block.datasets.values():
+                if isinstance(dataset, mfdataarray.MFArray):
+                    for index, data_item in enumerate(
+                        dataset.structure.data_item_structures
+                    ):
+                        if not (dataset.structure.netcdf and dataset.has_data()):
+                            continue
+                        if dataset.structure.layered and mesh == "LAYERED":
+                            if data_item.name == "aux" or data_item.name == "auxvar":
+                                for n, auxname in enumerate(
+                                    self.dimensions.get_aux_variables()[0]
+                                ):
+                                    if auxname == "auxiliary" and n == 0:
+                                        continue
+                                    for l in range(self.model_or_sim.modelgrid.nlay):
+                                        key, a = attr_d(data_item.name, n, l + 1)
+                                        attrs[key] = a
+                            else:
+                                for l in range(self.model_or_sim.modelgrid.nlay):
+                                    key, a = attr_d(data_item.name, layer=l + 1)
+                                    attrs[key] = a
+                        else:
+                            if data_item.name == "aux" or data_item.name == "auxvar":
+                                for n, auxname in enumerate(
+                                    self.dimensions.get_aux_variables()[0]
+                                ):
+                                    if auxname == "auxiliary" and n == 0:
+                                        continue
+                                    key, a = attr_d(data_item.name, iaux=n)
+                                    attrs[key] = a
+                            else:
+                                key, a = attr_d(data_item.name)
+                                attrs[key] = a
+        return attrs
+
     def get_package(self, name=None, type_only=False, name_only=False):
         """
         Finds a package by package name, package key, package type, or partial