wip

Author: wpbonelli

flopy4/mf6/__init__.py

@@ -1,30 +1,10 @@
-from pathlib import Path
-
 from flopy4.mf6.codec import dump, load
 from flopy4.mf6.component import Component
 from flopy4.uio import DEFAULT_REGISTRY
 
+# register io methods for ascii format input files
+# TODO: call this "mf6" or something? since it might include binary files
+DEFAULT_REGISTRY.register_loader(Component, "ascii", lambda c: load(c.path))
+DEFAULT_REGISTRY.register_writer(Component, "ascii", lambda c: dump(c, c.path))
 
-def _default_filename(component: Component) -> str:
-    """Default path for a component, based on its name."""
-    if filename := component.filename:
-        return filename
-    name = component.name  # type: ignore
-    cls_name = component.__class__.__name__.lower()
-    return f"{name}.{cls_name}"
-
-
-def _path(component: Component) -> str:
-    """Default path for a component, based on its name."""
-    if hasattr(component, "path") and component.path is not None:
-        path = Path(component.path).expanduser().resolve()
-        if path.is_dir():
-            return str(path / _default_filename(component))
-        return str(path)
-    return _default_filename(component)
-
-
-DEFAULT_REGISTRY.register_loader(Component, "ascii", lambda component: load(_path(component)))
-DEFAULT_REGISTRY.register_writer(
-    Component, "ascii", lambda component: dump(component, _path(component))
-)
+# TODO: explore what a netcdf format for the whole simulation would look like?

flopy4/mf6/component.py

@@ -1,5 +1,6 @@
 from abc import ABC
 from collections.abc import MutableMapping
+from pathlib import Path
 
 from modflow_devtools.dfn import Dfn, Field
 from xattree import xattree
@@ -32,11 +33,24 @@ class Component(ABC, MutableMapping):
 
     filename: str = field(default=None)
 
+    @property
+    def path(self) -> Path:
+        return Path.cwd() / self.filename
+
+    def _default_filename(self) -> str:
+        name = self.name  # type: ignore
+        cls_name = self.__class__.__name__.lower()
+        return f"{name}.{cls_name}"
+
     @classmethod
     def __attrs_init_subclass__(cls):
         COMPONENTS[cls.__name__.lower()] = cls
         cls.dfn = cls.get_dfn()
 
+    def __attrs_post_init__(self):
+        if not self.filename:
+            self.filename = self._default_filename()
+
     def __getitem__(self, key):
         return self.children[key]  # type: ignore
 

flopy4/mf6/context.py

@@ -0,0 +1,21 @@
+from abc import ABC
+from pathlib import Path
+
+from xattree import xattree
+
+from flopy4.mf6.component import Component
+from flopy4.mf6.spec import field
+
+
+@xattree
+class Context(Component, ABC):
+    workspace: Path = field(default=None)
+
+    def __attrs_post_init__(self):
+        super().__attrs_post_init__()
+        if self.workspace is None:
+            self.workspace = Path.cwd()
+
+    @property
+    def path(self) -> Path:
+        return self.workspace / self.filename

flopy4/mf6/interface/flopy3.py

@@ -1,5 +1,6 @@
 import re
 from typing import Optional
+from warnings import warn
 
 import numpy as np
 from flopy.datbase import DataInterface, DataListInterface, DataType
@@ -332,7 +333,7 @@ def data_type(self):
                         return DataType.array3d
             # TODO: boundname, auxvar arrays of strings?
             case _:
-                raise Exception(f"UNMATCHED data_type {self._name}: {self._spec.type.__name__}")
+                warn(f"UNMATCHED data_type {self._name}: {self._spec.type.__name__}", UserWarning)
 
     @property
     def dtype(self):

flopy4/mf6/simulation.py

@@ -1,12 +1,11 @@
 from os import PathLike
-from pathlib import Path
 from warnings import warn
 
 from flopy.discretization.modeltime import ModelTime
 from modflow_devtools.misc import cd, run_cmd
 from xattree import xattree
 
-from flopy4.mf6.component import Component
+from flopy4.mf6.context import Context
 from flopy4.mf6.exchange import Exchange
 from flopy4.mf6.model import Model
 from flopy4.mf6.solution import Solution
@@ -23,13 +22,12 @@ def convert_time(value):
 
 
 @xattree
-class Simulation(Component):
+class Simulation(Context):
     models: dict[str, Model] = field()
     exchanges: dict[str, Exchange] = field()
     solutions: dict[str, Solution] = field()
     tdis: Tdis = field(converter=convert_time)
-    workspace: Path = field(default=None)
-    filename: str = field(default="mfsim.nam")
+    filename: str = field(default="mfsim.nam", init=False)
 
     def __attrs_post_init__(self):
         super().__attrs_post_init__()
@@ -40,13 +38,6 @@ def __attrs_post_init__(self):
             )
             self.filename = "mfsim.nam"
 
-    @property
-    def path(self) -> Path:
-        """Return the path to the simulation namefile."""
-        if self.workspace is None:
-            raise ValueError("Simulation has no workspace path.")
-        return Path(self.workspace).expanduser().resolve() / self.filename
-
     @property
     def time(self) -> ModelTime:
         """Return the simulation time discretization."""

test/test_interface.py

@@ -212,6 +212,7 @@ def test_flopy3_package():
 
     # package data
     data_list = [
+        "filename",
         "nogrb",
         "xorigin",
         "yorigin",