https://github.com/gwmod/nlmod

Python package to build, run and visualize MODFLOW 6 groundwater models in the Netherlands.
https://github.com/gwmod/nlmod

flopy geopandas groundwater groundwater-modelling hydrogeology hydrology modflow python xarray

Last synced: about 1 month ago
JSON representation

Python package to build, run and visualize MODFLOW 6 groundwater models in the Netherlands.

• Host: GitHub
• URL: https://github.com/gwmod/nlmod
• Owner: gwmod
• License: mit
• Created: 2020-12-03T14:53:30.000Z (over 5 years ago)
• Default Branch: dev
• Last Pushed: 2025-07-14T11:09:02.000Z (9 months ago)
• Last Synced: 2025-07-17T04:29:46.747Z (9 months ago)
• Topics: flopy, geopandas, groundwater, groundwater-modelling, hydrogeology, hydrology, modflow, python, xarray
• Language: Python
• Homepage: https://nlmod.readthedocs.io
• Size: 54.6 MB
• Stars: 40
• Watchers: 9
• Forks: 6
• Open Issues: 50
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• open-sustainable-technology - nlmod - Python package to build, run and visualize MODFLOW 6 groundwater models in the Netherlands. (Hydrosphere / Freshwater and Hydrology)

README

          
# nlmod

[![nlmod](https://github.com/gwmod/nlmod/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/gwmod/nlmod/actions/workflows/ci.yml)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/f1797b66e98b42b294bc1c5fc233dbf3)](https://app.codacy.com/gh/gwmod/nlmod/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/f1797b66e98b42b294bc1c5fc233dbf3)](https://app.codacy.com/gh/gwmod/nlmod/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)

[![PyPI version](https://badge.fury.io/py/nlmod.svg)](https://badge.fury.io/py/nlmod)

[![Documentation Status](https://readthedocs.org/projects/nlmod/badge/?version=stable)](https://nlmod.readthedocs.io/en/stable/?badge=stable)

Python package to build, run and visualize MODFLOW 6 groundwater models in the Netherlands.

`nlmod` was built to allow users to write scripts to quickly download relevant data

from publicly available sources, and build and post-process groundwater flow and

transport models at different spatial and temporal scales to answer specific

geohydrological questions. Scripting these steps, from downloading data to building

groundwater models, makes models more reproducible and transparent.

The functions in `nlmod` have four main objectives:

1. Create and adapt the temporal and spatial discretization of a MODFLOW model using an 

   xarray Dataset (`nlmod.dims`).

2. Download and read data from external sources, project this data on the modelgrid and 

   add this data to an xarray Dataset (`nlmod.read`).

3. Use data in an xarray Dataset to build modflow packages for both groundwater flow 

   and transport models using FloPy (`nlmod.sim`, `nlmod.gwf` and `nlmod.gwt` for 

   Modflow 6 and `nlmod.modpath` for Modpath).

4. Visualise modeldata in Python (`nlmod.plot`) or GIS software (`nlmod.gis`).

More information can be found on the documentation-website:

https://nlmod.readthedocs.io/.