Deploying to gh-pages from @ b559c93 🚀

DOI-USGS · Aug 24, 2023 · 76762c7 · 76762c7
1 parent 3c85b4a
commit 76762c7
Show file tree

Hide file tree

Showing 58 changed files with 266 additions and 170 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: 8e88ed13909c0978b1ff2291750432b7
+config: 95c7cebc9300e785e8ad295f7a43e389
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/...loads/0013bf4e546f0e63239285a0f723a8df/flow_duration_curve_examples-6.hires.png b/...loads/0013bf4e546f0e63239285a0f723a8df/flow_duration_curve_examples-6.hires.png
diff --git a/.../1677645752848bc9008fe6b1519c90ad/streamflow_duration_hydrograph_examples-9.png b/.../1677645752848bc9008fe6b1519c90ad/streamflow_duration_hydrograph_examples-9.png
diff --git a/.../318285d6e07f1e37cadebd8011bbdb16/streamflow_duration_hydrograph_examples-7.png b/.../318285d6e07f1e37cadebd8011bbdb16/streamflow_duration_hydrograph_examples-7.png
diff --git a/...b71c6b6ec9cd6259fa6dfbc4ac4/streamflow_duration_hydrograph_examples-9.hires.png b/...b71c6b6ec9cd6259fa6dfbc4ac4/streamflow_duration_hydrograph_examples-9.hires.png
diff --git a/_downloads/4267ab6a2b7d67bf2141024b973405b7/index-3.hires.png b/_downloads/4267ab6a2b7d67bf2141024b973405b7/index-3.hires.png
diff --git a/_downloads/4ead256d405dfdd65dec28f814f9c71e/index-3.png b/_downloads/4ead256d405dfdd65dec28f814f9c71e/index-3.png
diff --git a/_downloads/57ed8610b3bf488e373aa52cb753936c/flow_duration_curve_examples-4.png b/_downloads/57ed8610b3bf488e373aa52cb753936c/flow_duration_curve_examples-4.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/...da13c1bd589795b5b6efbfc848/streamflow_duration_hydrograph_examples-10.hires.png b/...da13c1bd589795b5b6efbfc848/streamflow_duration_hydrograph_examples-10.hires.png
diff --git a/...0a426028e1b118cfd2f18a762a0/streamflow_duration_hydrograph_examples-6.hires.png b/...0a426028e1b118cfd2f18a762a0/streamflow_duration_hydrograph_examples-6.hires.png
diff --git a/...ebdaf71556680bd0917ca024b75/streamflow_duration_hydrograph_examples-8.hires.png b/...ebdaf71556680bd0917ca024b75/streamflow_duration_hydrograph_examples-8.hires.png
diff --git a/...134355e5e354b880955a22dbff8/streamflow_duration_hydrograph_examples-7.hires.png b/...134355e5e354b880955a22dbff8/streamflow_duration_hydrograph_examples-7.hires.png
diff --git a/...a5fd06ef4a7392082f9a523bff9adab5/streamflow_duration_hydrograph_examples-10.png b/...a5fd06ef4a7392082f9a523bff9adab5/streamflow_duration_hydrograph_examples-10.png
diff --git a/.../b3e79790d257a541582c8eca76578272/streamflow_duration_hydrograph_examples-6.png b/.../b3e79790d257a541582c8eca76578272/streamflow_duration_hydrograph_examples-6.png
diff --git a/...loads/cf679bd8812ecfcec558377d79794621/flow_duration_curve_examples-4.hires.png b/...loads/cf679bd8812ecfcec558377d79794621/flow_duration_curve_examples-4.hires.png
diff --git a/.../dd25a94f4bbf0d94a9ed00f98f187da8/streamflow_duration_hydrograph_examples-8.png b/.../dd25a94f4bbf0d94a9ed00f98f187da8/streamflow_duration_hydrograph_examples-8.png
diff --git a/_downloads/e6c156a9724701eb308f2075973eb9f2/flow_duration_curve_examples-5.png b/_downloads/e6c156a9724701eb308f2075973eb9f2/flow_duration_curve_examples-5.png
diff --git a/_downloads/fa2abee6a40b2587f894299768f4d5c0/flow_duration_curve_examples-6.png b/_downloads/fa2abee6a40b2587f894299768f4d5c0/flow_duration_curve_examples-6.png
diff --git a/_images/flow_duration_curve_examples-4.png b/_images/flow_duration_curve_examples-4.png
diff --git a/_images/flow_duration_curve_examples-5.png b/_images/flow_duration_curve_examples-5.png
diff --git a/_images/flow_duration_curve_examples-6.png b/_images/flow_duration_curve_examples-6.png
diff --git a/_images/index-3.png b/_images/index-3.png
diff --git a/_images/streamflow_duration_hydrograph_examples-10.png b/_images/streamflow_duration_hydrograph_examples-10.png
diff --git a/_images/streamflow_duration_hydrograph_examples-6.png b/_images/streamflow_duration_hydrograph_examples-6.png
diff --git a/_images/streamflow_duration_hydrograph_examples-7.png b/_images/streamflow_duration_hydrograph_examples-7.png
diff --git a/_images/streamflow_duration_hydrograph_examples-8.png b/_images/streamflow_duration_hydrograph_examples-8.png
diff --git a/_images/streamflow_duration_hydrograph_examples-9.png b/_images/streamflow_duration_hydrograph_examples-9.png
diff --git a/_modules/hyswap/cumulative.html b/_modules/hyswap/cumulative.html
@@ -6,12 +6,12 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>hyswap.cumulative &#8212; hyswap 0.1.dev1+g934b6c5 documentation</title>
+    <title>hyswap.cumulative &#8212; hyswap 0.1.dev1+gb559c93 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=f15d3b81" />
     <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
 
