climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lewi...@apache.org
Subject svn commit: r1830784 [7/12] - in /climate/site/trunk/content/api/current: ./ _sources/ _sources/config/ _sources/data_source/ _sources/ocw/ _sources/ui-backend/ _static/ config/ data_source/ ocw/ ui-backend/
Date Wed, 02 May 2018 18:41:56 GMT
Modified: climate/site/trunk/content/api/current/ocw/dataset_loader.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/ocw/dataset_loader.html?rev=1830784&r1=1830783&r2=1830784&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/ocw/dataset_loader.html (original)
+++ climate/site/trunk/content/api/current/ocw/dataset_loader.html Wed May  2 18:41:55 2018
@@ -1,23 +1,21 @@
+
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
-
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    
-    <title>Dataset Loader Module &#8212; Apache Open Climate Workbench 1.2.0 documentation</title>
-    
+    <title>Dataset Loader Module &#8212; Apache Open Climate Workbench 1.3.0 documentation</title>
     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '1.2.0',
+        VERSION:     '1.3.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
       };
     </script>
     <script type="text/javascript" src="../_static/jquery.js"></script>
@@ -25,7 +23,6 @@
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="top" title="Apache Open Climate Workbench 1.2.0 documentation" href="../index.html" />
     <link rel="next" title="Dataset Processor Module" href="dataset_processor.html" />
     <link rel="prev" title="Dataset Module" href="dataset.html" />
    
@@ -35,7 +32,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head>
-  <body role="document">
+  <body>
   
 
     <div class="document">
@@ -55,79 +52,76 @@
 <dd><p>Generate a list of OCW Dataset objects from a variety of sources.</p>
 <p>Generate a list of OCW Dataset objects from a variety of sources.</p>
 <p>Each keyword argument can be information for a dataset in dictionary
-form. For example:
-``
-&gt;&gt;&gt; loader_opt1 = {&#8216;loader_name&#8217;: &#8216;rcmed&#8217;, &#8216;name&#8217;: &#8216;cru&#8217;,</p>
-<blockquote>
-<div>&#8216;dataset_id&#8217;: 10, &#8216;parameter_id&#8217;: 34}</div></blockquote>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">loader_opt2</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;path&#39;</span><span class="p">:</span> <span class="s1">&#39;./data/TRMM_v7_3B43_1980-2010.nc,</span>
+form. For example:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">loader_opt1</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;loader_name&#39;</span><span class="p">:</span> <span class="s1">&#39;rcmed&#39;</span><span class="p">,</span> <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s1">&#39;cru&#39;</span><span class="p">,</span>
+<span class="go">                   &#39;dataset_id&#39;: 10, &#39;parameter_id&#39;: 34}</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">loader_opt2</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;path&#39;</span><span class="p">:</span> <span class="s1">&#39;./data/TRMM_v7_3B43_1980-2010.nc,</span>
 <span class="go">                   &#39;variable&#39;: &#39;pcp&#39;}</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">loader</span> <span class="o">=</span> <span class="n">DatasetLoader</span><span class="p">(</span><span class="n">loader_opt1</span><span class="p">,</span> <span class="n">loader_opt2</span><span class="p">)</span>
-<span class="go">``</span>
 </pre></div>
 </div>
 <p>Or more conveniently if the loader configuration is defined in a
-yaml file named config_file (see RCMES examples):
-``
-&gt;&gt;&gt; import yaml
-&gt;&gt;&gt; config = yaml.load(open(config_file))
-&gt;&gt;&gt; obs_loader_config = config[&#8216;datasets&#8217;][&#8216;reference&#8217;]
-&gt;&gt;&gt; loader = DatasetLoader(<a href="#id1"><span class="problematic" id="id2">*</span></a>obs_loader_config)
-``</p>
+yaml file named config_file (see RCMES examples):</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">yaml</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">config</span> <span class="o">=</span> <span class="n">yaml</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="n">config_file</span><span class="p">))</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">obs_loader_config</span> <span class="o">=</span> <span class="n">config</span><span class="p">[</span><span class="s1">&#39;datasets&#39;</span><span class="p">][</span><span class="s1">&#39;reference&#39;</span><span class="p">]</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">loader</span> <span class="o">=</span> <span class="n">DatasetLoader</span><span class="p">(</span><span class="o">*</span><span class="n">obs_loader_config</span><span class="p">)</span>
+</pre></div>
+</div>
 <p>As shown in the first example, the dictionary for each argument should
 contain a loader name and parameters specific to the particular loader.
-Once the configuration is entered, the datasets may be loaded using:
-``
-&gt;&gt;&gt; loader.load_datasets()
-&gt;&gt;&gt; obs_datasets = loader.datasets
-``</p>
+Once the configuration is entered, the datasets may be loaded using:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">loader</span><span class="o">.</span><span class="n">load_datasets</span><span class="p">()</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">obs_datasets</span> <span class="o">=</span> <span class="n">loader</span><span class="o">.</span><span class="n">datasets</span>
+</pre></div>
+</div>
 <p>Additionally, each dataset must have a <code class="docutils literal"><span class="pre">loader_name</span></code> keyword. This may
