Metadata-Version: 2.1
Name: wells4hydrogeology
Version: 0.0.7
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.
Author: Riley Balikian
Author-email: balikian@illinois.edu
License: MIT License
        
        Copyright (c) 2023 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.
        
Project-URL: Homepage, https://github.com/RJbalikian/wells4hydrogeology
Project-URL: API Documentation, https://rjbalikian.github.io/wells4hydrogeology/main.html
Keywords: hydrogeology,modflow,water wells,geology,water,geotechnical
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: <3.13,>=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: geopandas
Requires-Dist: rioxarray
Requires-Dist: owslib
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: numpy

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

# Included resources
The w4h package "ships" with some definition files that are read in/used by the scripts
- ISGS_HEADER_yyyy-mm-dd.TXT: tabular data exported from ISGS oracle database containing "header" information (i.e., metadata) about all the wells
- ISGS_DOWNHOLE_DATA_yyyy-mm-dd.TXT: tabular data exported from ISGS oracle database containing geologic information about wells in the state
- xyzData_yyyy-mm-dd.csv: most recent update of statewide wells with API, Latitude, Longitude, and surface elevation extracted from statewide lidar topography

# Intended workflow
Diagram for workflow available <a href="https://github.com/RJbalikian/wells4hydrogeology/wiki/Intended-Workflow-%5BDRAFT%5D">here</a>.