-    <script src="../../_static/documentation_options.js?v=a7efe5e2"></script>
+    <script src="../../_static/documentation_options.js?v=a3b49272"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/bizstyle.js"></script>
@@ -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+g934b6c5 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">hyswap 0.1.dev1+gb559c93 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>
@@ -199,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+g934b6c5 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">hyswap 0.1.dev1+gb559c93 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.2.2.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.3.
     </div>
   </body>
 </html>
diff --git a/_modules/hyswap/exceedance.html b/_modules/hyswap/exceedance.html
@@ -6,12 +6,12 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>hyswap.exceedance &#8212; hyswap 0.1.dev1+g934b6c5 documentation</title>
+    <title>hyswap.exceedance &#8212; hyswap 0.1.dev1+gb559c93 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=f15d3b81" />
     <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
 
-    <script src="../../_static/documentation_options.js?v=a7efe5e2"></script>
+    <script src="../../_static/documentation_options.js?v=a3b49272"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/bizstyle.js"></script>
@@ -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+g934b6c5 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">hyswap 0.1.dev1+gb559c93 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>
@@ -123,17 +123,24 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
 
 <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="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="n">method</span><span class="o">=</span><span class="s2">&quot;weibull&quot;</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>
 
-<span class="sd">    This function specifically counts the number of values from the input</span>
-<span class="sd">    `values_to_compare` that are *greater than or equal to* the input value</span>
-<span class="sd">    `x`. The choice of greater than or equal, as opposed to solely greater than</span>
-<span class="sd">    is intentional and follows established USGS practices [1]_.</span>
+<span class="sd">    This function computes an exceedance probability using common plotting</span>
+<span class="sd">    position formulas, with the default being the &#39;Weibull&#39; method (also known</span>
+<span class="sd">    as Type 6 in R). The value (x) is ranked among the values to compare by</span>
+<span class="sd">    determining the number that are *greater than or equal to* the</span>
+<span class="sd">    input value (x), which provides the minimum rank in the case of tied</span>
+<span class="sd">    values. Additional methods other than the &#39;Weibull&#39; method can be specified</span>
+<span class="sd">    and are described in more detail in [1]_.</span>
 