-be one of the following:
-* <code class="docutils literal"><span class="pre">'local'</span></code> - One or multiple dataset files in a local directory
-* <code class="docutils literal"><span class="pre">'local_split'</span></code> - A single dataset split accross multiple files in a</p>
-<blockquote>
-<div>local directory</div></blockquote>
-<ul>
+be one of the following:</p>
+<ul class="simple">
+<li><code class="docutils literal"><span class="pre">'local'</span></code> - One or multiple dataset files in a local directory</li>
+<li><dl class="first docutils">
+<dt><code class="docutils literal"><span class="pre">'local_split'</span></code> - A single dataset split accross multiple files in a</dt>
+<dd>local directory</dd>
+</dl>
+</li>
 <li><dl class="first docutils">
 <dt><code class="docutils literal"><span class="pre">'esgf'</span></code> - Download the dataset from the Earth System Grid</dt>
-<dd><p class="first last">Federation</p>
-</dd>
+<dd>Federation</dd>
 </dl>
 </li>
 <li><dl class="first docutils">
 <dt><code class="docutils literal"><span class="pre">'rcmed'</span></code> - Download the dataset from the Regional Climate Model</dt>
-<dd><p class="first last">Evaluation System Database</p>
-</dd>
+<dd>Evaluation System Database</dd>
 </dl>
 </li>
-<li><p class="first"><code class="docutils literal"><span class="pre">'dap'</span></code> - Download the dataset from an OPeNDAP URL</p>
-</li>
+<li><code class="docutils literal"><span class="pre">'dap'</span></code> - Download the dataset from an OPeNDAP URL</li>
 <li><dl class="first docutils">
 <dt><code class="docutils literal"><span class="pre">'podaac'</span></code> - Download the dataset from Physical Oceanography</dt>
-<dd><p class="first last">Distributed Active Archive Center</p>
-</dd>
+<dd>Distributed Active Archive Center</dd>
 </dl>
 </li>
 </ul>
 <p>Users who wish to load datasets from loaders not described above may
 define their own custom dataset loader function and incorporate it as
-follows:
-&gt;&gt;&gt; loader.add_source_loader(&#8216;my_loader_name&#8217;, my_loader_func)</p>
+follows:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">loader</span><span class="o">.</span><span class="n">add_source_loader</span><span class="p">(</span><span class="s1">&#39;my_loader_name&#39;</span><span class="p">,</span> <span class="n">my_loader_func</span><span class="p">)</span>
+</pre></div>
+</div>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>loader_opts</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">dict</span></code></a>) &#8211; Dictionaries containing the each dataset loader
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>loader_opts</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">dict</span></code></a>) – Dictionaries containing the each dataset loader
 configuration, representing the keyword arguments of
 the loader function specified by an additional key
-called &#8216;loader_name&#8217;. If not specified by the user,
+called ‘loader_name’. If not specified by the user,
 this defaults to local.</td>
 </tr>
-<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>KeyError</strong> &#8211; If an invalid argument is passed to a data source</td>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>KeyError</strong> – If an invalid argument is passed to a data source
+loader function.</td>
 </tr>
 </tbody>
 </table>
-<p>loader function.</p>
 <dl class="method">
 <dt id="dataset_loader.DatasetLoader.add_loader_opts">
 <code class="descname">add_loader_opts</code><span class="sig-paren">(</span><em>*loader_opts</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_loader.DatasetLoader.add_loader_opts" title="Permalink to this definition">¶</a></dt>
@@ -137,10 +131,10 @@ loader.</p>
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>loader_opts</strong> (<code class="xref py py-mod docutils literal"><span class="pre">dict</span></code>) &#8211; Dictionaries containing the each dataset loader
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>loader_opts</strong> (<code class="xref py py-mod docutils literal"><span class="pre">dict</span></code>) – Dictionaries containing the each dataset loader
 configuration, representing the keyword arguments of
 the loader function specified by an additional key
-called &#8216;loader_name&#8217;. If not specified by the user,
+called ‘loader_name’. If not specified by the user,
 this defaults to local.</td>
 </tr>
 </tbody>
@@ -156,16 +150,15 @@ this defaults to local.</td>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>loader_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) &#8211; The name of the data source.</li>
-<li><strong>loader_func</strong> &#8211; Reference to a custom defined function. This should</li>
+<li><strong>loader_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – The name of the data source.</li>
+<li><strong>loader_func</strong> (<code class="xref py py-class docutils literal"><span class="pre">callable</span></code>) – Reference to a custom defined function. This should
+return an OCW Dataset object, and have an origin which satisfies
+origin[‘source’] == loader_name.</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
-<p>return an OCW Dataset object, and have an origin which satisfies
-origin[&#8216;source&#8217;] == loader_name.
-:type loader_func: <code class="xref py py-class docutils literal"><span class="pre">callable</span></code></p>
 </dd></dl>
 
 <dl class="method">
@@ -182,10 +175,10 @@ origin[&#8216;source&#8217;] == loader_n
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>loader_opts</strong> (<code class="xref py py-mod docutils literal"><span class="pre">dict</span></code>) &#8211; Dictionaries containing the each dataset loader
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>loader_opts</strong> (<code class="xref py py-mod docutils literal"><span class="pre">dict</span></code>) – Dictionaries containing the each dataset loader
 configuration, representing the keyword arguments of
 the loader function specified by an additional key
-called &#8216;loader_name&#8217;. If not specified by the user,
+called ‘loader_name’. If not specified by the user,
 this defaults to local.</td>
 </tr>
 </tbody>
@@ -216,7 +209,7 @@ this defaults to local.</td>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
-      <li><a href="../_sources/ocw/dataset_loader.txt"
+      <li><a href="../_sources/ocw/dataset_loader.rst.txt"
             rel="nofollow">Show Source</a></li>
     </ul>
    </div>
@@ -235,14 +228,14 @@ this defaults to local.</td>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2016, Apache Software Foundation.
+      &copy;2017, Apache Software Foundation.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.4</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
       
       |
-      <a href="../_sources/ocw/dataset_loader.txt"
+      <a href="../_sources/ocw/dataset_loader.rst.txt"
           rel="nofollow">Page source</a>
     </div>
 

Modified: climate/site/trunk/content/api/current/ocw/dataset_processor.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/ocw/dataset_processor.html?rev=1830784&r1=1830783&r2=1830784&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/ocw/dataset_processor.html (original)
+++ climate/site/trunk/content/api/current/ocw/dataset_processor.html Wed May  2 18:41:55 2018
@@ -1,23 +1,21 @@
+
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
-
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    
-    <title>Dataset Processor Module &#8212; Apache Open Climate Workbench 1.2.0 documentation</title>
-    
+    <title>Dataset Processor Module &#8212; Apache Open Climate Workbench 1.3.0 documentation</title>
     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '1.2.0',
+        VERSION:     '1.3.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
       };
     </script>
     <script type="text/javascript" src="../_static/jquery.js"></script>
@@ -25,7 +23,6 @@
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="top" title="Apache Open Climate Workbench 1.2.0 documentation" href="../index.html" />
     <link rel="next" title="Evaluation Module" href="evaluation.html" />
     <link rel="prev" title="Dataset Loader Module" href="dataset_loader.html" />
    
@@ -35,7 +32,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head>
-  <body role="document">
+  <body>
   
 
     <div class="document">
@@ -54,7 +51,7 @@ the input dataset</p>
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The dataset to convert.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The dataset to convert.</td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A Dataset with values converted to new units.</td>
 </tr>
@@ -74,7 +71,7 @@ similar shape, dimensions, and units.</p
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datasets</strong> &#8211; Datasets to be used to compose the ensemble dataset from.
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datasets</strong> – Datasets to be used to compose the ensemble dataset from.
 All Datasets must be the same shape.</td>
 </tr>
 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a></td>
@@ -103,9 +100,9 @@ Force monthly data to the first of the m
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The Dataset which will have its time value normalized.</li>
-<li><strong>timestep</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) &#8211; The timestep of the Dataset&#8217;s values. Either &#8216;daily&#8217; or
-&#8216;monthly&#8217;.</li>
+<li><strong>dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The Dataset which will have its time value normalized.</li>
+<li><strong>timestep</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – The timestep of the Dataset’s values. Either ‘daily’ or
+‘monthly’.</li>
 </ul>
 </td>
 </tr>
@@ -131,9 +128,9 @@ overlap of the subregion and dataset wit
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>subregion</strong> (<a class="reference internal" href="dataset.html#dataset.Bounds" title="dataset.Bounds"><code class="xref py py-class docutils literal"><span class="pre">dataset.Bounds</span></code></a>) &#8211; The Bounds with which to subset the target Dataset.</li>
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The Dataset object to subset.</li>
-<li><strong>subregion_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) &#8211; The subset-ed Dataset name</li>
+<li><strong>subregion</strong> (<a class="reference internal" href="dataset.html#dataset.Bounds" title="dataset.Bounds"><code class="xref py py-class docutils literal"><span class="pre">dataset.Bounds</span></code></a>) – The Bounds with which to subset the target Dataset.</li>
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The Dataset object to subset.</li>
+<li><strong>subregion_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – The subset-ed Dataset name</li>
 </ul>
 </td>
 </tr>
