Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

nlmod

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

Category: Hydrosphere
Sub Category: Freshwater and Hydrology

Keywords

flopy geopandas groundwater groundwater-modelling hydrogeology hydrology modflow python xarray

Keywords from Contributors

pastas observations arctic data-management multivariate articles poster reports research

Last synced: about 14 hours ago
JSON representation

Repository metadata

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

README.md

nlmod

nlmod
Codacy Badge
Codacy Badge
PyPI version
Documentation Status

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/.

Installation

Install the module with pip:

pip install nlmod

nlmod has the following required dependencies:

  • flopy
  • xarray
  • netcdf4
  • rasterio
  • rioxarray
  • affine
  • geopandas
  • owslib
  • hydropandas
  • shapely
  • pyshp
  • rtree
  • matplotlib
  • dask
  • colorama
  • joblib
  • bottleneck

There are some optional dependecies, only needed (and imported) in a single method.
Examples of this are geocube, rasterstats (both used in nlmod.util.zonal_statistics),
h5netcdf (used for hdf5 files backend in xarray), scikit-image
(used in nlmod.read.rws.calculate_sea_coverage).
To install nlmod with the optional dependencies use:

pip install nlmod[full]

When using pip the dependencies are automatically installed. Some dependencies are
notoriously hard to install on certain platforms. Please see the
dependencies section of the
hydropandas package for more information on how to install these packages manually.

Getting started

Start with the Jupyter Notebooks in the examples folder. These notebooks illustrate how to use the nlmod package.

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 5 days ago

Total Commits: 1,283
Total Committers: 8
Avg Commits per committer: 160.375
Development Distribution Score (DDS): 0.613

Commits in past year: 197
Committers in past year: 7
Avg Commits per committer in past year: 28.143
Development Distribution Score (DDS) in past year: 0.65

Name Email Commits
OnnoEbbens o****s@g****m 496
dbrakenhoff d****f@a****l 374
Ruben Caljé r****e@a****l 344
Bas des Tombe b****e@g****m 48
Martin Vonk v****t@g****m 15
Artesia Water 3****r 4
marcovanbaar 4****r 1
Mattijs Borst 4****t 1

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 143
Total pull requests: 135
Average time to close issues: 3 months
Average time to close pull requests: 6 days
Total issue authors: 14
Total pull request authors: 6
Average comments per issue: 1.72
Average comments per pull request: 1.42
Merged pull request: 122
Bot issues: 0
Bot pull requests: 0

Past year issues: 53
Past year pull requests: 62
Past year average time to close issues: 20 days
Past year average time to close pull requests: 8 days
Past year issue authors: 11
Past year pull request authors: 6
Past year average comments per issue: 1.83
Past year average comments per pull request: 2.0
Past year merged pull request: 54
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/gwmod/nlmod

Top Issue Authors

  • dbrakenhoff (39)
  • OnnoEbbens (34)
  • rubencalje (24)
  • bdestombe (21)
  • tomvansteijn (8)
  • martinvonk (5)
  • vincentpost (3)
  • RdWitte (2)
  • Arjanvw (2)
  • FransSchaars (1)
  • jeroenhelder (1)
  • ArtesiaWater (1)
  • smengual-rhdhv (1)
  • GovertAlkemade (1)

Top Pull Request Authors

  • rubencalje (43)
  • dbrakenhoff (31)
  • OnnoEbbens (30)
  • bdestombe (29)
  • martinvonk (1)
  • MattBrst (1)

Top Issue Labels

  • enhancement (29)
  • testing (7)
  • bug (4)
  • caching (3)
  • good first issue (3)
  • question (3)
  • documentation (3)
  • wontfix (1)
  • help wanted (1)

Top Pull Request Labels

  • enhancement (9)
  • caching (2)
  • bug (1)

Package metadata

pypi.org: nlmod

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

  • Homepage:
  • Documentation: https://nlmod.readthedocs.io/
  • Licenses: The MIT License (MIT) Copyright (c) 2024 O.N. Ebbens, D.A. Brakenhoff, R. Calje Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.9.3 (published about 1 month ago)
  • Last Synced: 2025-04-25T12:08:55.087Z (1 day ago)
  • Versions: 22
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 1,189 Last month
  • Rankings:
    • Dependent packages count: 10.119%
    • Average: 17.205%
    • Downloads: 19.951%
    • Dependent repos count: 21.545%
  • Maintainers (2)

Dependencies

docs/requirements.txt pypi
  • Ipython *
  • ipykernel *
  • nbsphinx *
  • nbsphinx_link *
  • sphinx_rtd_theme *
requirements.txt pypi
  • OWSLib ==0.24.1
  • Shapely >=1.7.1
  • flopy >=3.3.3
  • gdown >=4.4.0
  • geopandas ==0.9.0
  • hydropandas >=0.5.1
  • matplotlib >=3.3.4
  • nbconvert >=6.4.5
  • nbformat >=5.2.0
  • netCDF4 ==1.5.7
  • numpy >=1.20.1
  • pandas >=1.4.1
  • pytest >=6.2.3
  • rasterio ==1.2.6
  • rdp ==0.8
  • requests >=2.25.1
  • rioxarray *
  • scipy >=1.7.3
  • tqdm >=4.59.0
  • xarray >=0.19.0
setup.py pypi
  • flopy >=3.3.2
  • hydropandas >=0.3.0
  • matplotlib *
  • netcdf4 >=1.5.7
  • openpyxl >=3.0.7
  • owslib >=0.24.1
  • pyshp >=2.1.3
  • rasterio >=1.1.0
  • rtree >=0.9.7
  • xarray >=0.16.1
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codacy/codacy-coverage-reporter-action master composite
.github/workflows/python-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish master composite

Score: 13.628737507959714