-<span class="sd">    .. [1] Searcy, J. K. &quot;Flow-duration curves: Water Supply Paper 1542-A.&quot;</span>
-<span class="sd">           US Geological Survey, Reston, VA (1959).</span>
+<span class="sd">    .. [1] Helsel, D.R., Hirsch, R.M., Ryberg, K.R., Archfield, S.A., and</span>
+<span class="sd">    Gilroy, E.J., 2020, Statistical methods in water resources: U.S. Geological</span>
+<span class="sd">    Survey Techniques and Methods, book 4, chap. A3, 458 p.,</span>
+<span class="sd">    https://doi.org/10.3133/tm4a3. [Supersedes USGS Techniques of</span>
+<span class="sd">    Water-Resources Investigations, book 4, chap. A3, version 1.1.]</span>
 
 <span class="sd">    Parameters</span>
 <span class="sd">    ----------</span>
@@ -142,6 +149,10 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
 <span class="sd">    values_to_compare : array-like</span>
 <span class="sd">        The values to use to calculate the exceedance probability.</span>
 
+<span class="sd">    method : str, optional</span>
+<span class="sd">        Method (formulation) of plotting position formula.</span>
+<span class="sd">        Default is &#39;weibull&#39; (Type 6).</span>
+
 <span class="sd">    Returns</span>
 <span class="sd">    -------</span>
 <span class="sd">    float</span>
@@ -155,7 +166,7 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
 <span class="sd">    .. doctest::</span>
 
 <span class="sd">        &gt;&gt;&gt; exceedance.calculate_exceedance_probability_from_values(</span>
-<span class="sd">        ...     1, [1, 2, 3, 4])</span>
+<span class="sd">        ...     1, [1, 2, 3, 4], method=&#39;linear&#39;)</span>
 <span class="sd">        1.0</span>
 
 <span class="sd">    Calculating the exceedance probability of a value of 5 from a set of values</span>
@@ -167,6 +178,29 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
 <span class="sd">        ...     5, [1, 2, 3, 4])</span>
 <span class="sd">        0.0</span>
 <span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="k">if</span> <span class="n">method</span> <span class="o">==</span> <span class="s1">&#39;weibull&#39;</span><span class="p">:</span>     <span class="c1"># R Type 6</span>
+        <span class="n">alpha</span> <span class="o">=</span> <span class="mi">0</span>
+        <span class="n">beta</span> <span class="o">=</span> <span class="mi">0</span>
+    <span class="k">elif</span> <span class="n">method</span> <span class="o">==</span> <span class="s1">&#39;linear&#39;</span><span class="p">:</span>    <span class="c1"># R Type 4</span>
+        <span class="n">alpha</span> <span class="o">=</span> <span class="mi">0</span>
+        <span class="n">beta</span> <span class="o">=</span> <span class="mi">1</span>
+    <span class="k">elif</span> <span class="n">method</span> <span class="o">==</span> <span class="s1">&#39;hazen&#39;</span><span class="p">:</span>     <span class="c1"># R Type 5</span>
+        <span class="n">alpha</span> <span class="o">=</span> <span class="mf">0.5</span>
+        <span class="n">beta</span> <span class="o">=</span> <span class="mf">0.5</span>
+    <span class="k">elif</span> <span class="n">method</span> <span class="o">==</span> <span class="s1">&#39;gumbel&#39;</span><span class="p">:</span>    <span class="c1"># R Type 7</span>
+        <span class="n">alpha</span> <span class="o">=</span> <span class="mi">1</span>
+        <span class="n">beta</span> <span class="o">=</span> <span class="mi">1</span>
+    <span class="k">elif</span> <span class="n">method</span> <span class="o">==</span> <span class="s2">&quot;reiss&quot;</span><span class="p">:</span>     <span class="c1"># R Type 8</span>
+        <span class="n">alpha</span> <span class="o">=</span> <span class="mi">1</span><span class="o">/</span><span class="mi">3</span>
+        <span class="n">beta</span> <span class="o">=</span> <span class="mi">1</span><span class="o">/</span><span class="mi">3</span>
+    <span class="k">elif</span> <span class="n">method</span> <span class="o">==</span> <span class="s2">&quot;blom&quot;</span><span class="p">:</span>      <span class="c1"># R Type 9</span>
+        <span class="n">alpha</span> <span class="o">=</span> <span class="mi">3</span><span class="o">/</span><span class="mi">8</span>
+        <span class="n">beta</span> <span class="o">=</span> <span class="mi">3</span><span class="o">/</span><span class="mi">8</span>
+    <span class="k">else</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;dist must be one of &#39;weibull&#39;, &#39;linear&#39;,&quot;</span> <span class="o">+</span>
+                         <span class="s2">&quot;&#39;hazen&#39;, &#39;gumbel&#39;, &#39;reiss&#39;, or &#39;blom&#39;.&quot;</span><span class="p">)</span>
+
     <span class="c1"># some type conversions to get to a numpy array</span>
     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">values_to_compare</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
         <span class="n">values_to_compare</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">values_to_compare</span><span class="p">)</span>