@@ -156,11 +153,11 @@ overlap of the subregion and dataset wit
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; Dataset object that needs spatially regridded</li>
-<li><strong>new_latitudes</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) &#8211; Array of latitudes</li>
-<li><strong>new_longitudes</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) &#8211; Array of longitudes</li>
-<li><strong>boundary_check</strong> (<em>:class:'bool'</em>) &#8211; Check if the regriding domain&#8217;s boundaries
-are outside target_dataset&#8217;s domain</li>
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – Dataset object that needs spatially regridded</li>
+<li><strong>new_latitudes</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.14)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – Array of latitudes</li>
+<li><strong>new_longitudes</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.14)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – Array of longitudes</li>
+<li><strong>boundary_check</strong> (<em>:class:'bool'</em>) – Check if the regriding domain’s boundaries
+are outside target_dataset’s domain</li>
 </ul>
 </td>
 </tr>
@@ -183,11 +180,11 @@ are outside target_dataset&#8217;s domai
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>subregion</strong> (<a class="reference internal" href="dataset.html#dataset.Bounds" title="dataset.Bounds"><code class="xref py py-class docutils literal"><span class="pre">dataset.Bounds</span></code></a>) &#8211; The Bounds with which to subset the target Dataset.</li>
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The Dataset object to subset.</li>
-<li><strong>subregion_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) &#8211; The subset-ed Dataset name</li>
-<li><strong>extract</strong> (<code class="xref py py-mod docutils literal"><span class="pre">boolean</span></code>) &#8211; If False, the dataset inside regions will be masked.</li>
-<li><strong>user_mask_value</strong> (<code class="xref py py-mod docutils literal"><span class="pre">int</span></code>) &#8211; grid points where mask_variable == user_mask_value will be extracted or masked .</li>
+<li><strong>subregion</strong> (<a class="reference internal" href="dataset.html#dataset.Bounds" title="dataset.Bounds"><code class="xref py py-class docutils literal"><span class="pre">dataset.Bounds</span></code></a>) – The Bounds with which to subset the target Dataset.</li>
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The Dataset object to subset.</li>
+<li><strong>subregion_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – The subset-ed Dataset name</li>
+<li><strong>extract</strong> (<code class="xref py py-mod docutils literal"><span class="pre">boolean</span></code>) – If False, the dataset inside regions will be masked.</li>
+<li><strong>user_mask_value</strong> (<code class="xref py py-mod docutils literal"><span class="pre">int</span></code>) – grid points where mask_variable == user_mask_value will be extracted or masked .</li>
 </ul>
 </td>
 </tr>
