The DOI matches its Crossref record.
Reproducible large-scale groundwater modelling projects using the iMOD Python package
Abstract
Introduction Scripting has many benefits for groundwater model development: scripts form transparent reproducible steps and enable easy automation of many tasks. The Python scientific ecosystem provides a wealth of open source libraries and make Python particularly suited for model development. However, we require additional tools to create reproducible large-scale groundwater model projects. Handling the large scale – iMOD Python Regional models in the Netherlands are characterized by large size of input and output files; FloPy (Bakker et al. 2016) is not especially tailored to such use. We’ve built the iMOD Python package on top of modern Python packages such as xarray (Hoyer & Hamman, 2017) to provide greater convenience and performance. Xarray labels dimensions with coordinates for geospatial datasets, supports out of memory computation, reads and writes NetCDF files. The iMOD Python package (https://gitlab.com/deltares/imod/imod-python) provides the connection to model specific file formats (iMOD & MODFLOW6) and a number of additional utilities such as efficient regridding, GIS operations, and visualization. Reproducible projects – Git, DVC & Snakemake Our goal is to make entire model projects reproducible. Scripting succeeds in making individual steps of the complex model development process reproducible, but not completely. We use Snakemake (Köster & Rahmann, 2012) as workflow manager to rally individual scripts into an explicit workflow. Snakemake automatically determines dependencies between the different steps, and will detect which part of a workflow needs to be executed when e.g. some input data or steps change. Code and data version control keeps track of the history project. It functions as a log book of past decisions, but also allows reverting the project to a previous state with one command, which allows for an easy comparison between the results of two versions of the project. This is crucial for projects with a multiple-year duration and/or projects with multiple contributors. Online code repositories allow sharing of files, and further support collaboration with issue boards and by making code browsable. In this presentation we will present a reproducible project of a regional model, using open-source tools. The project is shared on Gitlab (https://gitlab.com/deltares/imod/california_model), where a user can pull the code to their machine, using the version control software Git (Chacon & Staub, 2014). Consequently, the user can fetch the data onto their machine with data version control software DVC (https://dvc.org/). The complete workflow from raw data to 3D images of the model output heavily relies on iMOD Python and is executed with Snakemake. References Bakker, M., Post, V., Langevin, C. D., Hughes, J. D., White, J. T., Starn, J. J., & Fienen, M. N. (2016). Scripting MODFLOW Model Development Using Python and FloPy. Groundwater. https://doi.org/10.1111/gwat.12413 Chacon, S., & Straub, B. (2014). Pro Git. Pro Git (2nd ed.). Apress. https://doi.org/10.1007/978-1-4302-1834-0 Hoyer, S., & Hamman, J. J. (2017). xarray: N-D labeled Arrays and Datasets in Python. Journal of Open Research Software, 5, 1–6. https://doi.org/10.5334/jors.148 Köster, J., & Rahmann, S. (2012). Snakemake-a scalable bioinformatics workflow engine. Bioinformatics, 28(19), 2520–2522. https://doi.org/10.1093/bioinformatics/bts480
Overview
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Integrity signals
Registry
Cites
Statistics
Verification
Claims the paper makes
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Claims other papers make about this one
Each is checked against this paper’s own text: does it say what the citing paper says it does?
In the citing paper
“For groundwater modeling the FloPy (Bakker et al., 2016) and iMOD-Python (Engelen et al., 2022) packages provide scripting interfaces to automatically setup instances of the groundwater model MODFLOW (Harbaugh, 2005).”
From HydroMT: Automated and reproducible model building and analysis (2023) · cites this paper as Engelen et al., 2022
Self-check
Percentages, sums and reported differences re-computed from the paper’s own numbers.
The self-check needs the paper’s full text.
Citations
Cited by
HydroMT: Automated and reproducible model building and analysis
Eilander, D., Boisgontier, H., Bouaziz, L. J. E., Buitink, J., Couasnon, A., Dalmijn, B., Hegnauer, M., de Jong, T., Loos, S., Marth, I., et al. (2023) · Journal of Open Source Software · doi:10.21105/joss.04897 · Cited by 53
Metadata
- Authors
- van Engelen, J., Delsman, J., & Bootsma, H.
- Publisher
- Copernicus GmbH
- Published
- 2022-03-27
- Cited by
- 1
- References
- 0
About these checks
Registry, retraction, Cites and statistics results are computed, not judged, with one exception: a printed reference that no index lists is read once by a model before it counts as a citation error. Claims are extracted by a model and kept only when their quote appears verbatim in the text; each cited source is then checked, with a model’s help, for whether it says what the claim relies on. Those verdicts can be wrong — read the claim’s quote and the cited source before relying on one.
Statistics and arithmetic are recomputed, not judged.
Confidence bands are shown only for fields calibrated on our annotated test set. None is calibrated yet, so no band is shown.
What counts as a claim ›How we measure confidence ›How we check this ›
Are you an author, or do you see a problem with this page? Request a review
Data sources
Bibliographic data: Semantic Scholar, OpenAlex, Crossref.
Contains information from the Semantic Scholar Academic Graph Datasets, made available under the ODC Attribution License (ODC-BY 1.0).
Semantic Scholar’s data is described in: Kinney, R., et al. (2023). The Semantic Scholar Open Data Platform. arXiv:2301.10140.