Issue #1683: Support zarr and zipstore for dump and from_file methods in mf6 model

docs/api/changelog.rst

@@ -21,6 +21,10 @@ Added
 
 - Added :class:`imod.mf6.Viscosity` package to specify the viscosity of the
   groundwater flow model.
+- Functionality to dump and load MODFLOW 6 simulations to/from zarr and zipstore
+  formats. See :meth:`imod.mf6.Modflow6Simulation.dump` and
+  :meth:`imod.mf6.Modflow6Simulation.from_file` for more information.
+
 
 [1.0.0rc7] - 2025-10-28
 -----------------------

docs/api/mf6.rst

@@ -81,7 +81,7 @@ Discretization
     StructuredDiscretization.get_regrid_methods
     StructuredDiscretization.regrid_like
     StructuredDiscretization.from_file
-    StructuredDiscretization.to_netcdf
+    StructuredDiscretization.to_file
     StructuredDiscretization.copy
     StructuredDiscretization.clip_box
     StructuredDiscretization.mask
@@ -91,7 +91,7 @@ Discretization
     VerticesDiscretization.get_regrid_methods
     VerticesDiscretization.regrid_like
     VerticesDiscretization.from_file
-    VerticesDiscretization.to_netcdf
+    VerticesDiscretization.to_file
     VerticesDiscretization.copy
     VerticesDiscretization.clip_box
     VerticesDiscretization.mask
@@ -100,7 +100,7 @@ Discretization
     TimeDiscretization
     TimeDiscretization.write
     TimeDiscretization.from_file
-    TimeDiscretization.to_netcdf
+    TimeDiscretization.to_file
     TimeDiscretization.copy
     TimeDiscretization.clip_box
     TimeDiscretization.mask
@@ -110,7 +110,7 @@ Discretization
     AdaptiveTimeStepping
     AdaptiveTimeStepping.write
     AdaptiveTimeStepping.from_file
-    AdaptiveTimeStepping.to_netcdf
+    AdaptiveTimeStepping.to_file
     AdaptiveTimeStepping.copy
     AdaptiveTimeStepping.clip_box
     AdaptiveTimeStepping.mask
@@ -128,7 +128,7 @@ Model settings
     OutputControl.is_budget_output
     OutputControl.write
     OutputControl.from_file
-    OutputControl.to_netcdf
+    OutputControl.to_file
     OutputControl.copy
     OutputControl.clip_box
     OutputControl.mask
@@ -138,7 +138,7 @@ Model settings
     Solution
     Solution.write
     Solution.from_file
-    Solution.to_netcdf
+    Solution.to_file
     Solution.copy
     Solution.clip_box
     Solution.mask
@@ -159,7 +159,7 @@ Flow Packages
     ApiPackage
     ApiPackage.write
     ApiPackage.from_file
-    ApiPackage.to_netcdf
+    ApiPackage.to_file
     ApiPackage.copy
     ApiPackage.is_empty
     ApiPackage.get_regrid_methods
@@ -169,7 +169,7 @@ Flow Packages
     Buoyancy
     Buoyancy.write
     Buoyancy.from_file
-    Buoyancy.to_netcdf
+    Buoyancy.to_file
     Buoyancy.copy
     Buoyancy.is_empty
     Buoyancy.get_regrid_methods
@@ -184,7 +184,7 @@ Flow Packages
     ConstantHead.clip_box
     ConstantHead.write
     ConstantHead.from_file
-    ConstantHead.to_netcdf
+    ConstantHead.to_file
     ConstantHead.copy
     ConstantHead.is_empty
     ConstantHead.get_regrid_methods
@@ -196,7 +196,7 @@ Flow Packages
     Drainage.clip_box
     Drainage.write
     Drainage.from_file
-    Drainage.to_netcdf
+    Drainage.to_file
     Drainage.copy
     Drainage.is_empty
     Drainage.get_regrid_methods
@@ -208,7 +208,7 @@ Flow Packages
     Evapotranspiration.clip_box
     Evapotranspiration.write
     Evapotranspiration.from_file
