| Name | nlmod JSON |
| Version |
0.7.2
JSON |
| download |
| home_page | |
| Summary | Python package to build, run and visualize MODFLOW 6 groundwater models in the Netherlands. |
| upload_time | 2024-01-04 11:25:42 |
| maintainer | |
| docs_url | None |
| author | O. Ebbens, R. Caljé, D.A. Brakenhoff |
| requires_python | >=3.8 |
| license | The MIT License (MIT) Copyright (c) 2020 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. |
| keywords |
hydrology
groundwater
modeling
modflow 6
flopy
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# nlmod
<img src="docs/_static/logo_10000_2.png" width="256"/>
[](https://github.com/gwmod/nlmod/actions/workflows/ci.yml)
[](https://app.codacy.com/gh/gwmod/nlmod/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://app.codacy.com/gh/gwmod/nlmod/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
[](https://badge.fury.io/py/nlmod)
[](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/.
## 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`
There are some optional dependecies, only needed (and imported) in a single method.
Examples of this are `bottleneck` (used in calculate_gxg), `geocube` (used in
add_min_ahn_to_gdf), `h5netcdf` (used for hdf5 files backend in xarray), `scikit-image`
(used in 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](https://github.com/ArtesiaWater/hydropandas#dependencies) section of the
`hydropandas` package for more information on how to install these packages manually.
## Getting started
If you are using `nlmod` for the first time you need to download the MODFLOW
executables. You can easily download these executables by running this Python code:
import nlmod
nlmod.download_mfbinaries()
After you've downloaded the executables you can run the Jupyter Notebooks in the
examples folder. These notebooks illustrate how to use the `nlmod` package.
Raw data
{
"_id": null,
"home_page": "",
"name": "nlmod",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "\"O. Ebbens\" <o.ebbens@artesia-water.nl>, \"R. Calje\" <r.calje@artesia-water.nl>, \"D.A. Brakenhoff\" <d.brakenhoff@artesia-water.nl>",
"keywords": "hydrology,groundwater,modeling,Modflow 6,flopy",
"author": "O. Ebbens, R. Calj\u00e9, D.A. Brakenhoff",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/63/c3/0a5e94fdf9e41e0ead4a99dca2a619eef66ede8e3c32b3e44a43f127bba1/nlmod-0.7.2.tar.gz",
"platform": null,
"description": "# nlmod\n\n<img src=\"docs/_static/logo_10000_2.png\" width=\"256\"/>\n\n[](https://github.com/gwmod/nlmod/actions/workflows/ci.yml)\n[](https://app.codacy.com/gh/gwmod/nlmod/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)\n[](https://app.codacy.com/gh/gwmod/nlmod/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)\n[](https://badge.fury.io/py/nlmod)\n[](https://nlmod.readthedocs.io/en/stable/?badge=stable)\n\nPython package to build, run and visualize MODFLOW 6 groundwater models in the Netherlands.\n\n`nlmod` was built to allow users to write scripts to quickly download relevant data\nfrom publicly available sources, and build and post-process groundwater flow and\ntransport models at different spatial and temporal scales to answer specific\ngeohydrological questions. Scripting these steps, from downloading data to building\ngroundwater models, makes models more reproducible and transparent.\n\nThe functions in `nlmod` have four main objectives:\n\n1. Create and adapt the temporal and spatial discretization of a MODFLOW model using an xarray Dataset (`nlmod.dims`).\n2. Download and read data from external sources, project this data on the modelgrid and add this data to an xarray Dataset (`nlmod.read`).\n3. 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).\n4. Visualise modeldata in Python (`nlmod.plot`) or GIS software (`nlmod.gis`).\n\nMore information can be found on the documentation-website:\nhttps://nlmod.readthedocs.io/.\n\n## Installation\n\nInstall the module with pip:\n\n`pip install nlmod`\n\n`nlmod` has the following required dependencies: \n\n* `flopy`\n* `xarray`\n* `netcdf4`\n* `rasterio`\n* `rioxarray`\n* `affine`\n* `geopandas`\n* `owslib`\n* `hydropandas`\n* `shapely`\n* `pyshp`\n* `rtree`\n* `matplotlib`\n* `dask`\n* `colorama`\n* `joblib`\n\nThere are some optional dependecies, only needed (and imported) in a single method.\nExamples of this are `bottleneck` (used in calculate_gxg), `geocube` (used in\nadd_min_ahn_to_gdf), `h5netcdf` (used for hdf5 files backend in xarray), `scikit-image`\n(used in calculate_sea_coverage). To install `nlmod` with the optional dependencies use:\n\n`pip install nlmod[full]`\n\nWhen using pip the dependencies are automatically installed. Some dependencies are\nnotoriously hard to install on certain platforms. Please see the\n[dependencies](https://github.com/ArtesiaWater/hydropandas#dependencies) section of the\n`hydropandas` package for more information on how to install these packages manually.\n\n## Getting started\n\nIf you are using `nlmod` for the first time you need to download the MODFLOW\nexecutables. You can easily download these executables by running this Python code:\n\n import nlmod\n\tnlmod.download_mfbinaries()\n\nAfter you've downloaded the executables you can run the Jupyter Notebooks in the\nexamples folder. These notebooks illustrate how to use the `nlmod` package.\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2020 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. ",
"summary": "Python package to build, run and visualize MODFLOW 6 groundwater models in the Netherlands.",
"version": "0.7.2",
"project_urls": {
"documentation": "https://nlmod.readthedocs.io/en/latest/",
"homepage": "https://github.com/gwmod/nlmod",
"repository": "https://github.com/gwmod/nlmod"
},
"split_keywords": [
"hydrology",
"groundwater",
"modeling",
"modflow 6",
"flopy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5a5ab1fb01416e8f3907a8c6ab6cfab88f25a24e14b19e5afc91a52bdc443fa9",
"md5": "42a25f65c0bf413177e2a8826c784d82",
"sha256": "ee9c5484374fbdf2c510de9a8ab02ec5d26349dc862ed477383f4a9fd9be865c"
},
"downloads": -1,
"filename": "nlmod-0.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "42a25f65c0bf413177e2a8826c784d82",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2721457,
"upload_time": "2024-01-04T11:25:40",
"upload_time_iso_8601": "2024-01-04T11:25:40.464573Z",
"url": "https://files.pythonhosted.org/packages/5a/5a/b1fb01416e8f3907a8c6ab6cfab88f25a24e14b19e5afc91a52bdc443fa9/nlmod-0.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "63c30a5e94fdf9e41e0ead4a99dca2a619eef66ede8e3c32b3e44a43f127bba1",
"md5": "5257c7edd031b8564ef9c12c40c631dc",
"sha256": "ba5285171784c6f3a588d6df023a870a6153dada4bf83e6f035d38cb88fb6ff2"
},
"downloads": -1,
"filename": "nlmod-0.7.2.tar.gz",
"has_sig": false,
"md5_digest": "5257c7edd031b8564ef9c12c40c631dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2688128,
"upload_time": "2024-01-04T11:25:42",
"upload_time_iso_8601": "2024-01-04T11:25:42.561549Z",
"url": "https://files.pythonhosted.org/packages/63/c3/0a5e94fdf9e41e0ead4a99dca2a619eef66ede8e3c32b3e44a43f127bba1/nlmod-0.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-04 11:25:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gwmod",
"github_project": "nlmod",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nlmod"
}
