You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@climate.apache.org by le...@apache.org on 2016/07/27 17:45:28 UTC
svn commit: r1754320 [9/10] - in /climate/site/trunk/content/api: ./ 1.0.0/
1.0.0/_sources/ 1.0.0/_static/ 1.0.0/config/ 1.0.0/data_source/ 1.0.0/ocw/
1.0.0/ui-backend/ 1.1.0/ 1.1.0/_sources/ 1.1.0/_sources/config/
1.1.0/_sources/data_source/ 1.1.0/_so...
Added: climate/site/trunk/content/api/1.1.0/ocw/plotter.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/1.1.0/ocw/plotter.html?rev=1754320&view=auto
==============================================================================
--- climate/site/trunk/content/api/1.1.0/ocw/plotter.html (added)
+++ climate/site/trunk/content/api/1.1.0/ocw/plotter.html Wed Jul 27 17:45:26 2016
@@ -0,0 +1,415 @@
+<!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>Plotter Module — Apache Open Climate Workbench 1.1.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.1.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="../index.html" />
+ <link rel="next" title="Utils Module" href="utils.html" />
+ <link rel="prev" title="Metrics Module" href="metrics.html" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+
+ </head>
+ <body role="document">
+ <div class="related" role="navigation" aria-label="related navigation">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="utils.html" title="Utils Module"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="metrics.html" title="Metrics Module"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="../index.html">Apache Open Climate Workbench 1.1.0 documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="module-plotter">
+<span id="plotter-module"></span><h1>Plotter Module<a class="headerlink" href="#module-plotter" title="Permalink to this headline">¶</a></h1>
+<dl class="class">
+<dt id="plotter.TaylorDiagram">
+<em class="property">class </em><code class="descclassname">plotter.</code><code class="descname">TaylorDiagram</code><span class="sig-paren">(</span><em>refstd</em>, <em>radmax=1.5</em>, <em>fig=None</em>, <em>rect=111</em>, <em>label='_'</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.TaylorDiagram" title="Permalink to this definition">¶</a></dt>
+<dd><p>Taylor diagram helper class</p>
+<p>Plot model standard deviation and correlation to reference (data)
+sample in a single-quadrant polar plot, with r=stddev and
+theta=arccos(correlation).</p>
+<p>This class was released as public domain by the original author
+Yannick Copin. You can find the original Gist where it was
+released at: <a class="reference external" href="https://gist.github.com/ycopin/3342888">https://gist.github.com/ycopin/3342888</a></p>
+<p>Set up Taylor diagram axes, i.e. single quadrant polar
+plot, using mpl_toolkits.axisartist.floating_axes. refstd is
+the reference standard deviation to be compared to.</p>
+<dl class="method">
+<dt id="plotter.TaylorDiagram.add_contours">
+<code class="descname">add_contours</code><span class="sig-paren">(</span><em>std1</em>, <em>corr1</em>, <em>std2</em>, <em>corr2</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.TaylorDiagram.add_contours" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add a line between two points
+[std1, corr1] and [std2, corr2]</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="plotter.TaylorDiagram.add_rms_contours">
+<code class="descname">add_rms_contours</code><span class="sig-paren">(</span><em>levels=5</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.TaylorDiagram.add_rms_contours" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add constant centered RMS difference contours.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="plotter.TaylorDiagram.add_sample">
+<code class="descname">add_sample</code><span class="sig-paren">(</span><em>stddev</em>, <em>corrcoef</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.TaylorDiagram.add_sample" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add sample (stddev,corrcoeff) to the Taylor diagram. args
+and kwargs are directly propagated to the Figure.plot
+command.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="plotter.TaylorDiagram.add_stddev_contours">
+<code class="descname">add_stddev_contours</code><span class="sig-paren">(</span><em>std</em>, <em>corr1</em>, <em>corr2</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.TaylorDiagram.add_stddev_contours" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add a curved line with a radius of std between two points
+[std, corr1] and [std, corr2]</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.draw_barchart">
+<code class="descclassname">plotter.</code><code class="descname">draw_barchart</code><span class="sig-paren">(</span><em>results</em>, <em>yvalues</em>, <em>fname</em>, <em>ptitle=''</em>, <em>fmt='png'</em>, <em>xlabel=''</em>, <em>ylabel=''</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.draw_barchart" title="Permalink to this definition">¶</a></dt>
+<dd><p>Draw a barchart.</p>
+<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"><ul class="first last simple">
+<li><strong>results</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – 1D array of data.</li>
+<li><strong>yvalues</strong> – List of y-axis labels</li>
+<li><strong>fname</strong> (<a class="reference external" href="http://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>) – Filename of the plot.</li>
+<li><strong>ptitle</strong> (<a class="reference external" href="http://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>) – (Optional) plot title.</li>
+<li><strong>fmt</strong> (<a class="reference external" href="http://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>) – (Optional) filetype for the output.</li>
+<li><strong>xlabel</strong> (<a class="reference external" href="http://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>) – (Optional) x-axis title.</li>
+<li><strong>ylabel</strong> (<a class="reference external" href="http://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>) – (Optional) y-axis title.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.draw_contour_map">
+<code class="descclassname">plotter.</code><code class="descname">draw_contour_map</code><span class="sig-paren">(</span><em>dataset</em>, <em>lats</em>, <em>lons</em>, <em>fname</em>, <em>fmt='png'</em>, <em>gridshape=(1</em>, <em>1)</em>, <em>clabel=''</em>, <em>ptitle=''</em>, <em>subtitles=None</em>, <em>cmap=None</em>, <em>clevs=None</em>, <em>nlevs=10</em>, <em>parallels=None</em>, <em>meridians=None</em>, <em>extend='neither'</em>, <em>aspect=3.4</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.draw_contour_map" title="Permalink to this definition">¶</a></dt>
+<dd><p>Draw a multiple panel contour map plot.</p>
+<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"><ul class="first last simple">
+<li><strong>dataset</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – 3D array of data to be plotted with shape (nT, nLat, nLon).</li>
+<li><strong>lats</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – Array of latitudes values.</li>
+<li><strong>lons</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – Array of longitudes</li>
+<li><strong>fname</strong> (<a class="reference external" href="http://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 filename of the plot.</li>
+<li><strong>fmt</strong> (<a class="reference external" href="http://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>) – (Optional) filetype for the output.</li>
+<li><strong>gridshape</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><code class="xref py py-func docutils literal"><span class="pre">tuple()</span></code></a> of the form (num_rows, num_cols)) – (Optional) tuple denoting the desired grid shape
+(num_rows, num_cols) for arranging the subplots.</li>
+<li><strong>clabel</strong> (<a class="reference external" href="http://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>) – (Optional) colorbar title.</li>
+<li><strong>ptitle</strong> (<a class="reference external" href="http://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>) – (Optional) plot title.</li>
+<li><strong>subtitles</strong> (<a class="reference external" href="http://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 external" href="http://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>) – (Optional) list of titles for each subplot.</li>
+<li><strong>cmap</strong> (<a class="reference external" href="http://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> or <a class="reference external" href="http://matplotlib.sourceforge.net/api/colors_api.html#matplotlib.colors.LinearSegmentedColormap" title="(in Matplotlib v1.5.1)"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.colors.LinearSegmentedColormap</span></code></a>) – (Optional) string or <a class="reference external" href="http://matplotlib.sourceforge.net/api/colors_api.html#matplotlib.colors.LinearSegmentedColormap" title="(in Matplotlib v1.5.1)"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.colors.LinearSegmentedColormap</span></code></a>
+instance denoting the colormap. This must be able to be recognized by
+<a class="reference external" href="http://matplotlib.org/api/cm_api.html#matplotlib.cm.get_cmap">Matplotlib’s get_cmap function</a>.</li>
+<li><strong>clevs</strong> (<a class="reference external" href="http://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 external" href="http://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> or <a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – (Optional) contour levels values.</li>
+<li><strong>nlevs</strong> (<a class="reference external" href="http://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>) – (Optional) target number of contour levels if clevs is None.</li>
+<li><strong>parallels</strong> (<a class="reference external" href="http://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 external" href="http://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> or <a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – (Optional) list of ints or floats for the parallels to
+be drawn. See the <a class="reference external" href="http://matplotlib.org/basemap/users/graticule.html">Basemap documentation</a>
+for additional information.</li>
+<li><strong>meridians</strong> (<a class="reference external" href="http://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 external" href="http://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> or <a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – <p>(Optional) list of ints or floats for the meridians to
+be drawn. See the <a class="reference external" href="http://matplotlib.org/basemap/users/graticule.html">Basemap documentation</a>
+for additional information.</p>
+</li>
+<li><strong>extend</strong> (<a class="reference external" href="http://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>) – (Optional) flag to toggle whether to place arrows at the colorbar
+boundaries. Default is ‘neither’, but can also be ‘min’, ‘max’, or
+‘both’. Will be automatically set to ‘both’ if clevs is None.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.draw_histogram">
+<code class="descclassname">plotter.</code><code class="descname">draw_histogram</code><span class="sig-paren">(</span><em>dataset_array</em>, <em>data_names</em>, <em>fname</em>, <em>fmt='png'</em>, <em>nbins=10</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.draw_histogram" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Purpose::</dt>
+<dd>Draw histograms</dd>
+<dt>Input::</dt>
+<dd>dataset_array - a list of data values [data1, data2, ....]
+data_names - a list of data names [‘name1’,’name2’,....]
+fname - a string specifying the filename of the plot
+bins - number of bins</dd>
+</dl>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.draw_marker_on_map">
+<code class="descclassname">plotter.</code><code class="descname">draw_marker_on_map</code><span class="sig-paren">(</span><em>lat</em>, <em>lon</em>, <em>fname</em>, <em>fmt='png'</em>, <em>location_name=' '</em>, <em>gridshape=(1</em>, <em>1)</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.draw_marker_on_map" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Purpose::</dt>
+<dd>Draw a marker on a map</dd>
+<dt>Input::</dt>
+<dd>lat - latitude for plotting a marker
+lon - longitude for plotting a marker
+fname - a string specifying the filename of the plot</dd>
+</dl>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.draw_portrait_diagram">
+<code class="descclassname">plotter.</code><code class="descname">draw_portrait_diagram</code><span class="sig-paren">(</span><em>results</em>, <em>rowlabels</em>, <em>collabels</em>, <em>fname</em>, <em>fmt='png'</em>, <em>gridshape=(1</em>, <em>1)</em>, <em>xlabel=''</em>, <em>ylabel=''</em>, <em>clabel=''</em>, <em>ptitle=''</em>, <em>subtitles=None</em>, <em>cmap=None</em>, <em>clevs=None</em>, <em>nlevs=10</em>, <em>extend='neither'</em>, <em>aspect=None</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.draw_portrait_diagram" title="Permalink to this definition">¶</a></dt>
+<dd><p>Draw a portrait diagram plot.</p>
+<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"><ul class="first last simple">
+<li><strong>results</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – 3D array of the fields to be plotted. The second dimension
+should correspond to the number of rows in the diagram and the
+third should correspond to the number of columns.</li>
+<li><strong>rowlabels</strong> (<a class="reference external" href="http://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 external" href="http://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>) – Labels for each row.</li>
+<li><strong>collabels</strong> (<a class="reference external" href="http://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 external" href="http://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>) – Labels for each row.</li>
+<li><strong>fname</strong> (<a class="reference external" href="http://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>) – Filename of the plot.</li>
+<li><strong>fmt</strong> (<a class="reference external" href="http://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>) – (Optional) filetype for the output.</li>
+<li><strong>gridshape</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><code class="xref py py-func docutils literal"><span class="pre">tuple()</span></code></a> of the form (num_rows, num_cols)) – (Optional) tuple denoting the desired grid shape
+(num_rows, num_cols) for arranging the subplots.</li>
+<li><strong>xlabel</strong> (<a class="reference external" href="http://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>) – (Optional) x-axis title.</li>
+<li><strong>ylabel</strong> (<a class="reference external" href="http://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>) – (Optional) y-ayis title.</li>
+<li><strong>clabel</strong> (<a class="reference external" href="http://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>) – (Optional) colorbar title.</li>
+<li><strong>ptitle</strong> (<a class="reference external" href="http://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>) – (Optional) plot title.</li>
+<li><strong>subtitles</strong> (<a class="reference external" href="http://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 external" href="http://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>) – (Optional) list of titles for each subplot.</li>
+<li><strong>cmap</strong> (<a class="reference external" href="http://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> or <a class="reference external" href="http://matplotlib.sourceforge.net/api/colors_api.html#matplotlib.colors.LinearSegmentedColormap" title="(in Matplotlib v1.5.1)"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.colors.LinearSegmentedColormap</span></code></a>) – <p>(Optional) string or <a class="reference external" href="http://matplotlib.sourceforge.net/api/colors_api.html#matplotlib.colors.LinearSegmentedColormap" title="(in Matplotlib v1.5.1)"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.colors.LinearSegmentedColormap</span></code></a>
+instance denoting the colormap. This must be able to be recognized by
+<a class="reference external" href="http://matplotlib.org/api/cm_api.html#matplotlib.cm.get_cmap">Matplotlib’s get_cmap function</a>.</p>
+</li>
+<li><strong>clevs</strong> (<a class="reference external" href="http://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 external" href="http://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> or <a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – (Optional) contour levels values.</li>
+<li><strong>nlevs</strong> (<a class="reference external" href="http://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>) – Optional target number of contour levels if clevs is None.</li>
+<li><strong>extend</strong> (<a class="reference external" href="http://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>) – (Optional) flag to toggle whether to place arrows at the colorbar
+boundaries. Default is ‘neither’, but can also be ‘min’, ‘max’, or
+‘both’. Will be automatically set to ‘both’ if clevs is None.</li>
+<li><strong>aspect</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – (Optional) approximate aspect ratio of each subplot
+(width / height). Default is 8.5 / 5.5</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.draw_subregions">
+<code class="descclassname">plotter.</code><code class="descname">draw_subregions</code><span class="sig-paren">(</span><em>subregions</em>, <em>lats</em>, <em>lons</em>, <em>fname</em>, <em>fmt='png'</em>, <em>ptitle=''</em>, <em>parallels=None</em>, <em>meridians=None</em>, <em>subregion_masks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.draw_subregions" title="Permalink to this definition">¶</a></dt>
+<dd><p>Draw subregion domain(s) on a map.</p>
+<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"><ul class="first last simple">
+<li><strong>subregions</strong> (<a class="reference external" href="http://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 subregion objects (Bounds objects)) – The subregion objects to plot on the map.</li>
+<li><strong>lats</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – Array of latitudes values.</li>
+<li><strong>lons</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – Array of longitudes values.</li>
+<li><strong>fname</strong> (<a class="reference external" href="http://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 filename of the plot.</li>
+<li><strong>fmt</strong> (<a class="reference external" href="http://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>) – (Optional) filetype for the output.</li>
+<li><strong>ptitle</strong> (<a class="reference external" href="http://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>) – (Optional) plot title.</li>
+<li><strong>parallels</strong> (<a class="reference external" href="http://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 external" href="http://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> or <a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – <p>(Optional) <a class="reference external" href="http://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 external" href="http://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><co
de class="xref py py-class docutils literal"><span class="pre">int</span></code></a> or <a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a> for the parallels to
+be drawn. See the <a class="reference external" href="http://matplotlib.org/basemap/users/graticule.html">Basemap documentation</a>
+for additional information.</p>
+</li>
+<li><strong>meridians</strong> (<a class="reference external" href="http://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 external" href="http://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> or <a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – <p>(Optional) <a class="reference external" href="http://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 external" href="http://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><co
de class="xref py py-class docutils literal"><span class="pre">int</span></code></a> or <a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a> for the meridians to
+be drawn. See the <a class="reference external" href="http://matplotlib.org/basemap/users/graticule.html">Basemap documentation</a>
+for additional information.</p>
+</li>
+<li><strong>subregion_masks</strong> (<a class="reference external" href="http://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> of <a class="reference external" href="http://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">bool</span></code></a> arrays) – (Optional) <a class="reference external" href="http://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> of <a class="reference external" href="http://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">bool</span></code></a> arrays for each
+subregion for giving finer control of the domain to be drawn, by default
+the entire domain is drawn.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.draw_taylor_diagram">
+<code class="descclassname">plotter.</code><code class="descname">draw_taylor_diagram</code><span class="sig-paren">(</span><em>results</em>, <em>names</em>, <em>refname</em>, <em>fname</em>, <em>fmt='png'</em>, <em>gridshape=(1</em>, <em>1)</em>, <em>ptitle=''</em>, <em>subtitles=None</em>, <em>pos='upper right'</em>, <em>frameon=True</em>, <em>radmax=1.5</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.draw_taylor_diagram" title="Permalink to this definition">¶</a></dt>
+<dd><p>Draw a Taylor diagram.</p>
+<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"><ul class="first last simple">
+<li><strong>results</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – An Nx2 array containing normalized standard deviations,
+correlation coefficients, and names of evaluation results.</li>
+<li><strong>names</strong> (<a class="reference external" href="http://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 external" href="http://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>) – A list of names for each evaluated dataset</li>
+<li><strong>refname</strong> (<a class="reference external" href="http://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 reference dataset.</li>
+<li><strong>fname</strong> (<a class="reference external" href="http://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 filename of the plot.</li>
+<li><strong>fmt</strong> (<a class="reference external" href="http://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>) – (Optional) filetype for the output plot.</li>
+<li><strong>gridshape</strong> (A <code class="xref py py-class docutils literal"><span class="pre">tuple</span></code> of the form (num_rows, num_cols)) – (Optional) Tuple denoting the desired grid shape
+(num_rows, num_cols) for arranging the subplots.</li>
+<li><strong>ptitle</strong> (<a class="reference external" href="http://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>) – (Optional) plot title.</li>
+<li><strong>subtitles</strong> (<a class="reference external" href="http://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 external" href="http://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>) – (Optional) list of strings specifying the title for each
+subplot.</li>
+<li><strong>pos</strong> (<a class="reference external" href="http://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> or <a class="reference external" href="http://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><code class="xref py py-func docutils literal"><span class="pre">tuple()</span></code></a> of <a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – (Optional) string or tuple of floats used to set the position
+of the legend. Check the <a class="reference external" href="http://matplotlib.org/api/legend_api.html#matplotlib.legend.Legend">Matplotlib docs</a>
+for additional information.</li>
+<li><strong>frameon</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">bool</span></code></a>) – (Optional) boolean specifying whether to draw a frame
+around the legend box.</li>
+<li><strong>radmax</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – (Optional) float to adjust the extent of the axes in terms of
+standard deviation.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.draw_time_series">
+<code class="descclassname">plotter.</code><code class="descname">draw_time_series</code><span class="sig-paren">(</span><em>results</em>, <em>times</em>, <em>labels</em>, <em>fname</em>, <em>fmt='png'</em>, <em>gridshape=(1</em>, <em>1)</em>, <em>xlabel=''</em>, <em>ylabel=''</em>, <em>ptitle=''</em>, <em>subtitles=None</em>, <em>label_month=False</em>, <em>yscale='linear'</em>, <em>aspect=None</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.draw_time_series" title="Permalink to this definition">¶</a></dt>
+<dd><p>Draw a time series plot.</p>
+<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"><ul class="first last simple">
+<li><strong>results</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – 3D array of time series data.</li>
+<li><strong>times</strong> (<a class="reference external" href="http://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 external" href="http://docs.python.org/2/library/datetime.html#datetime.datetime" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></a>) – List of Python datetime objects used by Matplotlib to handle
+axis formatting.</li>
+<li><strong>labels</strong> (<a class="reference external" href="http://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 external" href="http://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>) – List of names for each data being plotted.</li>
+<li><strong>fname</strong> (<a class="reference external" href="http://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>) – Filename of the plot.</li>
+<li><strong>fmt</strong> (<a class="reference external" href="http://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>) – (Optional) filetype for the output.</li>
+<li><strong>gridshape</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><code class="xref py py-func docutils literal"><span class="pre">tuple()</span></code></a> of the form (num_rows, num_cols)) – (Optional) tuple denoting the desired grid shape
+(num_rows, num_cols) for arranging the subplots.</li>
+<li><strong>xlabel</strong> (<a class="reference external" href="http://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>) – (Optional) x-axis title.</li>
+<li><strong>ylabel</strong> (<a class="reference external" href="http://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>) – (Optional) y-axis title.</li>
+<li><strong>ptitle</strong> (<a class="reference external" href="http://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>) – (Optional) plot title.</li>
+<li><strong>subtitles</strong> (<a class="reference external" href="http://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 external" href="http://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>) – (Optional) list of titles for each subplot.</li>
+<li><strong>label_month</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">bool</span></code></a>) – (Optional) flag to toggle drawing month labels on the
+x-axis.</li>
+<li><strong>yscale</strong> (<a class="reference external" href="http://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>) – (Optional) y-axis scale value, ‘linear’ for linear and ‘log’
+for log base 10.</li>
+<li><strong>aspect</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – (Optional) approximate aspect ratio of each subplot
+(width / height). Default is 8.5 / 5.5</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.set_cmap">
+<code class="descclassname">plotter.</code><code class="descname">set_cmap</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#plotter.set_cmap" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the default colormap (eg when setting cmap=None in a function)
+See: <a class="reference external" href="http://matplotlib.org/examples/pylab_examples/show_colormaps.html">http://matplotlib.org/examples/pylab_examples/show_colormaps.html</a>
+for a list of possible colormaps.
+Appending ‘_r’ to a matplotlib colormap name will give you a reversed
+version of it.</p>
+<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>name</strong> (<a class="reference external" href="http://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 colormap.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/>
+ </a></p>
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="metrics.html"
+ title="previous chapter">Metrics Module</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="utils.html"
+ title="next chapter">Utils Module</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/ocw/plotter.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+ </div>
+<div id="searchbox" style="display: none" role="search">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2016, Apache Software Foundation.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.4</a>
+
+ |
+ <a href="../_sources/ocw/plotter.txt"
+ rel="nofollow">Page source</a></li>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
Added: climate/site/trunk/content/api/1.1.0/ocw/utils.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/1.1.0/ocw/utils.html?rev=1754320&view=auto
==============================================================================
--- climate/site/trunk/content/api/1.1.0/ocw/utils.html (added)
+++ climate/site/trunk/content/api/1.1.0/ocw/utils.html Wed Jul 27 17:45:26 2016
@@ -0,0 +1,407 @@
+<!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>Utils Module — Apache Open Climate Workbench 1.1.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.1.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="../index.html" />
+ <link rel="next" title="Data Sources" href="../data_source/data_sources.html" />
+ <link rel="prev" title="Plotter Module" href="plotter.html" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+
+ </head>
+ <body role="document">
+ <div class="related" role="navigation" aria-label="related navigation">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="../data_source/data_sources.html" title="Data Sources"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="plotter.html" title="Plotter Module"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="../index.html">Apache Open Climate Workbench 1.1.0 documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="module-utils">
+<span id="utils-module"></span><h1>Utils Module<a class="headerlink" href="#module-utils" title="Permalink to this headline">¶</a></h1>
+<dl class="function">
+<dt id="utils.calc_area_weighted_spatial_average">
+<code class="descclassname">utils.</code><code class="descname">calc_area_weighted_spatial_average</code><span class="sig-paren">(</span><em>dataset</em>, <em>area_weight=False</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.calc_area_weighted_spatial_average" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate area weighted average of the values in OCW dataset</p>
+<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>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</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">time series for the dataset of shape (nT)</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="utils.calc_climatology_monthly">
+<code class="descclassname">utils.</code><code class="descname">calc_climatology_monthly</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.calc_climatology_monthly" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate monthly mean values for a dataset.
+Follow COARDS climo stats calculation, the year can be given as 0
+but the min year allowed in Python is 1
+<a class="reference external" href="http://www.cgd.ucar.edu/cms/eaton/netcdf/CF-20010629.htm#climatology">http://www.cgd.ucar.edu/cms/eaton/netcdf/CF-20010629.htm#climatology</a></p>
+<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>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>) – Monthly binned Dataset object with the number of months
+divisible by 12</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Mean values for each month of the year of shape
+(12, num_lats, num_lons) and times array of datetime objects
+of length 12</td>
+</tr>
+<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
+<tr class="field-odd field"><td> </td><td class="field-body">If the number of monthly bins is not divisible by 12</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="utils.calc_climatology_year">
+<code class="descclassname">utils.</code><code class="descname">calc_climatology_year</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.calc_climatology_year" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate climatology of dataset’s values for each year</p>
+<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>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>) – Monthly binned Dataset object with an evenly divisible
+number of months.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Mean values for each year (annual_mean) and mean values for all
+years (total_mean)</td>
+</tr>
+<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
+<tr class="field-odd field"><td> </td><td class="field-body">If the number of monthly bins is not evenly divisible
+by 12.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="utils.calc_subregion_area_mean_and_std">
+<code class="descclassname">utils.</code><code class="descname">calc_subregion_area_mean_and_std</code><span class="sig-paren">(</span><em>dataset_array</em>, <em>subregions</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.calc_subregion_area_mean_and_std" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Calculate area mean and standard deviation values for a given</dt>
+<dd>subregions using datasets on common grid points</dd>
+</dl>
+<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"><ul class="first simple">
+<li><strong>dataset_array</strong> – An array of OCW Dataset Objects</li>
+<li><strong>subregions</strong> (<code class="xref py py-class docutils literal"><span class="pre">numpy.ma.array</span></code>) – list of subregions</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">area averaged time series for the dataset of shape
+(ntime, nsubregion)</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="utils.calc_temporal_mean">
+<code class="descclassname">utils.</code><code class="descname">calc_temporal_mean</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.calc_temporal_mean" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate temporal mean of dataset’s values</p>
+<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>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>) – OCW Dataset whose first dimension is time</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Mean values averaged for the first dimension (time)</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="utils.calc_time_series">
+<code class="descclassname">utils.</code><code class="descname">calc_time_series</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.calc_time_series" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate time series mean values for a dataset</p>
+<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>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</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">time series for the dataset of shape (nT)</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="utils.decode_time_values">
+<code class="descclassname">utils.</code><code class="descname">decode_time_values</code><span class="sig-paren">(</span><em>dataset</em>, <em>time_var_name</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.decode_time_values" title="Permalink to this definition">¶</a></dt>
+<dd><p>Decode NetCDF time values into Python datetime objects.</p>
+<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"><ul class="first simple">
+<li><strong>dataset</strong> (<em>netCDF4.Dataset</em>) – The dataset from which time values should be extracted.</li>
+<li><strong>time_var_name</strong> (<a class="reference external" href="http://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 time variable in dataset.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The list of converted datetime values.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
+<tr class="field-odd field"><td> </td><td class="field-body"><p class="first last">If the time units value couldn’t be parsed, if the
+base time value couldn’t be parsed, or if the time_var_name could not
+be found in the dataset.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="utils.get_temporal_overlap">
+<code class="descclassname">utils.</code><code class="descname">get_temporal_overlap</code><span class="sig-paren">(</span><em>dataset_array</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.get_temporal_overlap" title="Permalink to this definition">¶</a></dt>
+<dd><p>Find the maximum temporal overlap across the observation and model datasets</p>
+<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>dataset_array</strong> – an array of OCW datasets</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="utils.normalize_lat_lon_values">
+<code class="descclassname">utils.</code><code class="descname">normalize_lat_lon_values</code><span class="sig-paren">(</span><em>lats</em>, <em>lons</em>, <em>values</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.normalize_lat_lon_values" title="Permalink to this definition">¶</a></dt>
+<dd><p>Normalize lat/lon values</p>
+<p>Ensure that lat/lon values are within [-180, 180)/[-90, 90) as well
+as sorted. If the values are off the grid they are shifted into the
+expected range.</p>
+<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"><ul class="first simple">
+<li><strong>lats</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – A 1D numpy array of sorted lat values.</li>
+<li><strong>lons</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – A 1D numpy array of sorted lon values.</li>
+<li><strong>values</strong> – A 3D array of data values.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A <a class="reference external" href="http://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><code class="xref py py-func docutils literal"><span class="pre">tuple()</span></code></a> of the form (adjust_lats, adjusted_lons,
+adjusted_values)</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
+<tr class="field-odd field"><td> </td><td class="field-body"><p class="first last">If the lat/lon values are not sorted.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="utils.parse_base_time_string">
+<code class="descclassname">utils.</code><code class="descname">parse_base_time_string</code><span class="sig-paren">(</span><em>time_format</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.parse_base_time_string" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve base time string from time data units information.</p>
+<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>time_format</strong> (<a class="reference external" href="http://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 time data units string from the dataset
+being processed. The string should be of the format
+‘<units> since <base time date>’</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The base time string split out of the time units information.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
+<tr class="field-odd field"><td> </td><td class="field-body">When the time_format parameter is malformed.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="utils.parse_time_base">
+<code class="descclassname">utils.</code><code class="descname">parse_time_base</code><span class="sig-paren">(</span><em>time_format</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.parse_time_base" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse time base object from the time units string.</p>
+<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>time_format</strong> (<a class="reference external" href="http://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 time data units string from the dataset
+being processed. The string should be of the format
+‘<units> since <base time date>’</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The base time as a datetime object.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
+<tr class="field-odd field"><td> </td><td class="field-body">When the base time string couldn’t be parsed from the
+units time_format string or if the date string didn’t match any of the
+expected formats.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="utils.parse_time_units">
+<code class="descclassname">utils.</code><code class="descname">parse_time_units</code><span class="sig-paren">(</span><em>time_format</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.parse_time_units" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse units value from time units string.</p>
+<dl class="docutils">
+<dt>The only units that are supported are: seconds, minutes, hours, days,</dt>
+<dd>months, or years.</dd>
+</dl>
+<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>time_format</strong> (<a class="reference external" href="http://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 time data units string from the dataset
+being processed. The string should be of the format
+‘<units> since <base time date>’</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The unit substring from the time units string</td>
+</tr>
+<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
+<tr class="field-odd field"><td> </td><td class="field-body">If the units present in the time units string doesn’t
+match one of the supported unit value.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="utils.reshape_monthly_to_annually">
+<code class="descclassname">utils.</code><code class="descname">reshape_monthly_to_annually</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.reshape_monthly_to_annually" title="Permalink to this definition">¶</a></dt>
+<dd><p>Reshape monthly binned dataset to annual bins.</p>
+<p>Reshape a monthly binned dataset’s 3D value array with shape
+(num_months, num_lats, num_lons) to a 4D array with shape
+(num_years, 12, num_lats, num_lons). This causes the data to be binned
+annually while retaining its original shape.</p>
+<p>It is assumed that the number of months in the dataset is evenly
+divisible by 12. If it is not you will receive error due to
+an invalid shape.</p>
+<p>Example change of a dataset’s shape:
+(24, 90, 180) -> (2, 12, 90, 180)</p>
+<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>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 with full-year format</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Dataset values array with shape (num_year, 12, num_lat, num_lon)</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/>
+ </a></p>
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="plotter.html"
+ title="previous chapter">Plotter Module</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="../data_source/data_sources.html"
+ title="next chapter">Data Sources</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/ocw/utils.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+ </div>
+<div id="searchbox" style="display: none" role="search">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2016, Apache Software Foundation.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.4</a>
+
+ |
+ <a href="../_sources/ocw/utils.txt"
+ rel="nofollow">Page source</a></li>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
Added: climate/site/trunk/content/api/1.1.0/py-modindex.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/1.1.0/py-modindex.html?rev=1754320&view=auto
==============================================================================
--- climate/site/trunk/content/api/1.1.0/py-modindex.html (added)
+++ climate/site/trunk/content/api/1.1.0/py-modindex.html Wed Jul 27 17:45:26 2016
@@ -0,0 +1,192 @@
+<!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>Python Module Index — Apache Open Climate Workbench 1.1.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.1.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="index.html" />
+
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+
+
+ <script type="text/javascript">
+ DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
+ </script>
+
+
+ </head>
+ <body role="document">
+ <div class="related" role="navigation" aria-label="related navigation">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="#" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">Apache Open Climate Workbench 1.1.0 documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+
+ <h1>Python Module Index</h1>
+
+ <div class="modindex-jumpbox">
+ <a href="#cap-d"><strong>d</strong></a> |
+ <a href="#cap-e"><strong>e</strong></a> |
+ <a href="#cap-l"><strong>l</strong></a> |
+ <a href="#cap-m"><strong>m</strong></a> |
+ <a href="#cap-o"><strong>o</strong></a> |
+ <a href="#cap-p"><strong>p</strong></a> |
+ <a href="#cap-r"><strong>r</strong></a> |
+ <a href="#cap-u"><strong>u</strong></a>
+ </div>
+
+ <table class="indextable modindextable" cellspacing="0" cellpadding="2">
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-d"><td></td><td>
+ <strong>d</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="data_source/data_sources.html#module-dap"><code class="xref">dap</code></a></td><td>
+ <em></em></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ocw/dataset_processor.html#module-dataset_processor"><code class="xref">dataset_processor</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-e"><td></td><td>
+ <strong>e</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="data_source/data_sources.html#module-esgf"><code class="xref">esgf</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-l"><td></td><td>
+ <strong>l</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="data_source/data_sources.html#module-local"><code class="xref">local</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-m"><td></td><td>
+ <strong>m</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ocw/metrics.html#module-metrics"><code class="xref">metrics</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-o"><td></td><td>
+ <strong>o</strong></td><td></td></tr>
+ <tr>
+ <td><img src="_static/minus.png" class="toggler"
+ id="toggle-1" style="display: none" alt="-" /></td>
+ <td>
+ <code class="xref">ocw_config_runner</code></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>
+ <a href="config/config_writer.html#module-ocw_config_runner.configuration_writer"><code class="xref">ocw_config_runner.configuration_writer</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-p"><td></td><td>
+ <strong>p</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ocw/plotter.html#module-plotter"><code class="xref">plotter</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-r"><td></td><td>
+ <strong>r</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="data_source/data_sources.html#module-rcmed"><code class="xref">rcmed</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-u"><td></td><td>
+ <strong>u</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ocw/utils.html#module-utils"><code class="xref">utils</code></a></td><td>
+ <em></em></td></tr>
+ </table>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="index.html">
+ <img class="logo" src="_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/>
+ </a></p>
+<div id="searchbox" style="display: none" role="search">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2016, Apache Software Foundation.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.4</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
Added: climate/site/trunk/content/api/1.1.0/search.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/1.1.0/search.html?rev=1754320&view=auto
==============================================================================
--- climate/site/trunk/content/api/1.1.0/search.html (added)
+++ climate/site/trunk/content/api/1.1.0/search.html Wed Jul 27 17:45:26 2016
@@ -0,0 +1,111 @@
+<!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>Search — Apache Open Climate Workbench 1.1.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.1.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="_static/searchtools.js"></script>
+ <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="index.html" />
+ <script type="text/javascript">
+ jQuery(function() { Search.loadIndex("searchindex.js"); });
+ </script>
+
+ <script type="text/javascript" id="searchindexloader"></script>
+
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+
+
+ </head>
+ <body role="document">
+ <div class="related" role="navigation" aria-label="related navigation">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <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">Apache Open Climate Workbench 1.1.0 documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1 id="search-documentation">Search</h1>
+ <div id="fallback" class="admonition warning">
+ <script type="text/javascript">$('#fallback').hide();</script>
+ <p>
+ Please activate JavaScript to enable the search
+ functionality.
+ </p>
+ </div>
+ <p>
+ From here you can search these documents. Enter your search
+ words into the box below and click "search". Note that the search
+ function will automatically search for all of the words. Pages
+ containing fewer words won't appear in the result list.
+ </p>
+ <form action="" method="get">
+ <input type="text" name="q" value="" />
+ <input type="submit" value="search" />
+ <span id="search-progress" style="padding-left: 10px"></span>
+ </form>
+
+ <div id="search-results">
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="index.html">
+ <img class="logo" src="_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/>
+ </a></p>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2016, Apache Software Foundation.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.4</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file