-    Evapotranspiration.to_netcdf
+    Evapotranspiration.to_file
     Evapotranspiration.copy
     Evapotranspiration.is_empty
     Evapotranspiration.get_regrid_methods
@@ -220,7 +220,7 @@ Flow Packages
     GeneralHeadBoundary.clip_box
     GeneralHeadBoundary.write
     GeneralHeadBoundary.from_file
-    GeneralHeadBoundary.to_netcdf
+    GeneralHeadBoundary.to_file
     GeneralHeadBoundary.copy
     GeneralHeadBoundary.is_empty
     GeneralHeadBoundary.get_regrid_methods
@@ -232,7 +232,7 @@ Flow Packages
     HorizontalFlowBarrierHydraulicCharacteristic.snap_to_grid
     HorizontalFlowBarrierHydraulicCharacteristic.write
     HorizontalFlowBarrierHydraulicCharacteristic.from_file
-    HorizontalFlowBarrierHydraulicCharacteristic.to_netcdf
+    HorizontalFlowBarrierHydraulicCharacteristic.to_file
     HorizontalFlowBarrierHydraulicCharacteristic.copy
     HorizontalFlowBarrierHydraulicCharacteristic.is_empty
     HorizontalFlowBarrierHydraulicCharacteristic.get_regrid_methods
@@ -244,7 +244,7 @@ Flow Packages
     HorizontalFlowBarrierMultiplier.snap_to_grid
     HorizontalFlowBarrierMultiplier.write
     HorizontalFlowBarrierMultiplier.from_file
-    HorizontalFlowBarrierMultiplier.to_netcdf
+    HorizontalFlowBarrierMultiplier.to_file
     HorizontalFlowBarrierMultiplier.copy
     HorizontalFlowBarrierMultiplier.is_empty
     HorizontalFlowBarrierMultiplier.get_regrid_methods
@@ -257,7 +257,7 @@ Flow Packages
     HorizontalFlowBarrierResistance.snap_to_grid
     HorizontalFlowBarrierResistance.write
     HorizontalFlowBarrierResistance.from_file
-    HorizontalFlowBarrierResistance.to_netcdf
+    HorizontalFlowBarrierResistance.to_file
     HorizontalFlowBarrierResistance.copy
     HorizontalFlowBarrierResistance.is_empty
     HorizontalFlowBarrierResistance.get_regrid_methods
@@ -273,7 +273,7 @@ Flow Packages
     LayeredWell.clip_box
     LayeredWell.write
     LayeredWell.from_file
-    LayeredWell.to_netcdf
+    LayeredWell.to_file
     LayeredWell.copy
     LayeredWell.is_empty
     LayeredWell.get_regrid_methods
@@ -284,7 +284,7 @@ Flow Packages
     InitialConditions.clip_box
     InitialConditions.write
     InitialConditions.from_file
-    InitialConditions.to_netcdf
+    InitialConditions.to_file
     InitialConditions.copy
     InitialConditions.is_empty
     InitialConditions.get_regrid_methods
@@ -295,7 +295,7 @@ Flow Packages
     NodePropertyFlow.clip_box
     NodePropertyFlow.write
     NodePropertyFlow.from_file
-    NodePropertyFlow.to_netcdf
+    NodePropertyFlow.to_file
     NodePropertyFlow.copy
     NodePropertyFlow.is_empty
     NodePropertyFlow.get_regrid_methods
@@ -307,7 +307,7 @@ Flow Packages
     Recharge.clip_box
     Recharge.write
     Recharge.from_file
-    Recharge.to_netcdf
+    Recharge.to_file
     Recharge.copy
     Recharge.is_empty
     Recharge.get_regrid_methods
@@ -321,7 +321,7 @@ Flow Packages
     River.clip_box
     River.write
     River.from_file
-    River.to_netcdf
+    River.to_file
     River.copy
     River.is_empty
     River.get_regrid_methods
@@ -333,7 +333,7 @@ Flow Packages
     SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.snap_to_grid
     SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.write
     SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.from_file