@@ -212,7 +209,7 @@ are outside target_dataset&#8217;s domai
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dataset</strong> &#8211; The dataset for which units should be updated.     :type dataset; <a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a></td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dataset</strong> – The dataset for which units should be updated.     :type dataset; <a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a></td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The dataset with (potentially) updated units.     :rtype: <a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a></td>
 </tr>
@@ -229,8 +226,8 @@ are outside target_dataset&#8217;s domai
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; Dataset object that needs temporal rebinned</li>
-<li><strong>temporal_resolution</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) &#8211; The new temporal resolution</li>
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – Dataset object that needs temporal rebinned</li>
+<li><strong>temporal_resolution</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – The new temporal resolution</li>
 </ul>
 </td>
 </tr>
@@ -253,8 +250,8 @@ are outside target_dataset&#8217;s domai
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; Dataset object that needs temporal rebinned</li>
-<li><strong>nt_average</strong> &#8211; Time resolution for the output datasets.
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – Dataset object that needs temporal rebinned</li>
+<li><strong>nt_average</strong> (<em>integer</em>) – Time resolution for the output datasets.
 It is the same as the number of time indicies to be averaged.
 length of time dimension in the rebinned dataset) =
 (original time dimension length/nt_average)</li>
@@ -281,9 +278,9 @@ spatially subset the target_Dataset</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>start_time</strong> (<em>:class:'int'</em>) &#8211; start time</li>
-<li><strong>end_time</strong> (<em>:class:'datetime.datetime'</em>) &#8211; end time</li>
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The Dataset object to subset.</li>
+<li><strong>start_time</strong> (<em>:class:'int'</em>) – start time</li>
+<li><strong>end_time</strong> (<em>:class:'datetime.datetime'</em>) – end time</li>
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The Dataset object to subset.</li>
 </ul>
 </td>
 </tr>
@@ -309,10 +306,10 @@ spatially subset the target_Dataset</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>month_start</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) &#8211; An integer for beginning month (Jan=1)</li>
-<li><strong>month_end</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) &#8211; An integer for ending month (Jan=1)</li>
-<li><strong>target_dataset</strong> (<em>Open Climate Workbench Dataset Object</em>) &#8211; Dataset object that needs temporal subsetting</li>
-<li><strong>average_each_year</strong> (<em>:class:'boolean'</em>) &#8211; If True, output dataset is averaged for each year</li>
+<li><strong>month_start</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) – An integer for beginning month (Jan=1)</li>
+<li><strong>month_end</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) – An integer for ending month (Jan=1)</li>
+<li><strong>target_dataset</strong> (<em>Open Climate Workbench Dataset Object</em>) – Dataset object that needs temporal subsetting</li>
+<li><strong>average_each_year</strong> (<em>:class:'boolean'</em>) – If True, output dataset is averaged for each year</li>
 </ul>
 </td>
 </tr>
@@ -337,7 +334,7 @@ For temperature, convert Celcius to Kelv
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The dataset to convert.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The dataset to convert.</td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A Dataset with values converted to new units.</td>
 </tr>
@@ -356,7 +353,7 @@ For temperature, convert Celcius to Kelv
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The dataset to convert.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The dataset to convert.</td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A Dataset with values converted to new units.</td>
 </tr>
@@ -375,8 +372,8 @@ For temperature, convert Celcius to Kelv
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The dataset to write.</li>
-<li><strong>path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) &#8211; The output file path.</li>
+<li><strong>dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The dataset to write.</li>
+<li><strong>path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – The output file path.</li>
 </ul>
 </td>
 </tr>
@@ -406,7 +403,7 @@ For temperature, convert Celcius to Kelv
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
-      <li><a href="../_sources/ocw/dataset_processor.txt"
+      <li><a href="../_sources/ocw/dataset_processor.rst.txt"
             rel="nofollow">Show Source</a></li>
     </ul>
    </div>
@@ -425,14 +422,14 @@ For temperature, convert Celcius to Kelv
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2016, Apache Software Foundation.
+      &copy;2017, Apache Software Foundation.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.4</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
       
       |
-      <a href="../_sources/ocw/dataset_processor.txt"
+      <a href="../_sources/ocw/dataset_processor.rst.txt"
           rel="nofollow">Page source</a>
     </div>
 

Modified: climate/site/trunk/content/api/current/ocw/evaluation.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/ocw/evaluation.html?rev=1830784&r1=1830783&r2=1830784&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/ocw/evaluation.html (original)
+++ climate/site/trunk/content/api/current/ocw/evaluation.html Wed May  2 18:41:55 2018
@@ -1,23 +1,21 @@
+
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
-
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    
-    <title>Evaluation Module &#8212; Apache Open Climate Workbench 1.2.0 documentation</title>
-    
+    <title>Evaluation Module &#8212; Apache Open Climate Workbench 1.3.0 documentation</title>
     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '1.2.0',
