RibaMod

RibaMod(self, ribasim_model, mf6_simulation, coupling_list)

Couple Ribasim and MODFLOW 6.

Parameters

Name	Type	Description	Default
ribasim_model	ribasim.model	The Ribasim model that should be coupled.	required
mf6_simulation	Modflow6Simulation	The Modflow6 simulation that should be coupled.	required
coupling_list	Sequence[RibaModDriverCoupling]	One entry per MODFLOW 6 model that should be coupled	required

Methods

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

write

RibaMod.write(
    directory
    modflow6_dll
    ribasim_dll
    ribasim_dll_dependency
    modflow6_write_kwargs=None
)

Write Ribasim 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
ribasim_dll	str | Path	Path to ribasim .dll.	required
ribasim_dll_dependency	str | Path	Directory with ribasim .dll dependencies.	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

RibaMod.write_toml(
    directory
    coupling_dict
    modflow6_dll
    ribasim_dll
    ribasim_dll_dependency
)

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
ribasim_dll	str | Path	Path to ribasim .dll.	required
ribasim_dll_dependency	str | Path	Directory with ribasim .dll dependencies.	required