-    SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.to_netcdf
+    SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.to_file
     SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.copy
     SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.is_empty
     SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.get_regrid_methods
@@ -345,7 +345,7 @@ Flow Packages
     SingleLayerHorizontalFlowBarrierMultiplier.snap_to_grid
     SingleLayerHorizontalFlowBarrierMultiplier.write
     SingleLayerHorizontalFlowBarrierMultiplier.from_file
-    SingleLayerHorizontalFlowBarrierMultiplier.to_netcdf
+    SingleLayerHorizontalFlowBarrierMultiplier.to_file
     SingleLayerHorizontalFlowBarrierMultiplier.copy
     SingleLayerHorizontalFlowBarrierMultiplier.is_empty
     SingleLayerHorizontalFlowBarrierMultiplier.get_regrid_methods
@@ -359,7 +359,7 @@ Flow Packages
     SingleLayerHorizontalFlowBarrierResistance.snap_to_grid
     SingleLayerHorizontalFlowBarrierResistance.write
     SingleLayerHorizontalFlowBarrierResistance.from_file
-    SingleLayerHorizontalFlowBarrierResistance.to_netcdf
+    SingleLayerHorizontalFlowBarrierResistance.to_file
     SingleLayerHorizontalFlowBarrierResistance.copy
     SingleLayerHorizontalFlowBarrierResistance.is_empty
     SingleLayerHorizontalFlowBarrierResistance.get_regrid_methods
@@ -371,7 +371,7 @@ Flow Packages
     SpecificStorage.clip_box
     SpecificStorage.write
     SpecificStorage.from_file
-    SpecificStorage.to_netcdf
+    SpecificStorage.to_file
     SpecificStorage.copy
     SpecificStorage.is_empty
     SpecificStorage.get_regrid_methods
@@ -382,7 +382,7 @@ Flow Packages
     StorageCoefficient.clip_box
     StorageCoefficient.write
     StorageCoefficient.from_file
-    StorageCoefficient.to_netcdf
+    StorageCoefficient.to_file
     StorageCoefficient.copy
     StorageCoefficient.is_empty
     StorageCoefficient.get_regrid_methods
@@ -392,14 +392,14 @@ Flow Packages
     UnsaturatedZoneFlow.regrid_like
     UnsaturatedZoneFlow.write
     UnsaturatedZoneFlow.from_file
-    UnsaturatedZoneFlow.to_netcdf
+    UnsaturatedZoneFlow.to_file
     UnsaturatedZoneFlow.copy
     UnsaturatedZoneFlow.is_empty
     UnsaturatedZoneFlow.get_regrid_methods
     Viscosity
     Viscosity.write
     Viscosity.from_file
-    Viscosity.to_netcdf
+    Viscosity.to_file
     Viscosity.copy
     Viscosity.is_empty
     Viscosity.get_regrid_methods
@@ -415,7 +415,7 @@ Flow Packages
     Well.clip_box
     Well.write
     Well.from_file
-    Well.to_netcdf
+    Well.to_file
     Well.copy
     Well.is_empty
     Well.get_regrid_methods
@@ -430,64 +430,64 @@ Transport Packages
     AdvectionCentral
     AdvectionCentral.write
     AdvectionCentral.from_file
-    AdvectionCentral.to_netcdf
+    AdvectionCentral.to_file
     AdvectionCentral.copy
     AdvectionCentral.is_empty
     AdvectionCentral.get_regrid_methods
     AdvectionTVD
     AdvectionTVD.write
     AdvectionTVD.from_file
-    AdvectionTVD.to_netcdf
+    AdvectionTVD.to_file
     AdvectionTVD.copy
     AdvectionTVD.is_empty
     AdvectionTVD.get_regrid_methods
     AdvectionUpstream
     AdvectionUpstream.write
     AdvectionUpstream.from_file
-    AdvectionUpstream.to_netcdf
+    AdvectionUpstream.to_file
     AdvectionUpstream.copy
     AdvectionUpstream.is_empty
     AdvectionUpstream.get_regrid_methods
     ConstantConcentration
     ConstantConcentration.write
     ConstantConcentration.from_file