+        VERSION:     '1.3.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
       };
     </script>
     <script type="text/javascript" src="../_static/jquery.js"></script>
@@ -25,7 +23,6 @@
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="top" title="Apache Open Climate Workbench 1.2.0 documentation" href="../index.html" />
     <link rel="next" title="Metrics Module" href="metrics.html" />
     <link rel="prev" title="Dataset Processor Module" href="dataset_processor.html" />
    
@@ -35,7 +32,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head>
-  <body role="document">
+  <body>
   
 
     <div class="document">
@@ -70,12 +67,12 @@ Evaluation.</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>reference</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The reference Dataset for the evaluation.</li>
-<li><strong>targets</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">list</span></code></a> of <a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; A list of one or more target datasets for the
+<li><strong>reference</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The reference Dataset for the evaluation.</li>
+<li><strong>targets</strong> (<code class="xref py py-class docutils literal"><span class="pre">list</span></code> of <a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – A list of one or more target datasets for the
 evaluation.</li>
-<li><strong>metrics</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">list</span></code></a> of <a class="reference internal" href="metrics.html#module-metrics" title="metrics"><code class="xref py py-mod docutils literal"><span class="pre">metrics</span></code></a>) &#8211; A list of one or more Metric instances to run
+<li><strong>metrics</strong> (<code class="xref py py-class docutils literal"><span class="pre">list</span></code> of <a class="reference internal" href="metrics.html#module-metrics" title="metrics"><code class="xref py py-mod docutils literal"><span class="pre">metrics</span></code></a>) – A list of one or more Metric instances to run
 in the evaluation.</li>
-<li><strong>subregions</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">list</span></code></a> of <a class="reference internal" href="dataset.html#dataset.Bounds" title="dataset.Bounds"><code class="xref py py-class docutils literal"><span class="pre">dataset.Bounds</span></code></a>) &#8211; (Optional) Subregion information to use in the
+<li><strong>subregions</strong> (<code class="xref py py-class docutils literal"><span class="pre">list</span></code> of <a class="reference internal" href="dataset.html#dataset.Bounds" title="dataset.Bounds"><code class="xref py py-class docutils literal"><span class="pre">dataset.Bounds</span></code></a>) – (Optional) Subregion information to use in the
 evaluation. A subregion is specified with a Bounds object.</li>
 </ul>
 </td>
@@ -95,9 +92,9 @@ Evaluation is run with one or more metri
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The target Dataset to add to the Evaluation.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The target Dataset to add to the Evaluation.</td>
 </tr>
-<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> &#8211; If a dataset to add isn&#8217;t an instance of Dataset.</td>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> – If a dataset to add isn’t an instance of Dataset.</td>
 </tr>
 </tbody>
 </table>
@@ -111,10 +108,10 @@ Evaluation is run with one or more metri
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target_datasets</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">list</span></code></a> of <a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The list of datasets that should be added to
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target_datasets</strong> (<code class="xref py py-class docutils literal"><span class="pre">list</span></code> of <a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The list of datasets that should be added to
 the Evaluation.</td>
 </tr>
-<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> &#8211; If a dataset to add isn&#8217;t an instance of Dataset.</td>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> – If a dataset to add isn’t an instance of Dataset.</td>
 </tr>
 </tbody>
 </table>
@@ -129,9 +126,9 @@ the Evaluation.</td>
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>metric</strong> (<a class="reference internal" href="metrics.html#module-metrics" title="metrics"><code class="xref py py-mod docutils literal"><span class="pre">metrics</span></code></a>) &#8211; The metric instance to add to the Evaluation.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>metric</strong> (<a class="reference internal" href="metrics.html#module-metrics" title="metrics"><code class="xref py py-mod docutils literal"><span class="pre">metrics</span></code></a>) – The metric instance to add to the Evaluation.</td>
 </tr>
-<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> &#8211; If the metric to add isn&#8217;t a class that inherits
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> – If the metric to add isn’t a class that inherits
 from metrics.Metric.</td>
 </tr>
 </tbody>
@@ -147,9 +144,9 @@ from metrics.Metric.</td>
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>metrics</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">list</span></code></a> of <a class="reference internal" href="metrics.html#module-metrics" title="metrics"><code class="xref py py-mod docutils literal"><span class="pre">metrics</span></code></a>) &#8211; The list of metric instances to add to the Evaluation.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>metrics</strong> (<code class="xref py py-class docutils literal"><span class="pre">list</span></code> of <a class="reference internal" href="metrics.html#module-metrics" title="metrics"><code class="xref py py-mod docutils literal"><span class="pre">metrics</span></code></a>) – The list of metric instances to add to the Evaluation.</td>
 </tr>
-<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> &#8211; If a metric to add isn&#8217;t a class that inherits
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> – If a metric to add isn’t a class that inherits
 from metrics.Metric.</td>
 </tr>
 </tbody>
@@ -159,7 +156,7 @@ from metrics.Metric.</td>
 <dl class="attribute">
 <dt id="evaluation.Evaluation.metrics">
 <code class="descname">metrics</code><em class="property"> = None</em><a class="headerlink" href="#evaluation.Evaluation.metrics" title="Permalink to this definition">¶</a></dt>
-<dd><p>The list of &#8220;binary&#8221; metrics (A metric which takes two Datasets)
+<dd><p>The list of “binary” metrics (A metric which takes two Datasets)
 that the Evaluation should use.</p>
 </dd></dl>
 
@@ -168,7 +165,7 @@ that the Evaluation should use.</p>
 <code class="descname">results</code><em class="property"> = None</em><a class="headerlink" href="#evaluation.Evaluation.results" title="Permalink to this definition">¶</a></dt>
 <dd><p>A list containing the results of running regular metric evaluations.
 The shape of results is <code class="docutils literal"><span class="pre">(num_target_datasets,</span> <span class="pre">num_metrics)</span></code> if
-the user doesn&#8217;t specify subregion information. Otherwise the shape
+the user doesn’t specify subregion information. Otherwise the shape
 is <code class="docutils literal"><span class="pre">(num_target_datasets,</span> <span class="pre">num_metrics,</span> <span class="pre">num_subregions)</span></code>.</p>
 </dd></dl>
 
@@ -177,13 +174,13 @@ is <code class="docutils literal"><span
 <code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evaluation.Evaluation.run" title="Permalink to this definition">¶</a></dt>
 <dd><p>Run the evaluation.</p>
 <p>There are two phases to a run of the Evaluation. First, if there are
-any &#8220;binary&#8221; metrics they are run through the evaluation. Binary
+any “binary” metrics they are run through the evaluation. Binary
 metrics are only run if there is a reference dataset and at least one
 target dataset.</p>
 <p>If there is subregion information provided then each dataset is subset
 before being run through the binary metrics.</p>
 <p>..note:: Only the binary metrics are subset with subregion information.</p>
-<p>Next, if there are any &#8220;unary&#8221; metrics they are run. Unary metrics are
+<p>Next, if there are any “unary” metrics they are run. Unary metrics are
 only run if there is at least one target dataset or a reference dataset.</p>
 </dd></dl>
 
@@ -197,7 +194,7 @@ the reference dataset when the evaluatio
 <dl class="attribute">
 <dt id="evaluation.Evaluation.unary_metrics">
 <code class="descname">unary_metrics</code><em class="property"> = None</em><a class="headerlink" href="#evaluation.Evaluation.unary_metrics" title="Permalink to this definition">¶</a></dt>
-<dd><p>The list of &#8220;unary&#8221; metrics (A metric which takes one Dataset) that
+<dd><p>The list of “unary” metrics (A metric which takes one Dataset) that
 the Evaluation should use.</p>
 </dd></dl>
 
@@ -234,7 +231,7 @@ evaluations. The shape of unary_results
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
-      <li><a href="../_sources/ocw/evaluation.txt"
+      <li><a href="../_sources/ocw/evaluation.rst.txt"
             rel="nofollow">Show Source</a></li>
     </ul>
    </div>
@@ -253,14 +250,14 @@ evaluations. The shape of unary_results
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2016, Apache Software Foundation.
+      &copy;2017, Apache Software Foundation.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.4</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
       
       |
-      <a href="../_sources/ocw/evaluation.txt"
+      <a href="../_sources/ocw/evaluation.rst.txt"
           rel="nofollow">Page source</a>
     </div>
 

Modified: climate/site/trunk/content/api/current/ocw/metrics.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/ocw/metrics.html?rev=1830784&r1=1830783&r2=1830784&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/ocw/metrics.html (original)
+++ climate/site/trunk/content/api/current/ocw/metrics.html Wed May  2 18:41:55 2018
@@ -1,23 +1,21 @@
+
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
-
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    
-    <title>Metrics Module &#8212; Apache Open Climate Workbench 1.2.0 documentation</title>
-    
+    <title>Metrics Module &#8212; Apache Open Climate Workbench 1.3.0 documentation</title>
     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '1.2.0',
+        VERSION:     '1.3.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
       };
     </script>
     <script type="text/javascript" src="../_static/jquery.js"></script>
@@ -25,7 +23,6 @@
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="top" title="Apache Open Climate Workbench 1.2.0 documentation" href="../index.html" />
     <link rel="next" title="Plotter Module" href="plotter.html" />
     <link rel="prev" title="Evaluation Module" href="evaluation.html" />
    
@@ -35,7 +32,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head>
-  <body role="document">
+  <body>
   
 
     <div class="document">
@@ -66,8 +63,8 @@
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The reference dataset to use in this metric run.</li>
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The target dataset to evaluate against the
+<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The reference dataset to use in this metric run.</li>
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The target dataset to evaluate against the
 reference dataset in this metric run.</li>
 </ul>
 </td>
@@ -75,7 +72,7 @@ reference dataset in this metric run.</l
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The difference between the reference and target datasets.</p>
 </td>
 </tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a></p>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.14)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a></p>
 </td>
 </tr>
 </tbody>
