The imod_coupler can be used to couple hydrological kernels.
Project description
iMOD-coupler
The imod_coupler
is used to couple hydrological kernels.
It currently focuses on groundwater and supports coupling between MetaSWAP and Modflow6.
It can be installed by running
pip install imod_coupler
Then you can run it as command line app via
imodc /path/to/imod_coupler.toml
In order to receive help for its usage, run
imodc --help
Configuration file
The configuration file is necessary to describe the model and its dependencies.
It is in the toml format and should have a .toml
extension.
Note that toml
uses quote marks differently than python
. Single quotes in toml (''
) are interpreted similarly to how python would interpret a rawstring (r''
or r""
), whereas double quotes (""
) are interpreted in a similar manner to regular strings in python (""
or ''
). This matters for paths on Windows, for which we advice to use single quotes.
# This is a configuration file for the imod_coupler
# Relative paths are interpreted as relative to the configuration file path
[kernels]
[kernels.modflow6]
dll = '/path/to/libmf6.dll'
model = '.'
[kernels.metaswap]
dll = '/path/to/MetaSWAP.dll'
model = './GWF_1/MSWAPINPUT'
dll_dependency = '/path/to/MPICHDLL'
[[exchanges]]
# Two kernels per exchange
kernels = ['modflow6', 'metaswap']
Technical Reference
A technical explanation can be found here.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for imod_coupler-0.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1b1aa62fa11f04d1d6a3d1eacf1eb632153a12aba0a8bff199f6dcce5da4769 |
|
MD5 | 2f502b7d5644012bfd0d6dc1b450b83a |
|
BLAKE2b-256 | b21a973e08004879603d72e5f02b8b9425702316a49847784dd5d665ddab0f4c |