Deploying to gh-pages from @ dcc7916 🚀

DOI-USGS · Aug 21, 2023 · c9ed039 · c9ed039
1 parent 86b4a75
commit c9ed039
Show file tree

Hide file tree

Showing 55 changed files with 1,698 additions and 363 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -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: db223b98a23d8b34e758885381c3cf4e
+config: 8a787254773681215798eb2e50dff41d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_downloads/1e8236fb3d31a317b1c34ff861150124/similarity_examples-5.hires.png b/_downloads/1e8236fb3d31a317b1c34ff861150124/similarity_examples-5.hires.png
diff --git a/_downloads/40423e11d6e99b58c33bb0d76dda903f/similarity_examples-4.hires.png b/_downloads/40423e11d6e99b58c33bb0d76dda903f/similarity_examples-4.hires.png
diff --git a/_downloads/49384fb54eb1dfe3c84bac7d3e069bfc/similarity_examples-5.png b/_downloads/49384fb54eb1dfe3c84bac7d3e069bfc/similarity_examples-5.png
diff --git a/...loads/673f52eb5229b209fe0b5faf997910af/flow_duration_curve_examples-5.hires.png b/...loads/673f52eb5229b209fe0b5faf997910af/flow_duration_curve_examples-5.hires.png
diff --git a/_downloads/72ef893d3fadbacea7b6adae1e4280aa/index-6.hires.png b/_downloads/72ef893d3fadbacea7b6adae1e4280aa/index-6.hires.png
diff --git a/_downloads/77bff4448d915acc8b9cce71410ee204/similarity_examples-2.png b/_downloads/77bff4448d915acc8b9cce71410ee204/similarity_examples-2.png
diff --git a/_downloads/869827d4a39dc05a6ff889cd05729475/index-6.png b/_downloads/869827d4a39dc05a6ff889cd05729475/index-6.png
diff --git a/_downloads/b3620d145d83b447a4fc98b4bb4ffeaf/similarity_examples-3.hires.png b/_downloads/b3620d145d83b447a4fc98b4bb4ffeaf/similarity_examples-3.hires.png
diff --git a/_downloads/c2ab381d3f41e6c05566af9eb27f5932/similarity_examples-2.hires.png b/_downloads/c2ab381d3f41e6c05566af9eb27f5932/similarity_examples-2.hires.png
diff --git a/_downloads/d5581bd2b32570239e1161370cb8362e/similarity_examples-4.png b/_downloads/d5581bd2b32570239e1161370cb8362e/similarity_examples-4.png
diff --git a/_downloads/e0cbf90d607cb28567961a67b21cda1a/similarity_examples-3.png b/_downloads/e0cbf90d607cb28567961a67b21cda1a/similarity_examples-3.png
diff --git a/_downloads/e6c156a9724701eb308f2075973eb9f2/flow_duration_curve_examples-5.png b/_downloads/e6c156a9724701eb308f2075973eb9f2/flow_duration_curve_examples-5.png
diff --git a/_images/flow_duration_curve_examples-5.png b/_images/flow_duration_curve_examples-5.png
diff --git a/_images/hyswap.png b/_images/hyswap.png
diff --git a/_images/index-6.png b/_images/index-6.png
diff --git a/_images/similarity_examples-2.png b/_images/similarity_examples-2.png
diff --git a/_images/similarity_examples-3.png b/_images/similarity_examples-3.png
diff --git a/_images/similarity_examples-4.png b/_images/similarity_examples-4.png
diff --git a/_images/similarity_examples-5.png b/_images/similarity_examples-5.png
diff --git a/_modules/hyswap/cumulative.html b/_modules/hyswap/cumulative.html
@@ -2,18 +2,18 @@
 
 <!doctype html>
 
-<html lang="en">
+<html lang="en" data-content_root="../../">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>hyswap.cumulative &#8212; hyswap 0.1.dev1+gc646d0d documentation</title>
+    <title>hyswap.cumulative &#8212; hyswap 0.1.dev1+gdcc7916 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
-    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=b6f88001" />
+    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=f15d3b81" />
     <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
 
-    <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=73f2e1c3"></script>
+    <script src="../../_static/documentation_options.js?v=79f726e0"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
-    <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/bizstyle.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">hyswap 0.1.dev1+gc646d0d documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">hyswap 0.1.dev1+gdcc7916 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">hyswap.cumulative</a></li> 
       </ul>
