MetaMod

MetaMod(msw_model, mf6_simulation, coupling_list)

Couple MetaSWAP and MODFLOW 6.

Parameters

Name	Type	Description	Default
msw_model	MetaSwapModel	The MetaSWAP model that should be coupled.	required
mf6_simulation	Modflow6Simulation	The Modflow6 simulation that should be coupled.	required
coupling_list	Sequence[MetaModDriverCoupling]	One entry per MODFLOW 6 model that should be coupled	required

Methods

Name	Description
write	Write MetaSWAP and Modflow 6 model with exchange files, as well as a
write_toml	Write .toml file which configures the imod coupler run.

write

MetaMod.write(
    directory,
    modflow6_dll,
    metaswap_dll,
    metaswap_dll_dependency,
    modflow6_write_kwargs=None,
)

Write MetaSWAP and Modflow 6 model with exchange files, as well as a .toml file which configures the imod coupler run.

Parameters

Name	Type	Description	Default
directory	str | Path	Directory in which to write the coupled models	required
modflow6_dll	str | Path	Path to modflow6 .dll. You can obtain this library by downloading the last iMOD5 release <https://oss.deltares.nl/web/imod/download-imod5>_	required
metaswap_dll	str | Path	Path to metaswap .dll. You can obtain this library by downloading the last iMOD5 release <https://oss.deltares.nl/web/imod/download-imod5>_	required
metaswap_dll_dependency	str | Path	Directory with metaswap .dll dependencies. Directory should contain: [fmpich2.dll, mpich2mpi.dll, mpich2nemesis.dll, TRANSOL.dll]. You can obtain these by downloading the last iMOD5 release <https://oss.deltares.nl/web/imod/download-imod5>_	required
modflow6_write_kwargs	dict[str, Any] | None	Optional dictionary with keyword arguments for the writing of Modflow6 models. You can use this for example to turn off the validation at writing (validation=False) or to write text files (binary=False)	None

write_toml

MetaMod.write_toml(
    directory,
    modflow6_dll,
    metaswap_dll,
    metaswap_dll_dependency,
    coupling_dict,
)

Write .toml file which configures the imod coupler run.

Parameters

Name	Type	Description	Default
directory	str | Path	Directory in which to write the .toml file.	required
modflow6_dll	str | Path	Path to modflow6 .dll. You can obtain this library by downloading the last iMOD5 release <https://oss.deltares.nl/web/imod/download-imod5>_	required
metaswap_dll	str | Path	Path to metaswap .dll. You can obtain this library by downloading the last iMOD5 release <https://oss.deltares.nl/web/imod/download-imod5>_	required
metaswap_dll_dependency	str | Path	Directory with metaswap .dll dependencies. Directory should contain: [fmpich2.dll, mpich2mpi.dll, mpich2nemesis.dll, TRANSOL.dll]. You can obtain these by downloading the last iMOD5 release <https://oss.deltares.nl/web/imod/download-imod5>_	required
coupling_dict	dict[str, Any]	Dictionary with names of coupler packages and paths to mappings.	required