@@ -97,9 +94,9 @@ reference dataset in this metric run.</l
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The Dataset to use as the reference dataset when
+<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The Dataset to use as the reference dataset when
 running the evaluation.</li>
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The Dataset to use as the target dataset when
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The Dataset to use as the target dataset when
 running the evaluation.</li>
 </ul>
 </td>
@@ -137,8 +134,8 @@ target dataset.</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The reference dataset to use in this metric run.</li>
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The target dataset to evaluate against the
+<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The reference dataset to use in this metric run.</li>
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The target dataset to evaluate against the
 reference dataset in this metric run.</li>
 </ul>
 </td>
@@ -173,9 +170,9 @@ calculated over time and space.</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>reference_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The reference dataset to use in this metric
+<li><strong>reference_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The reference dataset to use in this metric
 run</li>
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The target dataset to evaluate against the
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The target dataset to evaluate against the
 reference dataset in this metric run</li>
 </ul>
 </td>
@@ -206,8 +203,8 @@ reference dataset in this metric run</li
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The reference dataset to use in this metric run.</li>
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The target dataset to evaluate against the
+<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The reference dataset to use in this metric run.</li>
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The target dataset to evaluate against the
 reference dataset in this metric run.</li>
 </ul>
 </td>
@@ -215,7 +212,7 @@ reference dataset in this metric run.</l
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">standard deviation ratio, pattern correlation coefficient</p>
 </td>
 </tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">:float:&#8217;float&#8217;,&#8217;float&#8217;</p>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">:float:’float’,’float’</p>
 </td>
 </tr>
 </tbody>
