Skip to content

Commit

Permalink
docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam Lamont committed Feb 15, 2024
1 parent 78ddc08 commit 9ef95a6
Show file tree
Hide file tree
Showing 102 changed files with 689 additions and 408 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/documentation-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ name: documentation

on:
push:
tags: [ 'v*.*.*' ]
# branches: [112-add-documentation]
# tags: [ 'v*.*.*' ]
branches: [112-add-documentation]

permissions:
contents: write
Expand Down
9 changes: 5 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,11 @@ instance/

# Sphinx documentation
docs/sphinx/_build/
# docs/sphinx/_autosummary/
# docs/sphinx/_static/*.html
# docs/sphinx/generated
# docs/sphinx/index.rst
docs/sphinx/_autosummary/
docs/sphinx/_static/*.html
docs/sphinx/generated
docs/sphinx/savefig
docs/sphinx/index.rst

# PyBuilder
target/
Expand Down
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/autoapi/teehr/index.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/changelog/index.doctree
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/generated/teehr.doctree
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/getting_started/index.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/sphinx/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: ee16036896f489ec6694462fa2ce96a5
config: 6d4cdac9bb0cfe213013056ca9fe5f6d
tags: 645f666f9bcd5a90fca523b33c5a78b7
9 changes: 5 additions & 4 deletions docs/sphinx/_build/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="icon" sizes="16x16" type="image/png" href="../_static/../images/teehr_favicon_16.png" />
<link rel="stylesheet" type="text/css" href="../_static/css/teehr.css?v=ab7696e0" />
<link rel="stylesheet" type="text/css" href="../_static/css/teehr.css?v=5a67141b" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" />
Expand All @@ -44,6 +43,7 @@
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/design-tabs.js?v=36754332"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/index';</script>
<link rel="icon" href="../_static/favicon.png"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
Expand Down Expand Up @@ -394,7 +394,8 @@

<h1>All modules for which code is available</h1>
<ul><li><a href="pandas/_libs/tslibs/timestamps.html">pandas._libs.tslibs.timestamps</a></li>
<li><a href="teehr/api/main.html">teehr.api.main</a></li>
<li><a href="teehr.html">teehr</a></li>
<ul><li><a href="teehr/api/main.html">teehr.api.main</a></li>
<li><a href="teehr/database/teehr_dataset.html">teehr.database.teehr_dataset</a></li>
<li><a href="teehr/loading/nwm/grid_utils.html">teehr.loading.nwm.grid_utils</a></li>
<li><a href="teehr/loading/nwm/nwm_grids.html">teehr.loading.nwm.nwm_grids</a></li>
Expand All @@ -416,7 +417,7 @@ <h1>All modules for which code is available</h1>
<li><a href="teehr/queries/pandas.html">teehr.queries.pandas</a></li>
<li><a href="teehr/queries/utils.html">teehr.queries.utils</a></li>
<li><a href="teehr/utilities/generate_weights.html">teehr.utilities.generate_weights</a></li>
</ul>
</ul></ul>

</article>

Expand Down
7 changes: 5 additions & 2 deletions docs/sphinx/_build/html/_modules/teehr/api/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@
<link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="icon" sizes="16x16" type="image/png" href="../../../_static/../images/teehr_favicon_16.png" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/teehr.css?v=ab7696e0" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/teehr.css?v=5a67141b" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" />
Expand All @@ -44,6 +43,7 @@
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/design-tabs.js?v=36754332"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/teehr/api/main';</script>
<link rel="icon" href="../../../_static/favicon.png"/>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
Expand Down Expand Up @@ -378,6 +378,9 @@

<li class="breadcrumb-item"><a href="../../index.html" class="nav-link">Module code</a></li>


<li class="breadcrumb-item"><a href="../../teehr.html" class="nav-link">teehr</a></li>

<li class="breadcrumb-item active" aria-current="page">teehr.api.main</li>
</ul>
</nav>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@
<link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="icon" sizes="16x16" type="image/png" href="../../../_static/../images/teehr_favicon_16.png" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/teehr.css?v=ab7696e0" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/teehr.css?v=5a67141b" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" />
Expand All @@ -44,6 +43,7 @@
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/design-tabs.js?v=36754332"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/teehr/database/teehr_dataset';</script>
<link rel="icon" href="../../../_static/favicon.png"/>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
Expand Down Expand Up @@ -378,6 +378,9 @@

<li class="breadcrumb-item"><a href="../../index.html" class="nav-link">Module code</a></li>


<li class="breadcrumb-item"><a href="../../teehr.html" class="nav-link">teehr</a></li>

<li class="breadcrumb-item active" aria-current="page">teehr.databa...</li>
</ul>
</nav>
Expand All @@ -399,6 +402,7 @@ <h1>Source code for teehr.database.teehr_dataset</h1><div class="highlight"><pre
<span></span><span class="sd">&quot;&quot;&quot;Defines the TEEHR dataset class and pre-processing methods.&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Any</span>
<span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>
<span class="kn">import</span> <span class="nn">logging</span>

<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">duckdb</span>
Expand All @@ -420,6 +424,8 @@ <h1>Source code for teehr.database.teehr_dataset</h1><div class="highlight"><pre
<span class="p">)</span>
<span class="kn">from</span> <span class="nn">teehr.models.queries</span> <span class="kn">import</span> <span class="n">MetricEnum</span>

<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>


<div class="viewcode-block" id="TEEHRDatasetAPI">
<a class="viewcode-back" href="../../../autoapi/teehr/database/teehr_dataset/index.html#teehr.database.teehr_dataset.TEEHRDatasetAPI">[docs]</a>
Expand Down Expand Up @@ -500,7 +506,6 @@ <h1>Source code for teehr.database.teehr_dataset</h1><div class="highlight"><pre
<span class="sd"> * Results bprinted to the screen (format=&#39;raw&#39;)</span>
<span class="sd"> * A DuckDBPyRelation, a symbolic representation of the SQL query</span>
<span class="sd"> (format=&#39;relation&#39;).</span>

<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">format</span> <span class="o">==</span> <span class="s2">&quot;df&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">con</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">df</span><span class="p">()</span>
Expand Down Expand Up @@ -579,7 +584,6 @@ <h1>Source code for teehr.database.teehr_dataset</h1><div class="highlight"><pre
<span class="sd"> * Number of duplicate rows</span>
<span class="sd"> * Number of location IDs with duplicate value times</span>
<span class="sd"> * Number of location IDs with missing time steps</span>

<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">primary_dict</span> <span class="o">=</span> <span class="n">tqu_db</span><span class="o">.</span><span class="n">describe_timeseries</span><span class="p">(</span>
<span class="n">timeseries_filepath</span><span class="o">=</span><span class="n">primary_filepath</span>
Expand Down Expand Up @@ -1025,7 +1029,7 @@ <h1>Source code for teehr.database.teehr_dataset</h1><div class="highlight"><pre
<span class="k">for</span> <span class="n">field_name</span> <span class="ow">in</span> <span class="n">schema_df</span><span class="o">.</span><span class="n">column_name</span><span class="o">.</span><span class="n">tolist</span><span class="p">():</span>
<span class="k">if</span> <span class="n">field_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">JoinedFieldNameEnum</span><span class="o">.</span><span class="n">__members__</span><span class="p">:</span>
<span class="k">if</span> <span class="n">drop_added_fields</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Dropping added field </span><span class="si">{</span><span class="n">field_name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Dropping added field </span><span class="si">{</span><span class="n">field_name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_drop_joined_timeseries_field</span><span class="p">(</span><span class="n">field_name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@
<link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../../../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="icon" sizes="16x16" type="image/png" href="../../../../_static/../images/teehr_favicon_16.png" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/teehr.css?v=ab7696e0" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/teehr.css?v=5a67141b" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" />
Expand All @@ -44,6 +43,7 @@
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/design-tabs.js?v=36754332"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/teehr/loading/nwm/grid_utils';</script>
<link rel="icon" href="../../../../_static/favicon.png"/>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
Expand Down Expand Up @@ -378,6 +378,9 @@

<li class="breadcrumb-item"><a href="../../../index.html" class="nav-link">Module code</a></li>


<li class="breadcrumb-item"><a href="../../../teehr.html" class="nav-link">teehr</a></li>

<li class="breadcrumb-item active" aria-current="page">teehr.loadin...</li>
</ul>
</nav>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@
<link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../../../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="icon" sizes="16x16" type="image/png" href="../../../../_static/../images/teehr_favicon_16.png" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/teehr.css?v=ab7696e0" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/teehr.css?v=5a67141b" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" />
Expand All @@ -44,6 +43,7 @@
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/design-tabs.js?v=36754332"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/teehr/loading/nwm/nwm_grids';</script>
<link rel="icon" href="../../../../_static/favicon.png"/>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
Expand Down Expand Up @@ -378,6 +378,9 @@

<li class="breadcrumb-item"><a href="../../../index.html" class="nav-link">Module code</a></li>


<li class="breadcrumb-item"><a href="../../../teehr.html" class="nav-link">teehr</a></li>

<li class="breadcrumb-item active" aria-current="page">teehr.loadin...</li>
</ul>
</nav>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@
<link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../../../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="icon" sizes="16x16" type="image/png" href="../../../../_static/../images/teehr_favicon_16.png" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/teehr.css?v=ab7696e0" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/teehr.css?v=5a67141b" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" />
Expand All @@ -44,6 +43,7 @@
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/design-tabs.js?v=36754332"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/teehr/loading/nwm/nwm_points';</script>
<link rel="icon" href="../../../../_static/favicon.png"/>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
Expand Down Expand Up @@ -378,6 +378,9 @@

<li class="breadcrumb-item"><a href="../../../index.html" class="nav-link">Module code</a></li>


<li class="breadcrumb-item"><a href="../../../teehr.html" class="nav-link">teehr</a></li>

<li class="breadcrumb-item active" aria-current="page">teehr.loadin...</li>
</ul>
</nav>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@
<link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../../../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="icon" sizes="16x16" type="image/png" href="../../../../_static/../images/teehr_favicon_16.png" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/teehr.css?v=ab7696e0" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/teehr.css?v=5a67141b" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" />
Expand All @@ -44,6 +43,7 @@
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/design-tabs.js?v=36754332"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/teehr/loading/nwm/point_utils';</script>
<link rel="icon" href="../../../../_static/favicon.png"/>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
Expand Down Expand Up @@ -378,6 +378,9 @@

<li class="breadcrumb-item"><a href="../../../index.html" class="nav-link">Module code</a></li>


<li class="breadcrumb-item"><a href="../../../teehr.html" class="nav-link">teehr</a></li>

<li class="breadcrumb-item active" aria-current="page">teehr.loadin...</li>
</ul>
</nav>
Expand Down
Loading

0 comments on commit 9ef95a6

Please sign in to comment.