From e2a1ea71c0661ee564147df957be7db6de0f788b Mon Sep 17 00:00:00 2001 From: RJbalikian <46536937+RJbalikian@users.noreply.github.com> Date: Mon, 11 Mar 2024 00:16:25 -0500 Subject: [PATCH] update generate_docs filename, vernum, documentation --- docs/{generate_docs.py => _generate_docs.py} | 2 +- docs/classify.html | 10 +++++---- docs/clean.html | 20 ++++++++++------- docs/core.html | 16 ++++++++------ docs/export.html | 8 +++++-- docs/layers.html | 11 ++++++++-- docs/main.html | 23 +++++++++++--------- docs/mapping.html | 11 ++++++++-- docs/read.html | 13 ++++++++--- pyproject.toml | 2 +- setup.py | 2 +- 11 files changed, 77 insertions(+), 41 deletions(-) rename docs/{generate_docs.py => _generate_docs.py} (99%) diff --git a/docs/generate_docs.py b/docs/_generate_docs.py similarity index 99% rename from docs/generate_docs.py rename to docs/_generate_docs.py index 423b6a8..e856f86 100644 --- a/docs/generate_docs.py +++ b/docs/_generate_docs.py @@ -15,7 +15,7 @@ RTD_THEME=False #Not currently working RUN_TESTS=True LINT_IT=False -RELEASE_VERSION = "0.0.21-dev" +RELEASE_VERSION = "0.0.21" # Set the filepaths currentDir = pathlib.Path((__file__)).parent diff --git a/docs/classify.html b/docs/classify.html index 4b43b0f..4c98032 100644 --- a/docs/classify.html +++ b/docs/classify.html @@ -5,7 +5,7 @@ w4h.classify API documentation - + @@ -22,11 +22,15 @@

Module w4h.classify

+

The Classify module contains functions for defining geological intervals into a preset subset of interpretations.

Expand source code -
import datetime
+
"""The Classify module contains functions for defining geological intervals into a preset subset of interpretations.
+"""
+
+import datetime
 import inspect
 
 import pandas as pd
@@ -43,7 +47,6 @@ 
Module w4h.classify

 #- Top of well?
 
 #Define records with full search term
-
 def specific_define(df, terms_df, description_col='FORMATION', terms_col='DESCRIPTION', verbose=False, log=False):
     """Function to classify terms that have been specifically defined in the terms_df.
 
@@ -244,7 +247,6 @@ 
Module w4h.classify

     return remergeDF
 
 #Define well intervals by depth
-
 def depth_define(df, top_col='TOP', thresh=550.0, verbose=False, log=False):
     """Function to define all intervals lower than thresh as bedrock
 
diff --git a/docs/clean.html b/docs/clean.html
index 6a2bde2..a6bdc15 100644
--- a/docs/clean.html
+++ b/docs/clean.html
@@ -5,7 +5,7 @@
 
 
 w4h.clean API documentation
-
+
 
 
 
@@ -22,18 +22,22 @@
 
Module w4h.clean

 
 

+
The Clean module contains functions for cleaning the data (i.e., removing data not to be used in further analysis)

 

 
 Expand source code
 
-
import inspect
+
"""The Clean module contains functions for cleaning the data (i.e., removing data not to be used in further analysis)
+"""
+
+import inspect
 
 import numpy as np
 import pandas as pd
 
 from w4h import logger_function, verbose_print
 
-#This function removes all data from the downholeData table where there is no location information (in the headerData table). This includes elevation info too
+# This function removes all data from the downholeData table where there is no location information (in the headerData table). This includes elevation info too
 def remove_nonlocated(df_with_locations, xcol='LONGITUDE', ycol='LATITUDE', no_data_val_table='', verbose=False, log=False):
     """Function to remove wells and well intervals where there is no location information
 
@@ -72,8 +76,8 @@ 
Module w4h.clean

 
     return df_with_locations
 
-#Function to remove data (intended for headerData) without surface topography information
-##THIS ASSUMES AND SHOULD ONLY BE RUN AFTER ALL DESIRED SURFACE TOPO DATASETS HAVE BEEN MERGED/ADDED
+# Function to remove data (intended for headerData) without surface topography information
+# THIS ASSUMES AND SHOULD ONLY BE RUN AFTER ALL DESIRED SURFACE TOPO DATASETS HAVE BEEN MERGED/ADDED
 def remove_no_topo(df_with_topo, zcol='ELEVATION', no_data_val_table='', verbose=False, log=False):
     """Function to remove wells that do not have topography data (needed for layer selection later).
 
@@ -116,7 +120,7 @@ 
Module w4h.clean

     
     return df_with_topo
 
