Data

Tools

Indexes

Applications

Experiments

Open Source Science

nlmod

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

https://github.com/gwmod/nlmod

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary

Keywords

flopy geopandas groundwater groundwater-modelling hydrogeology hydrology modflow python xarray

Keywords from Contributors

pastas
Last synced: 6 months ago · JSON representation

Repository

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

Basic Info
Statistics
  • Stars: 41
  • Watchers: 9
  • Forks: 6
  • Open Issues: 57
  • Releases: 25
Topics
flopy geopandas groundwater groundwater-modelling hydrogeology hydrology modflow python xarray
Created about 5 years ago · Last pushed 6 months ago
Metadata Files
Readme License

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.zonalstatistics), h5netcdf (used for hdf5 files backend in xarray), scikit-image (used in nlmod.read.rws.calculatesea_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

  • Name: gwmod
  • Login: gwmod
  • Kind: organization

GitHub Events

Total
  • Create event: 61
  • Release event: 3
  • Issues event: 75
  • Watch event: 8
  • Delete event: 52
  • Issue comment event: 159
  • Push event: 293
  • Pull request review comment event: 102
  • Pull request event: 114
  • Pull request review event: 159
  • Fork event: 4
Last Year
  • Create event: 61
  • Release event: 3
  • Issues event: 75
  • Watch event: 8
  • Delete event: 52
  • Issue comment event: 159
  • Push event: 294
  • Pull request review comment event: 102
  • Pull request event: 115
  • Pull request review event: 159
  • Fork event: 4

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 1,451
  • Total Committers: 10
  • Avg Commits per committer: 145.1
  • Development Distribution Score (DDS): 0.626
Past Year
  • Commits: 300
  • Committers: 8
  • Avg Commits per committer: 37.5
  • Development Distribution Score (DDS): 0.58
Top Committers
Name Email Commits
OnnoEbbens o****s@g****m 543
dbrakenhoff d****f@a****l 456
Ruben Caljé r****e@a****l 362
Bas des Tombe b****e@g****m 53
martinvonk v****t@g****m 20
Martin Vonk 6****k@u****m 7
ArtesiaWater i****o@a****l 5
Artesia Water 3****r@u****m 3
Mattijs Borst 4****t@u****m 1
marcovanbaar 4****r@u****m 1
Committer Domains (Top 20 + Academic)
artesia-water.nl: 3

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 145
  • Total pull requests: 203
  • Average time to close issues: 3 months
  • Average time to close pull requests: 8 days
  • Total issue authors: 14
  • Total pull request authors: 6
  • Average comments per issue: 1.39
  • Average comments per pull request: 1.19
  • Merged pull requests: 177
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 56
  • Pull requests: 121
  • Average time to close issues: 18 days
  • Average time to close pull requests: 10 days
  • Issue authors: 9
  • Pull request authors: 6
  • Average comments per issue: 1.13
  • Average comments per pull request: 1.17
  • Merged pull requests: 98
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • dbrakenhoff (40)
  • OnnoEbbens (34)
  • rubencalje (21)
  • bdestombe (20)
  • martinvonk (8)
  • tomvansteijn (7)
  • vincentpost (3)
  • Arjanvw (3)
  • FransSchaars (1)
  • RdWitte (1)
  • jeroenhelder (1)
  • ArtesiaWater (1)
  • smengual-rhdhv (1)
  • GovertAlkemade (1)
Pull Request Authors
  • dbrakenhoff (73)
  • rubencalje (71)
  • OnnoEbbens (43)
  • bdestombe (41)
  • martinvonk (8)
  • MattBrst (2)
Top Labels
Issue Labels
enhancement (24) documentation (4) caching (3) good first issue (3) bug (3) testing (3) question (1) help wanted (1)
Pull Request Labels
enhancement (17) caching (3) bug (1) documentation (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 771 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 45
  • Total maintainers: 2
proxy.golang.org: github.com/gwmod/nlmod
  • Versions: 22
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
pypi.org: nlmod

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

  • Documentation: https://nlmod.readthedocs.io/
  • License: 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.10.0
    published 7 months ago
  • Versions: 23
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 771 Last month
Rankings
Dependent packages count: 10.1%
Average: 17.2%
Downloads: 20.0%
Dependent repos count: 21.5%
Maintainers (2)
dbrakenhoff Onno
Last synced: 6 months ago

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