updated version number and documentation of new function

CovingtonResearchGroup · Feb 5, 2018 · a6d3030 · a6d3030
1 parent ed29b89
commit a6d3030
Show file tree

Hide file tree

Showing 94 changed files with 442 additions and 442 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/olm.calcite.dissRateFromCaPCO2.doctree b/docs/_build/doctrees/olm.calcite.dissRateFromCaPCO2.doctree
diff --git a/docs/_build/doctrees/olm.doctree b/docs/_build/doctrees/olm.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.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: 3d55d12245d82e05c77290866a35feed
+config: a3d92aa0155dceab6d3b8f2cc4c6f52c
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Overview: module code &#8212; olm 0.33 documentation</title>
+    <title>Overview: module code &#8212; olm 0.34 documentation</title>
     <link rel="stylesheet" href="../_static//default.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.33',
+        VERSION:     '0.34',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -34,7 +34,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">olm 0.33 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">olm 0.34 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -88,11 +88,11 @@ <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">olm 0.33 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">olm 0.34 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2014,2015 Matthew Covington.
+        &#169; Copyright 2014-2018 Matthew Covington.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
     </div>
   </body>

diff --git a/docs/_build/html/_modules/olm/USGS/DataRetrieval.html b/docs/_build/html/_modules/olm/USGS/DataRetrieval.html
@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>olm.USGS.DataRetrieval &#8212; olm 0.33 documentation</title>
+    <title>olm.USGS.DataRetrieval &#8212; olm 0.34 documentation</title>
     <link rel="stylesheet" href="../../../_static//default.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../../',
-        VERSION:     '0.33',
+        VERSION:     '0.34',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -34,7 +34,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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -371,12 +371,12 @@ <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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2014,2015 Matthew Covington.
+        &#169; Copyright 2014-2018 Matthew Covington.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
     </div>
   </body>

diff --git a/docs/_build/html/_modules/olm/USGS/PhreeqcPandas.html b/docs/_build/html/_modules/olm/USGS/PhreeqcPandas.html
@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>olm.USGS.PhreeqcPandas &#8212; olm 0.33 documentation</title>
+    <title>olm.USGS.PhreeqcPandas &#8212; olm 0.34 documentation</title>
     <link rel="stylesheet" href="../../../_static//default.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../../',
-        VERSION:     '0.33',
+        VERSION:     '0.34',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -34,7 +34,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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -474,12 +474,12 @@ <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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2014,2015 Matthew Covington.
+        &#169; Copyright 2014-2018 Matthew Covington.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
     </div>
   </body>

diff --git a/docs/_build/html/_modules/olm/USGS/WQXtoPandas.html b/docs/_build/html/_modules/olm/USGS/WQXtoPandas.html
@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>olm.USGS.WQXtoPandas &#8212; olm 0.33 documentation</title>
+    <title>olm.USGS.WQXtoPandas &#8212; olm 0.34 documentation</title>
     <link rel="stylesheet" href="../../../_static//default.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../../',
-        VERSION:     '0.33',
+        VERSION:     '0.34',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -34,7 +34,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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -697,12 +697,12 @@ <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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2014,2015 Matthew Covington.
+        &#169; Copyright 2014-2018 Matthew Covington.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
     </div>
   </body>

diff --git a/docs/_build/html/_modules/olm/USGS/loadWaterQualityData.html b/docs/_build/html/_modules/olm/USGS/loadWaterQualityData.html
@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>olm.USGS.loadWaterQualityData &#8212; olm 0.33 documentation</title>
+    <title>olm.USGS.loadWaterQualityData &#8212; olm 0.34 documentation</title>
     <link rel="stylesheet" href="../../../_static//default.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../../',
-        VERSION:     '0.33',
+        VERSION:     '0.34',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -34,7 +34,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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -311,12 +311,12 @@ <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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2014,2015 Matthew Covington.
+        &#169; Copyright 2014-2018 Matthew Covington.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
     </div>
   </body>

diff --git a/docs/_build/html/_modules/olm/USGS/siteListExtraction.html b/docs/_build/html/_modules/olm/USGS/siteListExtraction.html
@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>olm.USGS.siteListExtraction &#8212; olm 0.33 documentation</title>
+    <title>olm.USGS.siteListExtraction &#8212; olm 0.34 documentation</title>
     <link rel="stylesheet" href="../../../_static//default.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../../',
-        VERSION:     '0.33',
+        VERSION:     '0.34',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -34,7 +34,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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -105,12 +105,12 @@ <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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2014,2015 Matthew Covington.
+        &#169; Copyright 2014-2018 Matthew Covington.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
     </div>
   </body>

diff --git a/docs/_build/html/_modules/olm/calcite.html b/docs/_build/html/_modules/olm/calcite.html
@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>olm.calcite &#8212; olm 0.33 documentation</title>
+    <title>olm.calcite &#8212; olm 0.34 documentation</title>
     <link rel="stylesheet" href="../../_static//default.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '0.33',
+        VERSION:     '0.34',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -34,7 +34,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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -1340,7 +1340,7 @@ <h1>Source code for olm.calcite</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="dissRateFromCaPCO2"><a class="viewcode-back" href="../../olm.calcite.dissRateFromCaPCO2.html#olm.calcite.dissRateFromCaPCO2">[docs]</a><span class="k">def</span> <span class="nf">dissRateFromCaPCO2</span><span class="p">(</span><span class="n">Ca</span><span class="p">,</span> <span class="n">PCO2</span><span class="p">,</span> <span class="n">T_C</span><span class="p">,</span> <span class="n">rho</span><span class="o">=</span><span class="mf">2.6</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">impure</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">per_tol</span><span class="o">=</span><span class="mf">0.001</span><span class="p">,</span> <span class="n">error</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">error_num</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">Ca_err</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">PCO2_err</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">molL</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    Calculates the calcite/limestone dissolution rate from given calcite concentration and PCO2.</span>
+<span class="sd">    Calculates the calcite/limestone dissolution rate from given calcium concentration and PCO2. Optionally uses Monte Carlo error propagation to calculate uncertainty in rates.</span>
 
 <span class="sd">    Parameters</span>
 <span class="sd">    ----------</span>
@@ -1374,7 +1374,7 @@ <h1>Source code for olm.calcite</h1><div class="highlight"><pre>
 <span class="sd">    R : float, numpy.ndarray, or pandas Series</span>
 <span class="sd">       calcite dissolution rate in mm/yr</span>
 <span class="sd">    R_err : float, numpy.ndarray, or pandas Series</span>
-<span class="sd">       error in dissolution rate (if keyword error=True)</span>
+<span class="sd">       error in dissolution rate (returned with R if keyword error=True)</span>
 <span class="sd">       </span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c1">#Function for Monte Carlo error estimation</span>
@@ -1486,12 +1486,12 @@ <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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2014,2015 Matthew Covington.
+        &#169; Copyright 2014-2018 Matthew Covington.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
     </div>
   </body>

diff --git a/docs/_build/html/_modules/olm/general.html b/docs/_build/html/_modules/olm/general.html
@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>olm.general &#8212; olm 0.33 documentation</title>
+    <title>olm.general &#8212; olm 0.34 documentation</title>
     <link rel="stylesheet" href="../../_static//default.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '0.33',
+        VERSION:     '0.34',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -34,7 +34,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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -685,12 +685,12 @@ <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">olm 0.33 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">olm 0.34 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2014,2015 Matthew Covington.
+        &#169; Copyright 2014-2018 Matthew Covington.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
     </div>
   </body>