@@ -50,7 +50,9 @@ <h1>Source code for hyswap.cumulative</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">hyswap.utils</span> <span class="kn">import</span> <span class="n">define_year_doy_columns</span>
 
 
-<div class="viewcode-block" id="calculate_daily_cumulative_values"><a class="viewcode-back" href="../../reference/index.html#hyswap.cumulative.calculate_daily_cumulative_values">[docs]</a><span class="k">def</span> <span class="nf">calculate_daily_cumulative_values</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">data_column_name</span><span class="p">,</span>
+<div class="viewcode-block" id="calculate_daily_cumulative_values">
+<a class="viewcode-back" href="../../reference/index.html#hyswap.cumulative.calculate_daily_cumulative_values">[docs]</a>
+<span class="k">def</span> <span class="nf">calculate_daily_cumulative_values</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">data_column_name</span><span class="p">,</span>
                                       <span class="n">date_column_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                       <span class="n">year_type</span><span class="o">=</span><span class="s1">&#39;calendar&#39;</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Calculate daily cumulative values.</span>
@@ -116,7 +118,10 @@ <h1>Source code for hyswap.cumulative</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">cdf</span></div>
 
 
-<div class="viewcode-block" id="_tidy_cumulative_dataframe"><a class="viewcode-back" href="../../reference/index.html#hyswap.cumulative._tidy_cumulative_dataframe">[docs]</a><span class="k">def</span> <span class="nf">_tidy_cumulative_dataframe</span><span class="p">(</span><span class="n">cdf</span><span class="p">,</span> <span class="n">year_type</span><span class="p">):</span>
+
+<div class="viewcode-block" id="_tidy_cumulative_dataframe">
+<a class="viewcode-back" href="../../reference/index.html#hyswap.cumulative._tidy_cumulative_dataframe">[docs]</a>
+<span class="k">def</span> <span class="nf">_tidy_cumulative_dataframe</span><span class="p">(</span><span class="n">cdf</span><span class="p">,</span> <span class="n">year_type</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Tidy a cumulative dataframe.</span>
 
 <span class="sd">    Parameters</span>
@@ -162,6 +167,7 @@ <h1>Source code for hyswap.cumulative</h1><div class="highlight"><pre>
     <span class="c1"># set date to index</span>
     <span class="n">cdf2</span> <span class="o">=</span> <span class="n">cdf2</span><span class="o">.</span><span class="n">set_index</span><span class="p">(</span><span class="s2">&quot;date&quot;</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">cdf2</span></div>
+
 </pre></div>
 
             <div class="clearer"></div>
@@ -193,14 +199,14 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">hyswap 0.1.dev1+gc646d0d documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">hyswap 0.1.dev1+gdcc7916 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">hyswap.cumulative</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
     &#169; Copyright .
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.1.2.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.2.
     </div>
   </body>
 </html>
diff --git a/_modules/hyswap/exceedance.html b/_modules/hyswap/exceedance.html
@@ -2,18 +2,18 @@
 
 <!doctype html>
 
-<html lang="en">
+<html lang="en" data-content_root="../../">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>hyswap.exceedance &#8212; hyswap 0.1.dev1+gc646d0d documentation</title>
+    <title>hyswap.exceedance &#8212; hyswap 0.1.dev1+gdcc7916 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
-    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=b6f88001" />
+    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=f15d3b81" />
     <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
 
-    <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=73f2e1c3"></script>
+    <script src="../../_static/documentation_options.js?v=79f726e0"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
-    <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/bizstyle.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">hyswap 0.1.dev1+gc646d0d documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">hyswap 0.1.dev1+gdcc7916 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">hyswap.exceedance</a></li> 
       </ul>
@@ -50,7 +50,9 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">scipy</span> <span class="kn">import</span> <span class="n">stats</span>
 
 
-<div class="viewcode-block" id="calculate_exceedance_probability_from_distribution"><a class="viewcode-back" href="../../reference/index.html#hyswap.exceedance.calculate_exceedance_probability_from_distribution">[docs]</a><span class="k">def</span> <span class="nf">calculate_exceedance_probability_from_distribution</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">dist</span><span class="p">,</span>
+<div class="viewcode-block" id="calculate_exceedance_probability_from_distribution">
+<a class="viewcode-back" href="../../reference/index.html#hyswap.exceedance.calculate_exceedance_probability_from_distribution">[docs]</a>
+<span class="k">def</span> <span class="nf">calculate_exceedance_probability_from_distribution</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">dist</span><span class="p">,</span>
                                                        <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Calculate the exceedance probability of a value relative to a distribution.</span>
@@ -118,7 +120,10 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
                          <span class="s2">&quot;&#39;weibull&#39;, or &#39;exponential&#39;.&quot;</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="calculate_exceedance_probability_from_values"><a class="viewcode-back" href="../../reference/index.html#hyswap.exceedance.calculate_exceedance_probability_from_values">[docs]</a><span class="k">def</span> <span class="nf">calculate_exceedance_probability_from_values</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">values_to_compare</span><span class="p">):</span>
+
+<div class="viewcode-block" id="calculate_exceedance_probability_from_values">
+<a class="viewcode-back" href="../../reference/index.html#hyswap.exceedance.calculate_exceedance_probability_from_values">[docs]</a>
+<span class="k">def</span> <span class="nf">calculate_exceedance_probability_from_values</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">values_to_compare</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Calculate the exceedance probability of a value compared to several values.</span>
 
@@ -175,7 +180,10 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">values_to_compare</span> <span class="o">&gt;=</span> <span class="n">x</span><span class="p">)</span> <span class="o">/</span> <span class="nb">len</span><span class="p">(</span><span class="n">values_to_compare</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="calculate_exceedance_probability_from_distribution_multiple"><a class="viewcode-back" href="../../reference/index.html#hyswap.exceedance.calculate_exceedance_probability_from_distribution_multiple">[docs]</a><span class="k">def</span> <span class="nf">calculate_exceedance_probability_from_distribution_multiple</span><span class="p">(</span><span class="n">values</span><span class="p">,</span> <span class="n">dist</span><span class="p">,</span>
+
+<div class="viewcode-block" id="calculate_exceedance_probability_from_distribution_multiple">
+<a class="viewcode-back" href="../../reference/index.html#hyswap.exceedance.calculate_exceedance_probability_from_distribution_multiple">[docs]</a>
+<span class="k">def</span> <span class="nf">calculate_exceedance_probability_from_distribution_multiple</span><span class="p">(</span><span class="n">values</span><span class="p">,</span> <span class="n">dist</span><span class="p">,</span>
                                                                 <span class="o">*</span><span class="n">args</span><span class="p">,</span>
                                                                 <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
@@ -230,7 +238,10 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
         <span class="n">x</span><span class="p">,</span> <span class="n">dist</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">values</span><span class="p">])</span></div>
 
 
-<div class="viewcode-block" id="calculate_exceedance_probability_from_values_multiple"><a class="viewcode-back" href="../../reference/index.html#hyswap.exceedance.calculate_exceedance_probability_from_values_multiple">[docs]</a><span class="k">def</span> <span class="nf">calculate_exceedance_probability_from_values_multiple</span><span class="p">(</span><span class="n">values</span><span class="p">,</span>
+
+<div class="viewcode-block" id="calculate_exceedance_probability_from_values_multiple">
+<a class="viewcode-back" href="../../reference/index.html#hyswap.exceedance.calculate_exceedance_probability_from_values_multiple">[docs]</a>
+<span class="k">def</span> <span class="nf">calculate_exceedance_probability_from_values_multiple</span><span class="p">(</span><span class="n">values</span><span class="p">,</span>
                                                           <span class="n">values_to_compare</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Calculate the exceedance probability of multiple values vs a set of values.</span>
@@ -275,6 +286,7 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="n">calculate_exceedance_probability_from_values</span><span class="p">(</span>
         <span class="n">x</span><span class="p">,</span> <span class="n">values_to_compare</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">values</span><span class="p">])</span></div>
+
 </pre></div>
 
             <div class="clearer"></div>
@@ -306,14 +318,14 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">hyswap 0.1.dev1+gc646d0d documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">hyswap 0.1.dev1+gdcc7916 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">hyswap.exceedance</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
     &#169; Copyright .
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.1.2.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.2.
     </div>
   </body>
 </html>