| Name | wells4hydrogeology JSON |
| Version |
0.0.23
JSON |
| download |
| home_page | None |
| Summary | A package to read in geology data from wells and create a layered, gridded hydrogeologic model of a study region, all within a python environment, automating and performing tasks often carried out in a dedicated GIS software. |
| upload_time | 2024-04-30 05:41:12 |
| maintainer | None |
| docs_url | None |
| author | Riley Balikian |
| requires_python | <3.13,>=3.9 |
| license | MIT License Copyright (c) 2024 RJbalikian 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 |
hydrogeology
modflow
water wells
geology
water
geotechnical
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Wells 4 Hydrogeology (w4h)
The w4h Python package is a package designed jointly by the Illinois State Geological Survey and Illinois State Water Survey.
It is designed to read in geology data from wells and create a layered, gridded hydrogeologic model of a study region, all within a python environment, automating and performing tasks often carried out in a dedicated GIS software.
The w4h package contains all the functions needed for getting N layers of a hydrogeology grid.
Though the source code is split into separate modules, all functions are designed to be accessed directly from the w4h module (example: w4h.read_study_area())
The w4h module is designed to be flexible and customizable, allowing various kinds of data to be read in, with many different kinds of initial structures.
Using well descriptions from these database tables, the code contained here extracts, manipulates, and organizes the data to be used for hydrogeologic modeling. The scripts here can be used for specific regions of interests/study areas within the state, or for the state as a whole.
# API Documentation
API Documentation <a href="https://rjbalikian.github.io/wells4hydrogeology/index.html">here</a>
# Dependencies
## The w4h module has the following dependencies:
- numpy
- geopandas (and therefore pandas)
- rioxarray (and therefore xarray)
- matplotlib
- scipy
- owslib
# Inputs
## Required Inputs
Required inputs include are shown <a href="https://github.com/RJbalikian/wells4hydrogeology/">here</a>wiki
# Organization
## Modules
The package is organized by module, but all functions can be accessed directly using w4h.function_name() as well.
- core: general utility functions used throughout
- classify: functions for classifying the data
- clean: functions for cleaning the data
- export: functions for exporting the data, both as tables and rasters
- layers: functinos for generating layer(ed) models
- mapping: functions for mapping or performing geospatial analysis
- read: functions for reading in various files
# Intended workflow
Diagram for workflow available <a href="https://github.com/RJbalikian/wells4hydrogeology/wiki/Intended-Workflow-%5BDRAFT%5D">here</a>.
# Disclaimers
wells4hydrogeology is a python tool developed jointly by the Illinois State Water Survey and the Illinois State Geological Survey, both part of the Prairie Research Institute at the University of Illinois. By using this repository, you agree to the Terms of Use contained in the <a href="https://isgs.illinois.edu/terms-of-use/">Data Use License Agreement</a>.
Raw data
{
"_id": null,
"home_page": null,
"name": "wells4hydrogeology",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "hydrogeology, modflow, water wells, geology, water, geotechnical",
"author": "Riley Balikian",
"author_email": "balikian@illinois.edu",
"download_url": "https://files.pythonhosted.org/packages/b5/ec/dcc820f236ea6475481e742fdd1656d8a0077e221956fb76adf640837773/wells4hydrogeology-0.0.23.tar.gz",
"platform": null,
"description": "# Wells 4 Hydrogeology (w4h) \n\nThe w4h Python package is a package designed jointly by the Illinois State Geological Survey and Illinois State Water Survey.\n\nIt is designed to read in geology data from wells and create a layered, gridded hydrogeologic model of a study region, all within a python environment, automating and performing tasks often carried out in a dedicated GIS software.\n\nThe w4h package contains all the functions needed for getting N layers of a hydrogeology grid. \nThough the source code is split into separate modules, all functions are designed to be accessed directly from the w4h module (example: w4h.read_study_area())\n\nThe w4h module is designed to be flexible and customizable, allowing various kinds of data to be read in, with many different kinds of initial structures.\n\nUsing well descriptions from these database tables, the code contained here extracts, manipulates, and organizes the data to be used for hydrogeologic modeling. The scripts here can be used for specific regions of interests/study areas within the state, or for the state as a whole.\n\n# API Documentation\nAPI Documentation <a href=\"https://rjbalikian.github.io/wells4hydrogeology/index.html\">here</a>\n\n# Dependencies\n## The w4h module has the following dependencies:\n- numpy\n- geopandas (and therefore pandas)\n- rioxarray (and therefore xarray)\n- matplotlib\n- scipy\n- owslib\n\n# Inputs\n## Required Inputs\nRequired inputs include are shown <a href=\"https://github.com/RJbalikian/wells4hydrogeology/\">here</a>wiki\n\n# Organization\n## Modules\nThe package is organized by module, but all functions can be accessed directly using w4h.function_name() as well.\n- core: general utility functions used throughout\n- classify: functions for classifying the data\n- clean: functions for cleaning the data\n- export: functions for exporting the data, both as tables and rasters\n- layers: functinos for generating layer(ed) models\n- mapping: functions for mapping or performing geospatial analysis\n- read: functions for reading in various files\n\n# Intended workflow\nDiagram for workflow available <a href=\"https://github.com/RJbalikian/wells4hydrogeology/wiki/Intended-Workflow-%5BDRAFT%5D\">here</a>.\n\n# Disclaimers\nwells4hydrogeology is a python tool developed jointly by the Illinois State Water Survey and the Illinois State Geological Survey, both part of the Prairie Research Institute at the University of Illinois. By using this repository, you agree to the Terms of Use contained in the <a href=\"https://isgs.illinois.edu/terms-of-use/\">Data Use License Agreement</a>.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 RJbalikian 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": "A package to read in geology data from wells and create a layered, gridded hydrogeologic model of a study region, all within a python environment, automating and performing tasks often carried out in a dedicated GIS software.",
"version": "0.0.23",
"project_urls": {
"API Docs (Github Pages)": "https://rjbalikian.github.io/wells4hydrogeology/main.html",
"API Docs (ReadtheDocs)": "https://wells4hydrogeology.readthedocs.io/en/latest/",
"API Docs (dev - ReadtheDocs)": "https://wells4hydrogeology.readthedocs.io/en/dev/",
"Homepage": "https://github.com/RJbalikian/wells4hydrogeology",
"Tutorials & Wiki": "https://github.com/RJbalikian/wells4hydrogeology/wiki"
},
"split_keywords": [
"hydrogeology",
" modflow",
" water wells",
" geology",
" water",
" geotechnical"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0daa5894d99a98fc92af81cb32d4dc2d0ff05ef13d9f516b7c616e172717b415",
"md5": "5d5e5eca67b04ab1c17d33a8d12278a2",
"sha256": "34c8aa928539d333a52997b1523d4866613b53b20b391cd1393a946187b517f9"
},
"downloads": -1,
"filename": "wells4hydrogeology-0.0.23-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d5e5eca67b04ab1c17d33a8d12278a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 100862732,
"upload_time": "2024-04-30T05:41:06",
"upload_time_iso_8601": "2024-04-30T05:41:06.409015Z",
"url": "https://files.pythonhosted.org/packages/0d/aa/5894d99a98fc92af81cb32d4dc2d0ff05ef13d9f516b7c616e172717b415/wells4hydrogeology-0.0.23-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b5ecdcc820f236ea6475481e742fdd1656d8a0077e221956fb76adf640837773",
"md5": "b85760e6cedd4f62783c457df8eb9615",
"sha256": "01fc413954e766aba31770ded93f030abdd4f1c78e7366eda3f9bcdd95a39c00"
},
"downloads": -1,
"filename": "wells4hydrogeology-0.0.23.tar.gz",
"has_sig": false,
"md5_digest": "b85760e6cedd4f62783c457df8eb9615",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 100786172,
"upload_time": "2024-04-30T05:41:12",
"upload_time_iso_8601": "2024-04-30T05:41:12.235954Z",
"url": "https://files.pythonhosted.org/packages/b5/ec/dcc820f236ea6475481e742fdd1656d8a0077e221956fb76adf640837773/wells4hydrogeology-0.0.23.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 05:41:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RJbalikian",
"github_project": "wells4hydrogeology",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wells4hydrogeology"
}
