Skip to main content

Work with iMOD MODFLOW models

Project description

Work with iMOD MODFLOW models in Python.

Documentation: https://deltares.gitlab.io/imod-python/

Source code: https://gitlab.com/deltares/imod-python

Getting started

import imod

# read and write IPF files to pandas DataFrame
df = imod.ipf.load('wells.ipf')
imod.ipf.save('wells-out.ipf', df)

# get all calculated heads in a xarray DataArray
# with dimensions time, layer, y, x
da = imod.idf.load('path/to/results/head_*.idf')

Introduction

The imod Python package is an addition to iMOD and iMODFLOW, intended to facilitate working with groundwater models from Python. It does this by supporting reading and writing of the different iMOD file formats to existing objects often used in Python data processing.

IDF - iMOD Data Format

IDF is the binary raster format of iMOD. One file contains a X and Y 2 dimensional grid. Using a set of file name conventions more dimensions such as time and layer are added, for example: head_20181113_l3.idf for layer 3 and timestamp 2018-11-13. This package maps IDF files to and from the N dimensional labeled arrays of xarray.DataArray, using imod.idf.load and imod.idf.save, or, to read multiple parameters at the same time, imod.idf.loadset.

For more information on how to work with xarray.DataArray objects, we refer to the xarray documentation. Note that converting GIS raster formats to IDF is supported through xarray.open_rasterio, followed by imod.idf.save.

IPF - iMOD Point File

IPF files are text files used for storing tabular point data such as timeseries and borehole measurements. In the imod Python package these files are read in as pandas.DataFrame. Pandas is a popular package that makes analysis and processing of tabular data easy, and provides many input and output options, which in turn enables us to convert for instance existing CSV or Excel files to IPF files. The primary functions for reading and writing IPF files are imod.ipf.load and imod.ipf.save.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
imod-0.4.3-py3-none-any.whl (32.1 kB) Copy SHA256 hash SHA256 Wheel py3
imod-0.4.3.tar.gz (44.4 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page