imod.mf6.GroundwaterFlowModel.from_imod5_data#

classmethod GroundwaterFlowModel.from_imod5_data(imod5_data: dict[str, dict[str, DataArray | UgridDataArray]], period_data: dict[str, list[datetime]], times: list[datetime], allocation_options: SimulationAllocationOptions | None = None, distributing_options: SimulationDistributingOptions | None = None, regridder_types: dict[str, RegridMethodType] | None = None) → GroundwaterFlowModel[source]#

Imports a GroundwaterFlowModel (GWF) from the data in an iMOD5 project file and puts it in a simulation. Quasi-3D iMOD5 models, i.e. models where there is only horizontal flow in aquifers and vertical flow in aquitards, are not supported.

This method adds all static and boundary condition packages from the projectfile to the simulation. Output Control (OC) must be added manually after importing.

Parameters:

  • imod5_data (dict[str, dict[str, GridDataArray]]) – dictionary containing the arrays mentioned in the project file as xarray datasets, under the key of the package type to which it belongs

  • period_data (dict[str, list[datetime]]) – dictionary containing the package names mapped to a list of repeated stress periods. These are set as repeat_stress.

  • times (list[datetime]) –

    Time discretization of the simulation. These times are used for the following:

    • Times of wells with associated timeseries are resampled to these times

    • Start- and end times in the list are used to repeat the stresses of periodic data (e.g. river stages in iMOD5 for “summer”, “winter”)

  • allocation_options (SimulationAllocationOptions) – object containing the allocation options per package type. If you want a package to have a different allocation option, then it should be imported separately

  • distributing_options (SimulationDistributingOptions) – object containing the conductivity distribution options per package type. If you want a package to have a different allocation option, then it should be imported separately

  • regridder_types (dict[str, RegridMethodType]) – the key is the package name. The value is a subclass of RegridMethodType.

Returns:

  • A GWF model containing the packages that could be imported form IMOD5. Users must still

  • add the OC package to the model.