-#This function drops all records in the downholedata with no depth information (either top or bottom depth of well interval)
+# This function drops all records in the downholedata with no depth information (either top or bottom depth of well interval)
 def remove_no_depth(df_with_depth, top_col='TOP', bottom_col='BOTTOM', no_data_val_table='', verbose=False, log=False):
     """Function to remove well intervals with no depth information
 
@@ -166,7 +170,7 @@ 
Module w4h.clean

     
     return df_with_depth
 
-#This function drops all records in downholeData with bad depth information (where the bottom of a record is nearer to the surface than the top)
+# This function drops all records in downholeData with bad depth information (where the bottom of a record is nearer to the surface than the top)
 def remove_bad_depth(df_with_depth, top_col='TOP', bottom_col='BOTTOM', depth_type='depth', verbose=False, log=False):
     """Function to remove all records in the dataframe with well interpretations where the depth information is bad (i.e., where the bottom of the record is neerer to the surface than the top)
 
@@ -211,7 +215,7 @@ 
Module w4h.clean

 
     return df_with_depth
 
-#This function drops all records in downholeData with no formation in formation in the description fiel
+# This function drops all records in downholeData with no formation in formation in the description fiel
 def remove_no_description(df_with_descriptions, description_col='FORMATION', no_data_val_table='', verbose=False, log=False):
     """Function that removes all records in the dataframe containing the well descriptions where no description is given.
 
diff --git a/docs/core.html b/docs/core.html
index 20c0e14..d0a23b5 100644
--- a/docs/core.html
+++ b/docs/core.html
@@ -5,8 +5,8 @@
 
 
 w4h.core API documentation
-
+
 
 
 
@@ -23,14 +23,16 @@
 
Module w4h.core

 
 

-
This module contains core functions of the package,
-including the main run() function that allows rapid data analysis.

+
The Core module contains core functions of the package,
+including the main run() function that allows rapid data analysis, a function to retrieve sample data,
+and functions that are used throughout the package for logging and printing verbose outputs.

 

 
 Expand source code
 
-
"""This module contains core functions of the package, 
-including the main run() function that allows rapid data analysis."""
+
"""The Core module contains core functions of the package, 
+including the main run() function that allows rapid data analysis, a function to retrieve sample data,
+and functions that are used throughout the package for logging and printing verbose outputs."""
 
 import datetime
 import inspect
@@ -1138,7 +1140,7 @@ 
Parameters

 | default = False

 
get_search_terms
 spec_path
-| default = 'C:\Users\riley\LocalData\virtual_envs/resources/'
+| default = 'C:\Users\riley\LocalData\Github\wells4hydrogeology/resources/'
 spec_glob_pattern
 | default = 'SearchTerms-Specific'
 start_path
diff --git a/docs/export.html b/docs/export.html
index 1f5bcbd..a220248 100644
--- a/docs/export.html
+++ b/docs/export.html
@@ -5,7 +5,7 @@
 
 
 w4h.export API documentation
-
+
 
 
 
@@ -22,11 +22,15 @@
 
Module w4h.export

 
 

+
The Export module contains functions for exporting processed data.

 

 
 Expand source code
 
-
import datetime
+
"""The Export module contains functions for exporting processed data.
+"""
+
+import datetime
 import inspect
 import pathlib
 
diff --git a/docs/layers.html b/docs/layers.html
index 2d05695..d89c149 100644
--- a/docs/layers.html
+++ b/docs/layers.html
@@ -5,7 +5,8 @@
 
 
 w4h.layers API documentation
-
+
 
 
 
@@ -22,11 +23,17 @@
 
Module w4h.layers

 
 

+
The Layers module contains functions for splitting data into a layered model
+and for interpolating data within the layers

 

 
 Expand source code
 
-
import datetime
+
"""The Layers module contains functions for splitting data into a layered model
+and for interpolating data within the layers
+"""
+
+import datetime
 import inspect
 import os
 import pathlib
diff --git a/docs/main.html b/docs/main.html
index e6a0cd1..d42f673 100644
--- a/docs/main.html
+++ b/docs/main.html
@@ -154,32 +154,35 @@ 
Sub-modules

 

 
w4h.classify

 

-

+
The Classify module contains functions for defining geological intervals into a preset subset of interpretations.

 

 
w4h.clean

 

-

+
The Clean module contains functions for cleaning the data (i.e., removing data not to be used in further analysis)

 

 
w4h.core

 

-
This module contains core functions of the package,
-including the main run() function that allows rapid data analysis.

+
The Core module contains core functions of the package,
+including the main run() function that allows rapid data analysis, a function to retrieve …

 

 
w4h.export

 

-

+
The Export module contains functions for exporting processed data.

 

 
w4h.layers

 

-

+
The Layers module contains functions for splitting data into a layered model
+and for interpolating data within the layers

 

 
w4h.mapping

 

-

+
The Mapping module contains the functions used for geospatial analysis throughout the package.
+This includes some input/output as well as functions to …

 

 
w4h.read

 

-

+
The Read module contains funtions primarily for the input of data through the reading of data files,
+as well as support functions to carry out this task

 

 

 

@@ -1583,7 +1586,7 @@ 
Returns

 

 
 

-def get_search_terms(spec_path='C:\\Users\\riley\\LocalData\\virtual_envs/resources/', spec_glob_pattern='*SearchTerms-Specific*', start_path=None, start_glob_pattern='*SearchTerms-Start*', wildcard_path=None, wildcard_glob_pattern='*SearchTerms-Wildcard', verbose=False, log=False)
+def get_search_terms(spec_path='C:\\Users\\riley\\LocalData\\Github\\wells4hydrogeology/resources/', spec_glob_pattern='*SearchTerms-Specific*', start_path=None, start_glob_pattern='*SearchTerms-Start*', wildcard_path=None, wildcard_glob_pattern='*SearchTerms-Wildcard', verbose=False, log=False)
 

 

 
Read in dictionary files for downhole data

@@ -4270,7 +4273,7 @@ 
Returns

 | default = False

 
get_search_terms
 spec_path
-| default = 'C:\Users\riley\LocalData\virtual_envs/resources/'
+| default = 'C:\Users\riley\LocalData\Github\wells4hydrogeology/resources/'
 spec_glob_pattern
 | default = 'SearchTerms-Specific'
 start_path
diff --git a/docs/mapping.html b/docs/mapping.html
index 72e1a8e..18f9489 100644
--- a/docs/mapping.html
+++ b/docs/mapping.html
@@ -5,7 +5,8 @@
 
 
 w4h.mapping API documentation
-
+
 
 
 
@@ -22,11 +23,17 @@
 
Module w4h.mapping

 
 

+
The Mapping module contains the functions used for geospatial analysis throughout the package.
+This includes some input/output as well as functions to make manipulatin of geospatial data more simple

 

 
 Expand source code
 
-
import datetime
+
"""The Mapping module contains the functions used for geospatial analysis throughout the package.
+This includes some input/output as well as functions to make manipulatin of geospatial data more simple
+"""
+
+import datetime
 import inspect
 import json
 import pathlib
diff --git a/docs/read.html b/docs/read.html
index 5fcfe7e..f3ed9ad 100644
--- a/docs/read.html
+++ b/docs/read.html
@@ -5,7 +5,8 @@
 
 
 w4h.read API documentation
-
+
 
 
 
@@ -22,11 +23,17 @@
 
Module w4h.read

 
 

+
The Read module contains funtions primarily for the input of data through the reading of data files,
+as well as support functions to carry out this task

 

 
 Expand source code
 
-
import datetime
+
"""The Read module contains funtions primarily for the input of data through the reading of data files,
+as well as support functions to carry out this task
+"""
+
+import datetime
 import inspect
 import json
 import os
@@ -1136,7 +1143,7 @@ 
Returns

 

 

 

-def get_search_terms(spec_path='C:\\Users\\riley\\LocalData\\virtual_envs/resources/', spec_glob_pattern='*SearchTerms-Specific*', start_path=None, start_glob_pattern='*SearchTerms-Start*', wildcard_path=None, wildcard_glob_pattern='*SearchTerms-Wildcard', verbose=False, log=False)
+def get_search_terms(spec_path='C:\\Users\\riley\\LocalData\\Github\\wells4hydrogeology/resources/', spec_glob_pattern='*SearchTerms-Specific*', start_path=None, start_glob_pattern='*SearchTerms-Start*', wildcard_path=None, wildcard_glob_pattern='*SearchTerms-Wildcard', verbose=False, log=False)
 

 

 
Read in dictionary files for downhole data

diff --git a/pyproject.toml b/pyproject.toml
index 69b98df..f0e4fd0 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "wells4hydrogeology"
 dynamic = ["readme"]
 license = {file = "LICENSE"}
-version="0.0.21-dev"
+version="0.0.21"
 description = "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."
 keywords = ["hydrogeology", "modflow", "water wells", "geology", 'water', 'geotechnical']
 requires-python = "<3.13, >=3.9"
diff --git a/setup.py b/setup.py
index 4fe94e9..cd92bd9 100644
--- a/setup.py
+++ b/setup.py
@@ -8,7 +8,7 @@
     name="wells4hydrogeology",
     author= "Riley Balikian",
     author_email = "balikian@illinois.edu",
-    version="0.0.21-dev",
+    version="0.0.21",
     package_data={'w4h': ['resources/*', 'resources/sample_data/*', 'resources/sample_data/statewide_sample_data/*',
                           'resources/sample_data/DictionaryTerms/*','resources/sample_data/LithologyInterpretations/*']},
     install_requires=["geopandas", "rioxarray", "owslib", "scipy", "matplotlib", "pandas", "numpy"],