@@ -241,8 +238,8 @@ reference dataset in this metric run.</l
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The reference dataset to use in this metric run.</li>
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The target dataset to evaluate against the
+<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The reference dataset to use in this metric run.</li>
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The target dataset to evaluate against the
 reference dataset in this metric run.</li>
 </ul>
 </td>
@@ -260,13 +257,13 @@ reference dataset in this metric run.</l
 <dt id="metrics.TemporalCorrelation">
 <em class="property">class </em><code class="descclassname">metrics.</code><code class="descname">TemporalCorrelation</code><a class="headerlink" href="#metrics.TemporalCorrelation" title="Permalink to this definition">¶</a></dt>
 <dd><p>Calculate the temporal correlation coefficients and associated
-confidence levels between two datasets, using Pearson&#8217;s correlation.</p>
+confidence levels between two datasets, using Pearson’s correlation.</p>
 <dl class="method">
 <dt id="metrics.TemporalCorrelation.run">
 <code class="descname">run</code><span class="sig-paren">(</span><em>reference_dataset</em>, <em>target_dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#metrics.TemporalCorrelation.run" title="Permalink to this definition">¶</a></dt>
 <dd><dl class="docutils">
 <dt>Calculate the temporal correlation coefficients and associated</dt>
-<dd>confidence levels between two datasets, using Pearson&#8217;s correlation.</dd>
+<dd>confidence levels between two datasets, using Pearson’s correlation.</dd>
 </dl>
 <div class="admonition note">
 <p class="first admonition-title">Note</p>
@@ -277,9 +274,9 @@ confidence levels between two datasets,
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>reference_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The reference dataset to use in this metric
+<li><strong>reference_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The reference dataset to use in this metric
 run</li>
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The target dataset to evaluate against the
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The target dataset to evaluate against the
 reference dataset in this metric run</li>
 </ul>
 </td>
@@ -312,8 +309,8 @@ coefficients</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The reference dataset to use in this metric run.</li>
-<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The target dataset to evaluate against the
+<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The reference dataset to use in this metric run.</li>
+<li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The target dataset to evaluate against the
 reference dataset in this metric run.</li>
 </ul>
 </td>
@@ -343,7 +340,7 @@ reference dataset in this metric run.</l
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The target_dataset on which to calculate the 
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The target_dataset on which to calculate the 
 temporal standard deviation.</td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The temporal standard deviation of the target dataset</td>
@@ -368,7 +365,7 @@ temporal standard deviation.</td>
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) &#8211; The dataset on which the current metric will
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The dataset on which the current metric will
 be run.</td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The result of evaluating the metric on the target_dataset.</td>
@@ -388,16 +385,16 @@ be run.</td>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>target_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) &#8211; an array to be evaluated, as model output</li>
-<li><strong>reference_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) &#8211; an array of reference dataset</li>
-<li><strong>average_over_time</strong> (<em>'bool'</em>) &#8211; if True, calculated bias is averaged for the axis=0</li>
+<li><strong>target_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) – an array to be evaluated, as model output</li>
+<li><strong>reference_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) – an array of reference dataset</li>
+<li><strong>average_over_time</strong> (<em>'bool'</em>) – if True, calculated bias is averaged for the axis=0</li>
 </ul>
 </td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Biases array of the target dataset</p>
 </td>
 </tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">:class:&#8217;numpy.ma.core.MaskedArray&#8217;</p>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">:class:’numpy.ma.core.MaskedArray’</p>
 </td>
 </tr>
 </tbody>
@@ -413,15 +410,15 @@ be run.</td>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>target_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) &#8211; an array to be evaluated, as model output</li>
-<li><strong>reference_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) &#8211; an array of reference dataset</li>
+<li><strong>target_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) – an array to be evaluated, as model output</li>
+<li><strong>reference_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) – an array of reference dataset</li>
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">pearson&#8217;s correlation coefficient between the two input arrays</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">pearson’s correlation coefficient between the two input arrays</p>
 </td>
 </tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">:class:&#8217;numpy.ma.core.MaskedArray&#8217;</p>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">:class:’numpy.ma.core.MaskedArray’</p>
 </td>
 </tr>
 </tbody>
@@ -433,9 +430,9 @@ be run.</td>
 <code class="descclassname">metrics.</code><code class="descname">calc_histogram_overlap</code><span class="sig-paren">(</span><em>hist1</em>, <em>hist2</em><span class="sig-paren">)</span><a class="headerlink" href="#metrics.calc_histogram_overlap" title="Permalink to this definition">¶</a></dt>
 <dd><p>from Lee et al. (2014)
 :param hist1: a histogram array
-:type hist1: :class:&#8217;numpy.ndarray&#8217;
+:type hist1: :class:’numpy.ndarray’
 :param hist2: a histogram array with the same size as hist1
