| Name | modflow-setup JSON |
| Version |
0.5.0
JSON |
| download |
| home_page | |
| Summary | Rapid and robust construction of MODFLOW groundwater flow models |
| upload_time | 2024-03-08 21:09:36 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.11 |
| license | License ======= Unless otherwise noted, This project is in the public domain in the United States because it contains materials that originally came from the United States Geological Survey, an agency of the United States Department of Interior. For more information, see the official USGS copyright policy at https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits Additionally, we waive copyright and related rights in the work worldwide through the CC0 1.0 Universal public domain dedication. CC0 1.0 Universal Summary ------------------------- This is a human-readable summary of the [Legal Code (read the full text)][1]. ### No Copyright The person who associated a work with this deed has dedicated the work to the public domain by waiving all of his or her rights to the work worldwide under copyright law, including all related and neighboring rights, to the extent allowed by law. You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission. ### Other Information In no way are the patent or trademark rights of any person affected by CC0, nor are the rights that other persons may have in the work or in how the work is used, such as publicity or privacy rights. Unless expressly stated otherwise, the person who associated a work with this deed makes no warranties about the work, and disclaims liability for all uses of the work, to the fullest extent permitted by applicable law. When using or citing the work, you should not imply endorsement by the author or the affirmer. [1]: https://creativecommons.org/publicdomain/zero/1.0/legalcode |
| keywords |
modflow
groundwater
hydrogeology
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
Modflow-setup
-----------------------------------------------
Modflow-setup is a Python package for automating the setup of MODFLOW groundwater models from grid-independent source data including shapefiles, rasters, and other MODFLOW models that are geo-located. Input data and model construction options are summarized in a single configuration file. Source data are read from their native formats and mapped to a regular finite difference grid specified in the configuration file. An external array-based [Flopy](https://github.com/modflowpy/flopy) model instance with the desired packages is created from the sampled source data and configuration settings. MODFLOW input can then be written from the flopy model instance.
### Version 0.5
[](https://codecov.io/gh/doi-usgs/modflow-setup)
[](https://badge.fury.io/py/modflow-setup)
[](https://anaconda.org/conda-forge/modflow-setup)
[](https://mybinder.org/v2/gh/doi-usgs/modflow-setup/develop?urlpath=lab/tree/examples)
[](https://www.repostatus.org/#active)
Getting Started
-----------------------------------------------
For more details, see the [modflow-setup documentation](https://doi-usgs.github.io/modflow-setup/)
Using a [yaml](https://en.wikipedia.org/wiki/YAML)-aware text editor, create a [configuration file](https://doi-usgs.github.io/modflow-setup/latest/config-file.html) similar to one of the examples in the [Configuration File Gallery](https://doi-usgs.github.io/modflow-setup/latest/config-file-gallery.html).
The yaml file summarizes source data and parameter settings for setting up the various MODFLOW packages. To set up the model:
```
from mfsetup import MFnwtModel, MF6model
m = MF6model.setup_from_yaml(<path to configuration file>)
```
where `m` is a [flopy](https://github.com/modflowpy/flopy) MODFLOW-6 model instance that is returned. The MODFLOW input files can be written from the model instance:
```
m.simulation.write_simulation()
```
MODFLOW-NWT version:
```
m = MFnwtModel.setup_from_yaml(<path to configuration file>)
m.write_input()
```
Installation
-----------------------------------------------
See the [Installation Instructions](https://doi-usgs.github.io/modflow-setup/latest/installation.html)
How to cite
-----------------------------------------------
###### Citation for Modflow-setup
Leaf AT and Fienen MN (2022) Modflow-setup: Robust automation of groundwater model construction. Front. Earth Sci. 10:903965. https://doi.org/10.3389/feart.2022.903965
###### Software/Code Citation for Modflow-setup
Leaf, A.T. and Fienen, M.N. (2022). Modflow-setup version 0.1, U.S. Geological Survey Software Release, 30 Sep. 2022. https://doi.org/10.5066/P9O3QWQ1
Applications of Modflow-setup
-----------------------------------------------
Fienen, M.N., Corson-Dosch, N.T., White, J.T., Leaf, A.T. and Hunt, R.J. (2022), Risk-Based Wellhead Protection Decision Support: A Repeatable Workflow Approach. Groundwater, 60: 71-86. https://doi.org/10.1111/gwat.13129
Fienen, M.N., Haserodt, M.J., Leaf, A.T., and Westenbroek, S.M., 2022, Simulation of regional groundwater flow and groundwater/lake interactions in the Central Sands, Wisconsin: U.S. Geological Survey Scientific Investigations Report 2022–5046, 111 p., https://doi.org/10.3133/sir20225046.
Leaf, A.T., Duncan, L.L., Haugh, C.J., Hunt, R.J., and Rigby, J.R., 2023, Simulating groundwater flow in the Mississippi Alluvial Plain with a focus on the Mississippi Delta: U.S. Geological Survey Scientific Investigations Report 2023–5100, 143 p., https://doi.org/10.3133/sir20235100.
Workflow examples
-----------------------------------------------
Fienen, M.N, and Corson-Dosch, N.T., 2021, Groundwater Model Archive and Workflow for Neversink/Rondout Basin, New York, Source Water Delineation: U.S. Geological Survey data release, https://doi.org/10.5066/P9HWSOHP.
Leaf, A.T., Duncan, L.L., and Haugh, C.J., 2023, MODFLOW 6 models for simulating groundwater flow in the Mississippi Embayment with a focus on the Mississippi Delta: U.S. Geological Survey data release, https://doi.org/10.5066/P971LPOB.
MODFLOW Resources
-----------------------------------------------
+ [MODFLOW 6](https://www.usgs.gov/software/modflow-6-usgs-modular-hydrologic-model)
+ [Online Guide to MODFLOW-NWT](https://water.usgs.gov/ogw/modflow-nwt/MODFLOW-NWT-Guide/)
Disclaimer
----------
This software is preliminary or provisional and is subject to revision. It is
being provided to meet the need for timely best science. The software has not
received final approval by the U.S. Geological Survey (USGS). No warranty,
expressed or implied, is made by the USGS or the U.S. Government as to the
functionality of the software and related material nor shall the fact of release
constitute any such warranty. The software is provided on the condition that
neither the USGS nor the U.S. Government shall be held liable for any damages
resulting from the authorized or unauthorized use of the software. It is the responsibility of the user to check the accuracy of the results.
Any use of trade, firm, or product names is for descriptive purposes only and does not imply endorsement by the U.S. Government.
Raw data
{
"_id": null,
"home_page": "",
"name": "modflow-setup",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "MODFLOW,groundwater,hydrogeology",
"author": "",
"author_email": "Andrew Leaf <aleaf@usgs.gov>, Mike Fienen <mnfienen@usgs.gov>",
"download_url": "https://files.pythonhosted.org/packages/d7/c2/f97658baa01aae0aa4a97e45eb941defb7cda28d9bcb6d6b80c240d9a84f/modflow-setup-0.5.0.tar.gz",
"platform": null,
"description": "\nModflow-setup\n-----------------------------------------------\nModflow-setup is a Python package for automating the setup of MODFLOW groundwater models from grid-independent source data including shapefiles, rasters, and other MODFLOW models that are geo-located. Input data and model construction options are summarized in a single configuration file. Source data are read from their native formats and mapped to a regular finite difference grid specified in the configuration file. An external array-based [Flopy](https://github.com/modflowpy/flopy) model instance with the desired packages is created from the sampled source data and configuration settings. MODFLOW input can then be written from the flopy model instance.\n\n\n### Version 0.5\n\n[](https://codecov.io/gh/doi-usgs/modflow-setup)\n[](https://badge.fury.io/py/modflow-setup)\n[](https://anaconda.org/conda-forge/modflow-setup)\n[](https://mybinder.org/v2/gh/doi-usgs/modflow-setup/develop?urlpath=lab/tree/examples)\n[](https://www.repostatus.org/#active)\n\n\n\n\n\nGetting Started\n-----------------------------------------------\nFor more details, see the [modflow-setup documentation](https://doi-usgs.github.io/modflow-setup/)\n\nUsing a [yaml](https://en.wikipedia.org/wiki/YAML)-aware text editor, create a [configuration file](https://doi-usgs.github.io/modflow-setup/latest/config-file.html) similar to one of the examples in the [Configuration File Gallery](https://doi-usgs.github.io/modflow-setup/latest/config-file-gallery.html).\n\nThe yaml file summarizes source data and parameter settings for setting up the various MODFLOW packages. To set up the model:\n\n```\nfrom mfsetup import MFnwtModel, MF6model\n\nm = MF6model.setup_from_yaml(<path to configuration file>)\n```\nwhere `m` is a [flopy](https://github.com/modflowpy/flopy) MODFLOW-6 model instance that is returned. The MODFLOW input files can be written from the model instance:\n\n```\nm.simulation.write_simulation()\n```\n\nMODFLOW-NWT version:\n\n```\nm = MFnwtModel.setup_from_yaml(<path to configuration file>)\nm.write_input()\n```\n\nInstallation\n-----------------------------------------------\nSee the [Installation Instructions](https://doi-usgs.github.io/modflow-setup/latest/installation.html)\n\n\nHow to cite\n-----------------------------------------------\n###### Citation for Modflow-setup\nLeaf AT and Fienen MN (2022) Modflow-setup: Robust automation of groundwater model construction. Front. Earth Sci. 10:903965. https://doi.org/10.3389/feart.2022.903965\n\n###### Software/Code Citation for Modflow-setup\nLeaf, A.T. and Fienen, M.N. (2022). Modflow-setup version 0.1, U.S. Geological Survey Software Release, 30 Sep. 2022. https://doi.org/10.5066/P9O3QWQ1\n\nApplications of Modflow-setup\n-----------------------------------------------\nFienen, M.N., Corson-Dosch, N.T., White, J.T., Leaf, A.T. and Hunt, R.J. (2022), Risk-Based Wellhead Protection Decision Support: A Repeatable Workflow Approach. Groundwater, 60: 71-86. https://doi.org/10.1111/gwat.13129\n\nFienen, M.N., Haserodt, M.J., Leaf, A.T., and Westenbroek, S.M., 2022, Simulation of regional groundwater flow and groundwater/lake interactions in the Central Sands, Wisconsin: U.S. Geological Survey Scientific Investigations Report 2022\u20135046, 111 p., https://doi.org/10.3133/sir20225046.\n\nLeaf, A.T., Duncan, L.L., Haugh, C.J., Hunt, R.J., and Rigby, J.R., 2023, Simulating groundwater flow in the Mississippi Alluvial Plain with a focus on the Mississippi Delta: U.S. Geological Survey Scientific Investigations Report 2023\u20135100, 143 p., https://doi.org/10.3133/sir20235100.\n\nWorkflow examples\n-----------------------------------------------\nFienen, M.N, and Corson-Dosch, N.T., 2021, Groundwater Model Archive and Workflow for Neversink/Rondout Basin, New York, Source Water Delineation: U.S. Geological Survey data release, https://doi.org/10.5066/P9HWSOHP.\n\nLeaf, A.T., Duncan, L.L., and Haugh, C.J., 2023, MODFLOW 6 models for simulating groundwater flow in the Mississippi Embayment with a focus on the Mississippi Delta: U.S. Geological Survey data release, https://doi.org/10.5066/P971LPOB.\n\nMODFLOW Resources\n-----------------------------------------------\n\n+ [MODFLOW 6](https://www.usgs.gov/software/modflow-6-usgs-modular-hydrologic-model)\n+ [Online Guide to MODFLOW-NWT](https://water.usgs.gov/ogw/modflow-nwt/MODFLOW-NWT-Guide/)\n\n\nDisclaimer\n----------\n\nThis software is preliminary or provisional and is subject to revision. It is\nbeing provided to meet the need for timely best science. The software has not\nreceived final approval by the U.S. Geological Survey (USGS). No warranty,\nexpressed or implied, is made by the USGS or the U.S. Government as to the\nfunctionality of the software and related material nor shall the fact of release\nconstitute any such warranty. The software is provided on the condition that\nneither the USGS nor the U.S. Government shall be held liable for any damages\nresulting from the authorized or unauthorized use of the software. It is the responsibility of the user to check the accuracy of the results.\n\nAny use of trade, firm, or product names is for descriptive purposes only and does not imply endorsement by the U.S. Government.\n",
"bugtrack_url": null,
"license": "License ======= Unless otherwise noted, This project is in the public domain in the United States because it contains materials that originally came from the United States Geological Survey, an agency of the United States Department of Interior. For more information, see the official USGS copyright policy at https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits Additionally, we waive copyright and related rights in the work worldwide through the CC0 1.0 Universal public domain dedication. CC0 1.0 Universal Summary ------------------------- This is a human-readable summary of the [Legal Code (read the full text)][1]. ### No Copyright The person who associated a work with this deed has dedicated the work to the public domain by waiving all of his or her rights to the work worldwide under copyright law, including all related and neighboring rights, to the extent allowed by law. You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission. ### Other Information In no way are the patent or trademark rights of any person affected by CC0, nor are the rights that other persons may have in the work or in how the work is used, such as publicity or privacy rights. Unless expressly stated otherwise, the person who associated a work with this deed makes no warranties about the work, and disclaims liability for all uses of the work, to the fullest extent permitted by applicable law. When using or citing the work, you should not imply endorsement by the author or the affirmer. [1]: https://creativecommons.org/publicdomain/zero/1.0/legalcode ",
"summary": "Rapid and robust construction of MODFLOW groundwater flow models",
"version": "0.5.0",
"project_urls": {
"documentation": "https://doi-usgs.github.io/modflow-setup/latest/",
"repository": "https://github.com/doi-usgs/modflow-setup"
},
"split_keywords": [
"modflow",
"groundwater",
"hydrogeology"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "96c5459005829830ad75f19032e3286110a2ddcf885ec03a3823c312ac58b69b",
"md5": "191c2756e06c4e6a9dc4fa25154419a4",
"sha256": "aefd8ea634cd93b4b8539c3afaeef78609523e655b8c46789e0236fbeb1e534e"
},
"downloads": -1,
"filename": "modflow_setup-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "191c2756e06c4e6a9dc4fa25154419a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 277314,
"upload_time": "2024-03-08T21:09:35",
"upload_time_iso_8601": "2024-03-08T21:09:35.307465Z",
"url": "https://files.pythonhosted.org/packages/96/c5/459005829830ad75f19032e3286110a2ddcf885ec03a3823c312ac58b69b/modflow_setup-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d7c2f97658baa01aae0aa4a97e45eb941defb7cda28d9bcb6d6b80c240d9a84f",
"md5": "6fa7d99e0f953d985188e437d9191335",
"sha256": "d94e869ba7f14bac6e4dc586248e986ec9bc96d8078aa2f81f9f139373a43487"
},
"downloads": -1,
"filename": "modflow-setup-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "6fa7d99e0f953d985188e437d9191335",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 315100,
"upload_time": "2024-03-08T21:09:36",
"upload_time_iso_8601": "2024-03-08T21:09:36.992231Z",
"url": "https://files.pythonhosted.org/packages/d7/c2/f97658baa01aae0aa4a97e45eb941defb7cda28d9bcb6d6b80c240d9a84f/modflow-setup-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-08 21:09:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "doi-usgs",
"github_project": "modflow-setup",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "modflow-setup"
}
