update generate_docs filename, vernum, documentation

docs/generate_docs.py → 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

docs/classify.html

@@ -5,7 +5,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
 <meta name="generator" content="pdoc 0.10.0" />
 <title>w4h.classify API documentation</title>
-<meta name="description" content="" />
+<meta name="description" content="The Classify module contains functions for defining geological intervals into a preset subset of interpretations." />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
@@ -22,11 +22,15 @@
 <h1 class="title">Module <code>w4h.classify</code></h1>
 </header>
 <section id="section-intro">
+<p>The Classify module contains functions for defining geological intervals into a preset subset of interpretations.</p>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">import datetime
+<pre><code class="python">&#34;&#34;&#34;The Classify module contains functions for defining geological intervals into a preset subset of interpretations.
+&#34;&#34;&#34;
+
+import datetime
 import inspect
 
 import pandas as pd
@@ -43,7 +47,6 @@ <h1 class="title">Module <code>w4h.classify</code></h1>
 #- Top of well?
 
 #Define records with full search term
-
 def specific_define(df, terms_df, description_col=&#39;FORMATION&#39;, terms_col=&#39;DESCRIPTION&#39;, verbose=False, log=False):
     &#34;&#34;&#34;Function to classify terms that have been specifically defined in the terms_df.
 
@@ -244,7 +247,6 @@ <h1 class="title">Module <code>w4h.classify</code></h1>
     return remergeDF
 
 #Define well intervals by depth
-
 def depth_define(df, top_col=&#39;TOP&#39;, thresh=550.0, verbose=False, log=False):
     &#34;&#34;&#34;Function to define all intervals lower than thresh as bedrock
 

docs/clean.html

@@ -5,7 +5,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
 <meta name="generator" content="pdoc 0.10.0" />
 <title>w4h.clean API documentation</title>
-<meta name="description" content="" />
+<meta name="description" content="The Clean module contains functions for cleaning the data (i.e., removing data not to be used in further analysis)" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
@@ -22,18 +22,22 @@
 <h1 class="title">Module <code>w4h.clean</code></h1>
 </header>
 <section id="section-intro">
+<p>The Clean module contains functions for cleaning the data (i.e., removing data not to be used in further analysis)</p>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">import inspect
+<pre><code class="python">&#34;&#34;&#34;The Clean module contains functions for cleaning the data (i.e., removing data not to be used in further analysis)
+&#34;&#34;&#34;
+
+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=&#39;LONGITUDE&#39;, ycol=&#39;LATITUDE&#39;, no_data_val_table=&#39;&#39;, verbose=False, log=False):
     &#34;&#34;&#34;Function to remove wells and well intervals where there is no location information
 
@@ -72,8 +76,8 @@ <h1 class="title">Module <code>w4h.clean</code></h1>
 
     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=&#39;ELEVATION&#39;, no_data_val_table=&#39;&#39;, verbose=False, log=False):
     &#34;&#34;&#34;Function to remove wells that do not have topography data (needed for layer selection later).
 
@@ -116,7 +120,7 @@ <h1 class="title">Module <code>w4h.clean</code></h1>
 
     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=&#39;TOP&#39;, bottom_col=&#39;BOTTOM&#39;, no_data_val_table=&#39;&#39;, verbose=False, log=False):
     &#34;&#34;&#34;Function to remove well intervals with no depth information
 
@@ -166,7 +170,7 @@ <h1 class="title">Module <code>w4h.clean</code></h1>
 
     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=&#39;TOP&#39;, bottom_col=&#39;BOTTOM&#39;, depth_type=&#39;depth&#39;, verbose=False, log=False):
     &#34;&#34;&#34;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 @@ <h1 class="title">Module <code>w4h.clean</code></h1>
 
     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=&#39;FORMATION&#39;, no_data_val_table=&#39;&#39;, verbose=False, log=False):
     &#34;&#34;&#34;Function that removes all records in the dataframe containing the well descriptions where no description is given.
 

docs/core.html

@@ -5,8 +5,8 @@
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
 <meta name="generator" content="pdoc 0.10.0" />
 <title>w4h.core API documentation</title>
-<meta name="description" content="This module contains core functions of the package,
-including the main run() function that allows rapid data analysis." />
+<meta name="description" content="The Core module contains core functions of the package,
+including the main run() function that allows rapid data analysis, a function to retrieve …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
@@ -23,14 +23,16 @@
 <h1 class="title">Module <code>w4h.core</code></h1>
 </header>
 <section id="section-intro">
-<p>This module contains core functions of the package,
-including the main run() function that allows rapid data analysis.</p>
+<p>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.</p>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">&#34;&#34;&#34;This module contains core functions of the package, 
-including the main run() function that allows rapid data analysis.&#34;&#34;&#34;
+<pre><code class="python">&#34;&#34;&#34;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.&#34;&#34;&#34;
 
 import datetime
 import inspect
@@ -1138,7 +1140,7 @@ <h2 id="parameters">Parameters</h2>
 | default = False</p>
 <p>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 = '<em>SearchTerms-Specific</em>'
 start_path

docs/export.html

@@ -5,7 +5,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
 <meta name="generator" content="pdoc 0.10.0" />
 <title>w4h.export API documentation</title>
-<meta name="description" content="" />
+<meta name="description" content="The Export module contains functions for exporting processed data." />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
@@ -22,11 +22,15 @@
 <h1 class="title">Module <code>w4h.export</code></h1>
 </header>
 <section id="section-intro">
+<p>The Export module contains functions for exporting processed data.</p>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">import datetime
+<pre><code class="python">&#34;&#34;&#34;The Export module contains functions for exporting processed data.
+&#34;&#34;&#34;
+
+import datetime
 import inspect
 import pathlib
 

docs/layers.html

@@ -5,7 +5,8 @@
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
 <meta name="generator" content="pdoc 0.10.0" />
 <title>w4h.layers API documentation</title>
-<meta name="description" content="" />
+<meta name="description" content="The Layers module contains functions for splitting data into a layered model
+and for interpolating data within the layers" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
@@ -22,11 +23,17 @@
 <h1 class="title">Module <code>w4h.layers</code></h1>
 </header>
 <section id="section-intro">
+<p>The Layers module contains functions for splitting data into a layered model
+and for interpolating data within the layers</p>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">import datetime
+<pre><code class="python">&#34;&#34;&#34;The Layers module contains functions for splitting data into a layered model
+and for interpolating data within the layers
+&#34;&#34;&#34;
+
+import datetime
 import inspect
 import os
 import pathlib

docs/main.html

@@ -154,32 +154,35 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <dl>
 <dt><code class="name"><a title="w4h.classify" href="classify.html">w4h.classify</a></code></dt>
 <dd>
-<div class="desc"></div>
+<div class="desc"><p>The Classify module contains functions for defining geological intervals into a preset subset of interpretations.</p></div>
 </dd>
 <dt><code class="name"><a title="w4h.clean" href="clean.html">w4h.clean</a></code></dt>
 <dd>
-<div class="desc"></div>
+<div class="desc"><p>The Clean module contains functions for cleaning the data (i.e., removing data not to be used in further analysis)</p></div>
 </dd>
 <dt><code class="name"><a title="w4h.core" href="core.html">w4h.core</a></code></dt>
 <dd>
-<div class="desc"><p>This module contains core functions of the package,
-including the main run() function that allows rapid data analysis.</p></div>
+<div class="desc"><p>The Core module contains core functions of the package,
+including the main run() function that allows rapid data analysis, a function to retrieve …</p></div>
 </dd>
 <dt><code class="name"><a title="w4h.export" href="export.html">w4h.export</a></code></dt>
 <dd>
-<div class="desc"></div>
+<div class="desc"><p>The Export module contains functions for exporting processed data.</p></div>
 </dd>
 <dt><code class="name"><a title="w4h.layers" href="layers.html">w4h.layers</a></code></dt>
 <dd>
-<div class="desc"></div>
+<div class="desc"><p>The Layers module contains functions for splitting data into a layered model
+and for interpolating data within the layers</p></div>
 </dd>
 <dt><code class="name"><a title="w4h.mapping" href="mapping.html">w4h.mapping</a></code></dt>
 <dd>
-<div class="desc"></div>
+<div class="desc"><p>The Mapping module contains the functions used for geospatial analysis throughout the package.
+This includes some input/output as well as functions to …</p></div>
 </dd>
 <dt><code class="name"><a title="w4h.read" href="read.html">w4h.read</a></code></dt>
 <dd>
-<div class="desc"></div>
+<div class="desc"><p>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</p></div>
 </dd>
 </dl>
 </section>
@@ -1583,7 +1586,7 @@ <h2 id="returns">Returns</h2>
 </details>
 </dd>
 <dt id="w4h.get_search_terms"><code class="name flex">
-<span>def <span class="ident">get_search_terms</span></span>(<span>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)</span>
+<span>def <span class="ident">get_search_terms</span></span>(<span>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)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Read in dictionary files for downhole data</p>
@@ -4270,7 +4273,7 @@ <h2 id="returns">Returns</h2>
 | default = False</p>
 <p>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 = '<em>SearchTerms-Specific</em>'
 start_path

docs/mapping.html

@@ -5,7 +5,8 @@
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
 <meta name="generator" content="pdoc 0.10.0" />
 <title>w4h.mapping API documentation</title>
-<meta name="description" content="" />
+<meta name="description" content="The Mapping module contains the functions used for geospatial analysis throughout the package.
+This includes some input/output as well as functions to …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
@@ -22,11 +23,17 @@
 <h1 class="title">Module <code>w4h.mapping</code></h1>
 </header>
 <section id="section-intro">
+<p>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</p>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">import datetime
+<pre><code class="python">&#34;&#34;&#34;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
+&#34;&#34;&#34;
+
+import datetime
 import inspect
 import json
 import pathlib