-:type hist2: :class:&#8217;numpy.ndarray&#8217;</p>
+:type hist2: :class:’numpy.ndarray’</p>
 </dd></dl>
 
 <dl class="function">
@@ -443,13 +440,13 @@ be run.</td>
 <code class="descclassname">metrics.</code><code class="descname">calc_joint_histogram</code><span class="sig-paren">(</span><em>data_array1</em>, <em>data_array2</em>, <em>bins_for_data1</em>, <em>bins_for_data2</em><span class="sig-paren">)</span><a class="headerlink" href="#metrics.calc_joint_histogram" title="Permalink to this definition">¶</a></dt>
 <dd><p>Calculate a joint histogram of two variables in data_array1 and data_array2
 :param data_array1: the first variable
-:type data_array1: :class:&#8217;numpy.ma.core.MaskedArray&#8217;
+:type data_array1: :class:’numpy.ma.core.MaskedArray’
 :param data_array2: the second variable
-:type data_array2: :class:&#8217;numpy.ma.core.MaskedArray&#8217;
+:type data_array2: :class:’numpy.ma.core.MaskedArray’
 :param bins_for_data1: histogram bin edges for data_array1
-:type bins_for_data1: :class:&#8217;numpy.ndarray&#8217;
+:type bins_for_data1: :class:’numpy.ndarray’
 :param bins_for_data2: histogram bin edges for data_array2
-:type bins_for_data2: :class:&#8217;numpy.ndarray&#8217;</p>
+:type bins_for_data2: :class:’numpy.ndarray’</p>
 </dd></dl>
 
 <dl class="function">
@@ -461,16 +458,16 @@ be run.</td>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>target_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) &#8211; an array to be evaluated, as model output</li>
-<li><strong>reference_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) &#8211; an array of reference dataset</li>
-<li><strong>average_over_time</strong> (<em>'bool'</em>) &#8211; if True, calculated bias is averaged for the axis=0</li>
+<li><strong>target_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) – an array to be evaluated, as model output</li>
+<li><strong>reference_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) – an array of reference dataset</li>
+<li><strong>average_over_time</strong> (<em>'bool'</em>) – if True, calculated bias is averaged for the axis=0</li>
 </ul>
 </td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">root mean square error</p>
 </td>
 </tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">:class:&#8217;float&#8217;</p>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">:class:’float’</p>
 </td>
 </tr>
 </tbody>
@@ -486,15 +483,15 @@ be run.</td>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) &#8211; an array to calculate sample standard deviation</li>
-<li><strong>axis</strong> (<em>'int'</em>) &#8211; Axis along which the sample standard deviation is computed.</li>
+<li><strong>array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) – an array to calculate sample standard deviation</li>
+<li><strong>axis</strong> (<em>'int'</em>) – Axis along which the sample standard deviation is computed.</li>
 </ul>
 </td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">sample standard deviation of array</p>
 </td>
 </tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">:class:&#8217;numpy.ma.core.MaskedArray&#8217;</p>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">:class:’numpy.ma.core.MaskedArray’</p>
 </td>
 </tr>
 </tbody>
@@ -510,16 +507,16 @@ be run.</td>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>target_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) &#8211; an array to be evaluated, as model output</li>
-<li><strong>reference_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) &#8211; an array of reference dataset</li>
-<li><strong>average_over_time</strong> (<em>'bool'</em>) &#8211; if True, calculated bias is averaged for the axis=0</li>
+<li><strong>target_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) – an array to be evaluated, as model output</li>
+<li><strong>reference_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) – an array of reference dataset</li>
+<li><strong>average_over_time</strong> (<em>'bool'</em>) – if True, calculated bias is averaged for the axis=0</li>
 </ul>
 </td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">(standard deviation of target_array)/(standard deviation of reference array)</p>
 </td>
 </tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">:class:&#8217;float&#8217;</p>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">:class:’float’</p>
 </td>
 </tr>
 </tbody>
@@ -535,10 +532,10 @@ be run.</td>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>reference_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) &#8211; an array to be analyzed</li>
-<li><strong>threshold</strong> (<em>'float'</em>) &#8211; the minimum amount of rainfall [mm/hour]</li>
-<li><strong>nyear</strong> (<em>'int'</em>) &#8211; the number of discontinous periods</li>
-<li><strong>dt</strong> (<em>'float'</em>) &#8211; the temporal resolution of reference_array</li>
+<li><strong>reference_array</strong> (<em>:class:'numpy.ma.core.MaskedArray'</em>) – an array to be analyzed</li>
+<li><strong>threshold</strong> (<em>'float'</em>) – the minimum amount of rainfall [mm/hour]</li>
+<li><strong>nyear</strong> (<em>'int'</em>) – the number of discontinous periods</li>
+<li><strong>dt</strong> (<em>'float'</em>) – the temporal resolution of reference_array</li>
 </ul>
 </td>
 </tr>
@@ -568,7 +565,7 @@ be run.</td>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
-      <li><a href="../_sources/ocw/metrics.txt"
+      <li><a href="../_sources/ocw/metrics.rst.txt"
             rel="nofollow">Show Source</a></li>
     </ul>
    </div>
@@ -587,14 +584,14 @@ be run.</td>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2016, Apache Software Foundation.
+      &copy;2017, Apache Software Foundation.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.4</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
       
       |
-      <a href="../_sources/ocw/metrics.txt"
+      <a href="../_sources/ocw/metrics.rst.txt"
           rel="nofollow">Page source</a>
     </div>
 



Mime
View raw message