@@ -177,7 +211,9 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
         <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;values_to_compare must be a numpy array, list, &quot;</span> <span class="o">+</span>
                         <span class="s2">&quot;or pandas Series.&quot;</span><span class="p">)</span>
     <span class="c1"># calculate the exceedance probability</span>
-    <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>
+    <span class="n">exceed_prob</span> <span class="o">=</span> <span class="p">(</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="n">alpha</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">values_to_compare</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="o">-</span> <span class="n">alpha</span> <span class="o">-</span> <span class="n">beta</span><span class="p">)</span>  <span class="c1"># noqa: E501</span>
+
+    <span class="k">return</span> <span class="n">exceed_prob</span></div>
 
 
 
@@ -242,16 +278,22 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
 <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="n">values_to_compare</span><span class="p">,</span>
+                                                          <span class="n">method</span><span class="o">=</span><span class="s2">&quot;weibull&quot;</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>
+<span class="sd">    All methods supported in *calculate_exceedance_probability_from_values*</span>
+<span class="sd">    are supported and by default uses the &#39;Weibull&#39; method.</span>
 
 <span class="sd">    Parameters</span>
 <span class="sd">    ----------</span>
 <span class="sd">    values : array-like</span>
 <span class="sd">        The values for which to calculate the exceedance probability.</span>
 <span class="sd">    values_to_compare : array-like</span>
 <span class="sd">        The values to use to calculate the exceedance probability.</span>
+<span class="sd">    method : str, optional</span>
+<span class="sd">        Method (formulation) of plotting position formula.</span>
+<span class="sd">        Default is &#39;weibull&#39; (Type 6).</span>
 
 <span class="sd">    Returns</span>
 <span class="sd">    -------</span>
@@ -266,7 +308,7 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
 <span class="sd">    .. doctest::</span>
 
 <span class="sd">        &gt;&gt;&gt; exceedance.calculate_exceedance_probability_from_values_multiple(</span>
-<span class="sd">        ...     [1, 1.25, 2.5], [1, 2, 3, 4])</span>
+<span class="sd">        ...     [1, 1.25, 2.5], [1, 2, 3, 4], method=&#39;linear&#39;)</span>
 <span class="sd">        array([1.  , 0.75, 0.5 ])</span>
 
 <span class="sd">    Fetch some data from NWIS and calculate the exceedance probability for a</span>
@@ -285,7 +327,7 @@ <h1>Source code for hyswap.exceedance</h1><div class="highlight"><pre>
 <span class="sd">        array([1.        , 0.96363636, 0.83636364, 0.47272727, 0.01818182])</span>
 <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>
+        <span class="n">x</span><span class="p">,</span> <span class="n">values_to_compare</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="n">method</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>
 
@@ -318,14 +360,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+g934b6c5 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">hyswap 0.1.dev1+gb559c93 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.2.2.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.3.
     </div>
   </body>
 </html>