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
Issues
Deltares colleagues can find the issue tracker at Jira
Contributing
In order to develop on imod_coupler
locally, please follow the following steps:
-
Download and install miniconda.
-
Initialize
conda
by running the following in theMiniconda prompt
:
conda init
- Depending on your company settings, you might also have to run the following in a Powershell terminal run as administrator:
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned
- Create the environment by executing the following in your terminal:
conda env create --file=environment.yml
- Activate the environment
conda activate imod_coupler
- Install
imod_coupler
by executing (this will also put the executableimodc
in yourPATH
):
pip install -e .
-
With your Deltares credentials download
- the latest imod_collector, and
- the regression imod_collector.
-
Unpack the two zip files in a path of your choice and name the latest
imod_collector_devel
and the regressionimod_collector_regression
. -
Check out the MetaSWAP lookup table with your Deltares credentials which resides at
https://repos.deltares.nl/repos/DSCTestbench/trunk/cases/e150_metaswap/f00_common/c00_common/LHM2016_v01vrz
-
To run the tests it is advisable to have a
.env
file at the root of the project directory instead of modifying global environment variables. The content of.env
would then look similar to this with the variablesIMOD_COLLECTOR_DEVEL
,IMOD_COLLECTOR_REGRESSION
andMETASWAP_LOOKUP_TABLE
adjusted to your local machine:
IMOD_COLLECTOR_DEVEL='D:\checkouts\imod_collector_devel'
IMOD_COLLECTOR_REGRESSION='D:\checkouts\imod_collector_regression'
METASWAP_LOOKUP_TABLE='D:\checkouts\DSCtestbench\cases\e150_metaswap\f00_common\c00_common\LHM2016_v01vrz'
IMOD_COUPLER_EXEC_DEVEL='imodc' # Specify an absolute path here to use a packaged version of iMOD Coupler
IMOD_COUPLER_EXEC_REGRESSION='${IMOD_COLLECTOR_REGRESSION}/imodc.exe'
METASWAP_DLL_DEP_DIR_DEVEL='${IMOD_COLLECTOR_DEVEL}'
METASWAP_DLL_DEP_DIR_REGRESSION='${IMOD_COLLECTOR_REGRESSION}'
METASWAP_DLL_DEVEL='${IMOD_COLLECTOR_DEVEL}/MetaSWAP.dll'
METASWAP_DLL_REGRESSION='${IMOD_COLLECTOR_REGRESSION}/MetaSWAP.dll'
MODFLOW_DLL_DEVEL='${IMOD_COLLECTOR_REGRESSION}/libmf6.dll'
MODFLOW_DLL_REGRESSION='${IMOD_COLLECTOR_REGRESSION}/libmf6.dll'
- The tests can then be run with:
pytest tests -n=auto --basetemp=tests/temp
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.11.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28ad30e93685141e480cb633f23618160956f41a6a653cf79289cf39b8f564ef |
|
MD5 | fe698d592487eb685e10391508078b68 |
|
BLAKE2b-256 | b8cfdd88aa2d598d7fcf60358f30683d56206d9830c2fcc3fba72083f725d841 |