-    ConstantConcentration.to_netcdf
+    ConstantConcentration.to_file
     ConstantConcentration.copy
     ConstantConcentration.is_empty
     ConstantConcentration.get_regrid_methods
     Dispersion
     Dispersion.write
     Dispersion.from_file
-    Dispersion.to_netcdf
+    Dispersion.to_file
     Dispersion.copy
     Dispersion.is_empty
     Dispersion.get_regrid_methods
     ImmobileStorageTransfer
     ImmobileStorageTransfer.write
     ImmobileStorageTransfer.from_file
-    ImmobileStorageTransfer.to_netcdf
+    ImmobileStorageTransfer.to_file
     ImmobileStorageTransfer.copy
     ImmobileStorageTransfer.is_empty
     ImmobileStorageTransfer.get_regrid_methods
     MobileStorageTransfer
     MobileStorageTransfer.write
     MobileStorageTransfer.from_file
-    MobileStorageTransfer.to_netcdf
+    MobileStorageTransfer.to_file
     MobileStorageTransfer.copy
     MobileStorageTransfer.is_empty
     MobileStorageTransfer.get_regrid_methods
     MassSourceLoading
     MassSourceLoading.write
     MassSourceLoading.from_file
-    MassSourceLoading.to_netcdf
+    MassSourceLoading.to_file
     MassSourceLoading.copy
     MassSourceLoading.is_empty
     MassSourceLoading.get_regrid_methods
     SourceSinkMixing
     SourceSinkMixing.from_flow_model
     SourceSinkMixing.write
     SourceSinkMixing.from_file
-    SourceSinkMixing.to_netcdf
+    SourceSinkMixing.to_file
     SourceSinkMixing.copy
     SourceSinkMixing.is_empty
     SourceSinkMixing.get_regrid_methods

imod/common/interfaces/ipackage.py

@@ -34,8 +34,3 @@ def _is_regridding_supported(self) -> bool:
     @abstractmethod
     def _is_grid_agnostic_package(self) -> bool:
         raise NotImplementedError
-
-    @property
-    @abc.abstractmethod
-    def pkg_id(self) -> str:
-        raise NotImplementedError

imod/common/interfaces/ipackagebase.py

@@ -24,3 +24,8 @@ def dataset(self, value: xr.Dataset) -> None:
     @abstractmethod
     def _from_dataset(cls, ds: GridDataset):
         raise NotImplementedError
+
+    @property
+    @abstractmethod
+    def pkg_id(self) -> str:
+        raise NotImplementedError

imod/common/interfaces/ipackageserializer.py

@@ -0,0 +1,12 @@
+import abc
+from pathlib import Path
+
+from imod.common.interfaces.ipackagebase import IPackageBase
+
+
+class IPackageSerializer(metaclass=abc.ABCMeta):
+    @abc.abstractmethod
+    def to_file(
+        self, pkg: IPackageBase, directory: Path, file_name: str, **kwargs
+    ) -> Path:
+        raise NotImplementedError

imod/common/serializer/__init__.py

@@ -0,0 +1,21 @@
+from typing import Literal, TypeAlias
+
+from imod.common.interfaces.ipackageserializer import IPackageSerializer
+from imod.common.serializer.netcdfserializer import NetCDFSerializer
+from imod.common.serializer.zarrserializer import ZarrSerializer
+
+EngineType: TypeAlias = Literal["netcdf4", "zarr", "zarr.zip"]
+
+
+def create_package_serializer(
+    engine: EngineType, mdal_compliant: bool = False, crs: str | None = None
+) -> IPackageSerializer:
+    match engine:
+        case "netcdf4":
+            return NetCDFSerializer(mdal_compliant=mdal_compliant, crs=crs)
+        case "zarr":
+            return ZarrSerializer(use_zip=False)
+        case "zarr.zip":
+            return ZarrSerializer(use_zip=True)
+        case _:
+            raise ValueError(f"Unrecognized engine: {engine}")