climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jo...@apache.org
Subject [52/56] Add docs to gh-pages
Date Tue, 01 Jul 2014 14:50:16 GMT
http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/ocw/plotter.html
----------------------------------------------------------------------
diff --git a/ocw/plotter.html b/ocw/plotter.html
new file mode 100644
index 0000000..112b1cc
--- /dev/null
+++ b/ocw/plotter.html
@@ -0,0 +1,344 @@
+<!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 &mdash; Apache Open Climate Workbench 0.3-incubating documentation</title>
+    
+    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '0.3-incubating',
+        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 0.3-incubating documentation" href="../index.html" />
+    <link rel="next" title="Data Sources" href="../data_source/data_sources.html" />
+    <link rel="prev" title="Metrics Module" href="metrics.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <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="metrics.html" title="Metrics Module"
+             accesskey="P">previous</a> |</li>
+        <li><a href="../index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> &raquo;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  <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><tt class="descclassname">plotter.</tt><tt class="descname">TaylorDiagram</tt><big>(</big><em>refstd</em>, <em>radmax=1.5</em>, <em>fig=None</em>, <em>rect=111</em>, <em>label='_'</em><big>)</big><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>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">
+<tt class="descname">add_contours</tt><big>(</big><em>std1</em>, <em>corr1</em>, <em>std2</em>, <em>corr2</em>, <em>**kwargs</em><big>)</big><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">
+<tt class="descname">add_rms_contours</tt><big>(</big><em>levels=5</em>, <em>**kwargs</em><big>)</big><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">
+<tt class="descname">add_sample</tt><big>(</big><em>stddev</em>, <em>corrcoef</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><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">
+<tt class="descname">add_stddev_contours</tt><big>(</big><em>std</em>, <em>corr1</em>, <em>corr2</em>, <em>**kwargs</em><big>)</big><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_contour_map">
+<tt class="descclassname">plotter.</tt><tt class="descname">draw_contour_map</tt><big>(</big><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><big>)</big><a class="headerlink" href="#plotter.draw_contour_map" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Purpose::</dt>
+<dd>Create a multiple panel contour map plot.</dd>
+<dt>Input::</dt>
+<dd><p class="first">dataset -  3d array of the field to be plotted with shape (nT, nLon, nLat)
+lats - array of latitudes
+lons - array of longitudes
+fname  - a string specifying the filename of the plot
+fmt  - an optional string specifying the filetype, default is .png
+gridshape - optional tuple denoting the desired grid shape (nrows, ncols) for arranging</p>
+<blockquote>
+<div>the subplots.</div></blockquote>
+<p>clabel - an optional string specifying the colorbar title
+ptitle - an optional string specifying plot title
+subtitles - an optional list of strings specifying the title for each subplot
+cmap - an string or optional matplotlib.colors.LinearSegmentedColormap instance</p>
+<blockquote>
+<div>denoting the colormap</div></blockquote>
+<p>clevs - an optional list of ints or floats specifying contour levels
+nlevs - an optional integer specifying the target number of contour levels if</p>
+<blockquote>
+<div>clevs is None</div></blockquote>
+<p>parallels - an optional list of ints or floats for the parallels to be drawn
+meridians - an optional list of ints or floats for the meridians to be drawn
+extend - an optional string to toggle whether to place arrows at the colorbar</p>
+<blockquote class="last">
+<div>boundaries. Default is &#8216;neither&#8217;, but can also be &#8216;min&#8217;, &#8216;max&#8217;, or
+&#8216;both&#8217;. Will be automatically set to &#8216;both&#8217; if clevs is None.</div></blockquote>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.draw_portrait_diagram">
+<tt class="descclassname">plotter.</tt><tt class="descname">draw_portrait_diagram</tt><big>(</big><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><big>)</big><a class="headerlink" href="#plotter.draw_portrait_diagram" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Purpose::</dt>
+<dd>Makes a portrait diagram plot.</dd>
+<dt>Input::</dt>
+<dd><dl class="first docutils">
+<dt>results - 3d array of the field to be plotted. The second dimension</dt>
+<dd>should correspond to the number of rows in the diagram and the
+third should correspond to the number of columns.</dd>
+</dl>
+<p>rowlabels - a list of strings denoting labels for each row
+collabels - a list of strings denoting labels for each column
+fname - a string specifying the filename of the plot
+fmt - an optional string specifying the output filetype
+gridshape - optional tuple denoting the desired grid shape (nrows, ncols) for arranging</p>
+<blockquote>
+<div>the subplots.</div></blockquote>
+<p>xlabel - an optional string specifying the x-axis title
+ylabel - an optional string specifying the y-axis title
+clabel - an optional string specifying the colorbar title
+ptitle - a string specifying the plot title
+subtitles - an optional list of strings specifying the title for each subplot
+cmap - an optional string or matplotlib.colors.LinearSegmentedColormap instance</p>
+<blockquote>
+<div>denoting the colormap</div></blockquote>
+<p>clevs - an optional list of ints or floats specifying colorbar levels
+nlevs - an optional integer specifying the target number of contour levels if</p>
+<blockquote>
+<div>clevs is None</div></blockquote>
+<dl class="last docutils">
+<dt>extend - an optional string to toggle whether to place arrows at the colorbar</dt>
+<dd>boundaries. Default is &#8216;neither&#8217;, but can also be &#8216;min&#8217;, &#8216;max&#8217;, or
+&#8216;both&#8217;. Will be automatically set to &#8216;both&#8217; if clevs is None.</dd>
+<dt>aspect - Float denoting approximate aspect ratio of each subplot</dt>
+<dd>(width / height). Default is 8.5 / 5.5</dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.draw_subregions">
+<tt class="descclassname">plotter.</tt><tt class="descname">draw_subregions</tt><big>(</big><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><big>)</big><a class="headerlink" href="#plotter.draw_subregions" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Purpose::</dt>
+<dd>Function to draw subregion domain(s) on a map</dd>
+<dt>Input::</dt>
+<dd><p class="first">subregions - a list of subRegion objects
+lats - array of latitudes
+lons - array of longitudes
+fname  - a string specifying the filename of the plot
+fmt  - an optional string specifying the filetype, default is .png
+ptitle - an optional string specifying plot title
+parallels - an optional list of ints or floats for the parallels to be drawn
+meridians - an optional list of ints or floats for the meridians to be drawn
+subregion_masks - optional dictionary of boolean arrays for each subRegion</p>
+<blockquote class="last">
+<div>for giving finer control of the domain to be drawn, by default
+the entire domain is drawn.</div></blockquote>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.draw_taylor_diagram">
+<tt class="descclassname">plotter.</tt><tt class="descname">draw_taylor_diagram</tt><big>(</big><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><big>)</big><a class="headerlink" href="#plotter.draw_taylor_diagram" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Purpose::</dt>
+<dd>Draws a Taylor diagram</dd>
+<dt>Input::</dt>
+<dd><dl class="first docutils">
+<dt>results - an Nx2 array containing normalized standard deviations,</dt>
+<dd>correlation coefficients, and names of evaluation results</dd>
+</dl>
+<p>names - list of names for each evaluated dataset
+refname - The name of the reference dataset
+fname  - a string specifying the filename of the plot
+fmt  - an optional string specifying the filetype, default is .png
+gridshape - optional tuple denoting the desired grid shape (nrows, ncols) for arranging</p>
+<blockquote>
+<div>the subplots.</div></blockquote>
+<p>ptitle - an optional string specifying the plot title
+subtitles - an optional list of strings specifying the title for each subplot
+pos - an optional string or tuple of float for determining</p>
+<blockquote>
+<div>the position of the legend</div></blockquote>
+<dl class="last docutils">
+<dt>frameon - an optional boolean that determines whether to draw a frame</dt>
+<dd>around the legend box</dd>
+<dt>radmax - an optional float to adjust the extent of the axes in terms of</dt>
+<dd>standard deviation.</dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.draw_time_series">
+<tt class="descclassname">plotter.</tt><tt class="descname">draw_time_series</tt><big>(</big><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><big>)</big><a class="headerlink" href="#plotter.draw_time_series" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Purpose::</dt>
+<dd>Function to draw a time series plot</dd>
+<dt>Input::</dt>
+<dd><p class="first">results - a 3d array of time series
+times - a list of python datetime objects
+labels - a list of strings with the names of each set of data
+fname - a string specifying the filename of the plot
+fmt - an optional string specifying the output filetype
+gridshape - optional tuple denoting the desired grid shape (nrows, ncols) for arranging</p>
+<blockquote>
+<div>the subplots.</div></blockquote>
+<p>xlabel - a string specifying the x-axis title
+ylabel - a string specifying the y-axis title
+ptitle - a string specifying the plot title
+subtitles - an optional list of strings specifying the title for each subplot
+label_month - optional bool to toggle drawing month labels
+yscale - optional string for setting the y-axis scale, &#8216;linear&#8217; for linear</p>
+<blockquote>
+<div>and &#8216;log&#8217; for log base 10.</div></blockquote>
+<dl class="last docutils">
+<dt>aspect - Float denoting approximate aspect ratio of each subplot</dt>
+<dd>(width / height). Default is 8.5 / 5.5</dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="function">
+<dt id="plotter.set_cmap">
+<tt class="descclassname">plotter.</tt><tt class="descname">set_cmap</tt><big>(</big><em>name</em><big>)</big><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 &#8216;_r&#8217; 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/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The name of the colormap.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <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="../data_source/data_sources.html"
+                        title="next chapter">Data Sources</a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../_sources/ocw/plotter.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
+  <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="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >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"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="metrics.html" title="Metrics Module"
+             >previous</a> |</li>
+        <li><a href="../index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2013, Michael Joyce.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
+    </div>
+  </body>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/py-modindex.html
----------------------------------------------------------------------
diff --git a/py-modindex.html b/py-modindex.html
new file mode 100644
index 0000000..7303aeb
--- /dev/null
+++ b/py-modindex.html
@@ -0,0 +1,150 @@
+<!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 &mdash; Apache Open Climate Workbench 0.3-incubating documentation</title>
+    
+    <link rel="stylesheet" href="_static/default.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '0.3-incubating',
+        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 0.3-incubating documentation" href="index.html" />
+ 
+
+    <script type="text/javascript">
+      DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
+    </script>
+
+
+  </head>
+  <body>
+    <div class="related">
+      <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><a href="index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> &raquo;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+
+   <h1>Python Module Index</h1>
+
+   <div class="modindex-jumpbox">
+   <a href="#cap-d"><strong>d</strong></a> | 
+   <a href="#cap-l"><strong>l</strong></a> | 
+   <a href="#cap-p"><strong>p</strong></a> | 
+   <a href="#cap-r"><strong>r</strong></a>
+   </div>
+
+   <table class="indextable modindextable" cellspacing="0" cellpadding="2">
+     <tr class="pcap"><td></td><td>&nbsp;</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"><tt class="xref">dap</tt></a></td><td>
+       <em></em></td></tr>
+     <tr>
+       <td></td>
+       <td>
+       <a href="ocw/dataset_processor.html#module-dataset_processor"><tt class="xref">dataset_processor</tt></a></td><td>
+       <em></em></td></tr>
+     <tr class="pcap"><td></td><td>&nbsp;</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"><tt class="xref">local</tt></a></td><td>
+       <em></em></td></tr>
+     <tr class="pcap"><td></td><td>&nbsp;</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"><tt class="xref">plotter</tt></a></td><td>
+       <em></em></td></tr>
+     <tr class="pcap"><td></td><td>&nbsp;</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"><tt class="xref">rcmed</tt></a></td><td>
+       <em></em></td></tr>
+   </table>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+  <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="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >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><a href="index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2013, Michael Joyce.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
+    </div>
+  </body>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/search.html
----------------------------------------------------------------------
diff --git a/search.html b/search.html
new file mode 100644
index 0000000..ba73691
--- /dev/null
+++ b/search.html
@@ -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 &mdash; Apache Open Climate Workbench 0.3-incubating documentation</title>
+    
+    <link rel="stylesheet" href="_static/default.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '0.3-incubating',
+        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 0.3-incubating documentation" href="index.html" />
+  <script type="text/javascript">
+    jQuery(function() { Search.loadIndex("searchindex.js"); });
+  </script>
+  
+  <script type="text/javascript" id="searchindexloader"></script>
+   
+
+  </head>
+  <body>
+    <div class="related">
+      <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><a href="index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> &raquo;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  <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">
+        <div class="sphinxsidebarwrapper">
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >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><a href="index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2013, Michael Joyce.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
+    </div>
+  </body>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/searchindex.js
----------------------------------------------------------------------
diff --git a/searchindex.js b/searchindex.js
new file mode 100644
index 0000000..e2c10ed
--- /dev/null
+++ b/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({envversion:42,terms:{all:[0,2,4,5,3],rowlabel:7,month:[3,7],prefix:4,correl:7,netcdf:[2,3,4],add_dataset:0,follow:[4,6],row:7,depend:[],time_rang:6,deviat:[5,7],ylabel:7,add_sampl:7,linearsegmentedcolormap:7,everi:0,string:[2,3,4,6,7],fals:[4,7],arcco:7,failur:4,time_nam:4,unarymetr:[],relev:4,level:7,list:[0,3,2,4,6,7],adjust:7,spatial_regrid:3,nlev:7,refer:[0,4,5,7],add_contour:7,dimens:7,upper:7,second:7,pass:4,dataset_id:[2,4],append:7,linear:7,index:[1,4],compar:[0,7],abl:4,current:5,version:7,"new":3,file_path:[2,4],metadata:[],lon_min:[4,6],full:4,gener:3,coeffici:7,matplotlib:7,address:4,path:[3,4],reference_dataset:4,std1:7,legend:7,valu:[2,3,4,6],std2:7,box:7,search:1,plotter:[],datetim:[2,3,6,7],subregion_inform:4,load_fil:2,chang:4,control:7,timestep:3,approxim:7,submodul:4,filenam:7,parameter_id:[2,4],longnam:4,instal:4,txt:4,unit:4,lonslength:6,plot:7,lat_max:[4,6],from:[0,3,2,4,5,6],would:4,two:[0,7],next:0,ref_dataset:[0,5],call:4,usr:4,type:[0,2,6,5
 ,3],clabel:7,toggl:7,more:[0,4],sort:6,desir:7,python:[3,4,6,7],relat:4,start_dat:4,hold:6,easiest:4,origin:4,must:[0,3,4,6],none:[0,6,7],endpoint:[],retriev:[2,4],hour:3,work:[4,6],uniqu:6,dev:5,minimum:[2,4,6],can:[0,4,7],purpos:7,overrid:5,climat:[],give:7,process:[],subregion:[0,3,4,7],ratio:7,end:[2,4,6],secur:4,dataset_processor:3,write:3,how:4,new_longitud:3,css:4,map:7,timedelta:[3,4,6],max:[6,7],draw_taylor_diagram:7,diagram:7,befor:[0,4],date:6,multipl:[0,7],parallel:7,demonstr:4,"short":4,third:7,taylordiagram:7,correspond:[6,7],frameon:7,quadrant:7,inform:[0,2,4,6,3],ensembl:3,radmax:7,dir_path:4,extractor:[],frontend:4,help:4,new_latitud:3,over:[0,5],midnight:3,list_var:4,through:0,list_tim:4,paramet:[0,3,2,4,5,6,7],binari:[0,5],fig:7,main:4,meridian:7,finer:7,them:0,"float":[2,6,7],"return":[2,3,4,6,5],thei:[0,4],handl:0,safe:3,dai:[4,6],framework:4,term:7,name:[2,3,4,6,7],anyth:4,revers:7,arrow:7,max_lat:[2,6],mean:3,subset:[0,3],domain:7,metricname1:4,metricname2:4,l
 aboratori:4,"static":4,expect:4,extract:4,out:4,variabl:[2,4,6],shown:4,webservic:[],primari:4,content:1,rel:4,variable_nam:2,unrecogn:6,spatial_rebin_lon_step:4,correct:6,stddev:7,manipul:4,given:[2,3,4,5],standard:[3,5,7],base:[5,7],dictionari:[2,4,7],org:7,rect:7,servererror:2,thing:4,rais:[0,2,6,3],place:7,isn:0,run_webservic:4,top:4,end_dat:4,first:[0,3],oper:6,pleas:4,rang:[4,6],directli:7,arrai:[3,6,5,7],number:[0,4,7],max_lon:[2,6],lat:[4,6,7],instruct:4,temporalstddev:[],lat_min:[4,6],size:3,differ:[5,7],jet:4,work_dir:4,fmt:7,run_evalu:4,system:4,least:0,add_rms_contour:7,axisartist:7,"final":4,store:2,subplot:7,option:[0,4,6,7],specifi:[0,7],exactli:4,than:6,png:7,std:[5,7],target:[0,3,4,5,7],provid:[0,3,4],xlabel:7,str:7,posit:7,arrang:7,start_tim:[2,4,6],safe_subset:3,latitud:[2,3,4,6,7],respons:4,ani:0,lon_nam:4,have:[0,3,4],need:[3,4,6],rebin:3,built:4,min:[6,7],normalize_dataset_datetim:3,lat_nam:4,note:[0,3,4],also:[4,7],ideal:4,exampl:[4,7],mpl_toolkit:7,fname:7,da
 ta_source_id:4,normal:[3,7],object:[0,3,2,4,6,7],compress:3,local_file_metadata_extractor:4,draw_subregion:7,add_metr:0,regular:0,plan:4,phase:0,temporal_resolut:[3,4,6],"class":[0,2,4,5,6,7],draw_portrait_diagram:7,url:2,request:4,dimension:6,directory_help:4,clean:4,shortnam:4,axi:7,width:7,unari:[0,5],get_parameters_metadata:2,filetyp:7,radiu:7,bring:4,eas:4,onli:[0,6],locat:4,configur:[],written:4,should:[0,4,7],dict:4,ocw:[3,4],serv:4,variou:4,get:[2,4],min_lat:[2,6],mainten:4,theta:7,requir:[0,3,4,6],binarymetr:[],subregion_mask:7,bar:4,baz:4,floating_ax:7,whether:7,show_colormap:7,contain:[0,3,2,4,6,7],grab:4,where:[0,4],set:7,frame:7,clev:7,displai:4,see:7,result:[0,4,5,7],arg:7,portrait:7,contour:7,databas:[2,4],boundari:[6,7],label:7,spatial_rebin_lat_step:4,figur:7,between:[5,7],drawn:7,neither:7,experi:4,attribut:6,corr2:7,corr1:7,extend:7,draw_time_seri:7,javascript:4,corrcoef:7,entir:[3,4,7],extent:7,otherwis:[0,4],both:[4,7],subtitl:7,region:[2,4],annual:4,against:[0,
 5],tempor:[3,4,6,5],instanc:[0,7],refstd:7,min_lon:[2,6],seri:7,load:[2,4],point:[2,7],color:7,guidelin:6,height:7,yearli:4,suppli:4,parameter_dataset:2,assum:4,write_netcdf:3,backend:4,three:6,evalu:[],numpi:[3,6,5],compos:3,empti:4,json:4,interest:2,monthli:[3,4],valueerror:[0,2,6,3],resolut:[3,4,6],understand:4,togeth:4,els:0,present:[4,6],longitudin:6,servic:[],colorbar:7,defin:4,calcul:[6,5],abov:4,error:3,exist:4,succes:4,propag:7,rcmed_help:4,jpl:[2,4],helper:[],metric:[],toolkit:4,kwarg:7,opendap:2,around:7,num_target_d:0,label_month:7,minim:4,receiv:6,make:7,same:[3,4],regrid:3,html:7,http:7,again:4,num_metr:0,upon:[0,4],var_nam:4,fairli:4,moment:4,latitudin:6,user:[0,2,4],file2:4,center:7,well:[0,4,6],inherit:[0,5],without:[3,6],command:[4,7],thi:[4,6,5],pylab_exampl:7,model:[2,4,7],nlon:7,explan:[],identifi:4,just:4,less:6,target_dataset:[0,3,4,5],num_subregion:0,end_tim:[2,4,6],shape:[0,3,6,7],temporal_rebin:3,aspect:7,ptitl:7,dataset_info:4,web:[],propuls:4,singl:[0,3,7
 ],datasetshortnam:4,add:[0,7],other:4,appli:3,input:[3,7],determin:[4,7],app:4,match:4,take:0,bin:[3,4],applic:4,which:[0,3,4,5],format:4,read:2,bia:[],grid:[6,7],num_target:0,measur:4,specif:4,success:4,manual:6,integ:[2,4,7],server:4,"boolean":7,either:3,output:[3,7],page:[1,4],right:7,nlat:7,creation:4,unary_metr:0,sampl:7,evalutaion:2,guarante:6,guess:4,scale:7,corrcoeff:7,overlap:3,foo:4,leader:4,gridshap:7,lon_resolut:6,run:[0,4,5],colormap:7,each:[0,2,7],broken:4,step:4,post:4,spatial_resolut:6,panel:7,column:7,lon_max:[4,6],degre:4,cmap:7,constructor:[0,6],processor:[],lat_resolut:6,file1:4,add_stddev_contour:7,within:[3,4],bound:[],automat:7,dataset:[],pair:0,timeslength:6,strip:4,ensur:4,num_target_dataset:0,refnam:7,log:7,wai:4,support:4,lon:[4,6,7],"long":4,avail:4,start:[2,4,6],"function":[4,6,7],bottl:4,properli:[4,6],form:6,forc:3,tupl:[6,7],link:4,line:7,"true":[3,4,7],pull:4,data_sourc:4,possibl:[0,4,7],"default":[0,6,7],wish:4,list_latlon:4,latslength:6,maximum:[2,
 4,6],tell:4,below:4,ncol:7,curv:7,taylor:7,constant:7,creat:[4,7],yscale:7,"int":7,certain:6,"abstract":5,doesn:0,set_cmap:7,file:[],pip:4,doe:4,check:4,denot:7,nx2:7,collabel:7,titl:7,when:[0,4,5,7],field:7,valid:[0,6],bool:7,futur:4,spatial:[3,4,6],test:4,you:[0,4,7],unary_result:0,polar:7,draw:7,spatial_boundari:6,symbol:4,longitud:[2,3,4,6,7],nasa:4,nrow:7,directori:[],path_lead:4,daili:[3,4],time:[3,2,4,5,6,7],draw_contour_map:7},objtypes:{"0":"http:get","1":"http:post","2":"py:module","3":"py:function","4":"py:method","5":"py:attribute","6":"py:class"},objnames:{"0":["http","get","HTTP get"],"1":["http","post","HTTP post"],"2":["py","module","Python module"],"3":["py","function","Python function"],"4":["py","method","Python method"],"5":["py","attribute","Python attribute"],"6":["py","class","Python class"]},filenames:["ocw/evaluation","index","data_source/data_sources","ocw/dataset_processor","ui-backend/backend","ocw/metrics","ocw/dataset","ocw/plotter"],titles:["Evaluation 
 Module","Welcome to Apache Open Climate Workbench&#8217;s documentation!","Data Sources","Dataset Processor Module","Evaluation UI Webservices","Metrics Module","Dataset Module","Plotter Module"],objects:{"":{"/parameters/":[4,0,1,"get--parameters-"],"/results/(dir_path:path)":[4,0,1,"get--results-(dir_path-path)"],"/parameters/bounds/":[4,0,1,"get--parameters-bounds-"],"/metrics/":[4,0,1,"get--metrics-"],"/list_vars/(file_path:path)":[4,0,1,"get--list_vars-(file_path-path)"],"/list_latlon/(file_path:path)":[4,0,1,"get--list_latlon-(file_path-path)"],"/results/":[4,0,1,"get--results-"],dataset_processor:[3,2,0,"-"],plotter:[7,2,0,"-"],local:[2,2,0,"-"],"/list/":[4,0,1,"get--list-"],"/list/(dir_path:path)":[4,0,1,"get--list-(dir_path-path)"],dap:[2,2,0,"-"],"/run_evaluation/":[4,1,1,"post--run_evaluation-"],"/list_time/(file_path:path)":[4,0,1,"get--list_time-(file_path-path)"],rcmed:[2,2,0,"-"],"/parameters/bounds":[4,0,1,"get--parameters-bounds"],"/path_leader/":[4,0,1,"get--path_l
 eader-"],"/datasets/":[4,0,1,"get--datasets-"]},"metrics.UnaryMetric":{run:[5,4,1,""]},"metrics.Bias":{run:[5,4,1,""]},plotter:{draw_time_series:[7,3,1,""],TaylorDiagram:[7,6,1,""],draw_taylor_diagram:[7,3,1,""],set_cmap:[7,3,1,""],draw_portrait_diagram:[7,3,1,""],draw_contour_map:[7,3,1,""],draw_subregions:[7,3,1,""]},local:{load_file:[2,3,1,""]},dataset_processor:{subset:[3,3,1,""],temporal_rebin:[3,3,1,""],spatial_regrid:[3,3,1,""],normalize_dataset_datetimes:[3,3,1,""],ensemble:[3,3,1,""],write_netcdf:[3,3,1,""],safe_subset:[3,3,1,""]},dataset:{Bounds:[6,6,1,""],Dataset:[6,6,1,""]},metrics:{UnaryMetric:[5,6,1,""],Bias:[5,6,1,""],TemporalStdDev:[5,6,1,""],BinaryMetric:[5,6,1,""]},"metrics.BinaryMetric":{run:[5,4,1,""]},dap:{load:[2,3,1,""]},"plotter.TaylorDiagram":{add_sample:[7,4,1,""],add_rms_contours:[7,4,1,""],add_stddev_contours:[7,4,1,""],add_contours:[7,4,1,""]},"dataset.Dataset":{temporal_resolution:[6,4,1,""],spatial_resolution:[6,4,1,""],time_range:[6,4,1,""],spatial_bo
 undaries:[6,4,1,""]},rcmed:{parameter_dataset:[2,3,1,""],get_parameters_metadata:[2,3,1,""]},"metrics.TemporalStdDev":{run:[5,4,1,""]},evaluation:{Evaluation:[0,6,1,""]},"evaluation.Evaluation":{run:[0,4,1,""],unary_results:[0,5,1,""],add_metric:[0,4,1,""],add_datasets:[0,4,1,""],results:[0,5,1,""],target_datasets:[0,5,1,""],metrics:[0,5,1,""],add_dataset:[0,4,1,""],add_metrics:[0,4,1,""],unary_metrics:[0,5,1,""]}},titleterms:{explan:4,extractor:4,workbench:1,climat:1,process:4,modul:[0,3,2,5,6,7],bound:6,indic:1,dataset:[3,6],temporalstddev:5,file:4,tabl:1,open:1,web:4,depend:4,welcom:1,helper:4,webservic:4,unarymetr:5,configur:4,apach:1,evalu:[0,4],document:1,local:[2,4],metric:5,metadata:4,sourc:2,bia:5,dap:2,data:2,binarymetr:5,endpoint:4,directori:4,plotter:7,servic:4,rcmed:[2,4],processor:3}})
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/ui-backend/backend.html
----------------------------------------------------------------------
diff --git a/ui-backend/backend.html b/ui-backend/backend.html
new file mode 100644
index 0000000..dc3272e
--- /dev/null
+++ b/ui-backend/backend.html
@@ -0,0 +1,627 @@
+<!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 UI Webservices &mdash; Apache Open Climate Workbench 0.3-incubating documentation</title>
+    
+    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '0.3-incubating',
+        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 0.3-incubating documentation" href="../index.html" />
+    <link rel="prev" title="Data Sources" href="../data_source/data_sources.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <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="P">previous</a> |</li>
+        <li><a href="../index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> &raquo;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  <div class="section" id="evaluation-ui-webservices">
+<h1>Evaluation UI Webservices<a class="headerlink" href="#evaluation-ui-webservices" title="Permalink to this headline">¶</a></h1>
+<p>The OCW evaluation UI is a demonstration web application that is built upon the
+OCW toolkit. The web services for the application are written in Python on top
+of the Bottle Web Framework.</p>
+<div class="section" id="configuration-and-dependencies">
+<h2>Configuration and Dependencies<a class="headerlink" href="#configuration-and-dependencies" title="Permalink to this headline">¶</a></h2>
+<p>The Evaluation UI is built on top of the OCW toolkit and as such requires it to
+function properly. Please check the toolkit&#8217;s documentation for relevant
+installation instructions. You will also need to ensure that you have Bottle
+installed. You can install it with:</p>
+<div class="code highlight-python"><div class="highlight"><pre>pip install bottle
+</pre></div>
+</div>
+<p>The backend serves the static files for the evaluation frontend as well. If you
+plan to use the frontend you need to ensure that the <em>app</em> directory is present
+in the main web service directory. The easiest way to do this is to create a
+symbolic link where the <em>run_webservices</em> module is located. Assuming you have
+the entire <em>ocw-ui</em> directory, you can do this with the following command.</p>
+<div class="code highlight-python"><div class="highlight"><pre>cd ocw-ui/backend
+ln -s ../frontend/app app
+</pre></div>
+</div>
+<p>Finally, to start the backend just run the following command.</p>
+<div class="code highlight-python"><div class="highlight"><pre>python run_webservices.py
+</pre></div>
+</div>
+</div>
+<div class="section" id="web-service-explanation">
+<h2>Web Service Explanation<a class="headerlink" href="#web-service-explanation" title="Permalink to this headline">¶</a></h2>
+<p>The backend endpoints are broken up into a number of modules for ease of
+maintenance and understanding. The <em>run_webservices</em> module is the primary
+application module. It brings together all the various submodules into a
+useful system. It also defines a number of helpful endpoints for returning
+static files such as the index page, CSS files, JavaScript files, and more.</p>
+<div class="section" id="local-file-metadata-extractors">
+<h3>Local File Metadata Extractors<a class="headerlink" href="#local-file-metadata-extractors" title="Permalink to this headline">¶</a></h3>
+<p>The <em>local_file_metadata_extractors</em> module contains all the endpoints that are
+used to strip information out of various objects for display in the UI. At the
+moment, the main functionality is stripping out metadata from NetCDF files when
+a user wishes to <em>load</em> a local file into the evaluation.</p>
+<dl class="get">
+<dt id="get--list_latlon-(file_path-path)">
+<tt class="descname">GET </tt><tt class="descname">/list_latlon/</tt><big>(</big><em class="property">file_path: </em><em>path</em><big>)</big><a class="headerlink" href="#get--list_latlon-(file_path-path)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve lat/lon information from given file.</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>file_path</strong> (<em>string:</em>) &#8211; Path to the NetCDF file from which lat/lon information
+should be extracted</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary containing lat/lon information if successful, otherwise
+failure information is returned.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Example successful JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s1">&#39;success&#39;</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
+    <span class="s1">&#39;lat_name&#39;</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">guessed</span> <span class="nx">latitude</span> <span class="nx">variable</span> <span class="nx">name</span><span class="p">,</span>
+    <span class="s1">&#39;lon_name&#39;</span><span class="o">:</span> <span class="nx">the</span> <span class="nx">guessed</span> <span class="nx">longitude</span> <span class="nx">variable</span> <span class="nx">name</span><span class="p">,</span>
+    <span class="s1">&#39;lat_min&#39;</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">minimum</span> <span class="nx">latitude</span> <span class="nx">value</span><span class="p">,</span>
+    <span class="s1">&#39;lat_max&#39;</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">maximum</span> <span class="nx">latitude</span> <span class="nx">value</span><span class="p">,</span>
+    <span class="s1">&#39;lon_min&#39;</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">minimum</span> <span class="nx">longitude</span> <span class="nx">value</span><span class="p">,</span>
+    <span class="s1">&#39;lon_max&#39;</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">maximum</span> <span class="nx">longitude</span> <span class="nx">value</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Example failure JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s1">&#39;success&#39;</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
+    <span class="s1">&#39;variables&#39;</span><span class="o">:</span> <span class="nx">List</span> <span class="nx">of</span> <span class="nx">all</span> <span class="nx">variables</span> <span class="nx">present</span> <span class="k">in</span> <span class="nx">the</span> <span class="nx">NetCDF</span> <span class="nx">file</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--list_time-(file_path-path)">
+<tt class="descname">GET </tt><tt class="descname">/list_time/</tt><big>(</big><em class="property">file_path: </em><em>path</em><big>)</big><a class="headerlink" href="#get--list_time-(file_path-path)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve time information from provided file.</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>file_path</strong> (<em>String:</em>) &#8211; Path to the NetCDF file from which time information
+should be extracted</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary containing time information if successful, otherwise
+failure information is returned.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Example successful JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s2">&quot;success&quot;</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
+    <span class="s2">&quot;time_name&quot;</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">guessed</span> <span class="nx">time</span> <span class="nx">variable</span> <span class="nx">name</span><span class="p">,</span>
+    <span class="s2">&quot;start_time&quot;</span><span class="o">:</span> <span class="s2">&quot;1988-06-10 00:00:00&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;end_time&quot;</span><span class="o">:</span> <span class="s2">&quot;2008-01-27 00:00:00&quot;</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Example failure JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s2">&quot;success&quot;</span><span class="o">:</span> <span class="kc">false</span>
+    <span class="s2">&quot;variables&quot;</span><span class="o">:</span> <span class="nx">List</span> <span class="nx">of</span> <span class="nx">all</span> <span class="nx">variable</span> <span class="nx">names</span> <span class="k">in</span> <span class="nx">the</span> <span class="nx">file</span>
+<span class="p">}</span> 
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--list_vars-(file_path-path)">
+<tt class="descname">GET </tt><tt class="descname">/list_vars/</tt><big>(</big><em class="property">file_path: </em><em>path</em><big>)</big><a class="headerlink" href="#get--list_vars-(file_path-path)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve variable names from file.</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>file_path</strong> (<em>String:</em>) &#8211; Path to the NetCDF file from which variable information
+should be extracted</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary containing variable information if succesful, otherwise
+failure information is returned.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Example successful JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s2">&quot;success&quot;</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
+    <span class="s2">&quot;variables&quot;</span><span class="o">:</span> <span class="nx">List</span> <span class="nx">of</span> <span class="nx">variable</span> <span class="nx">names</span> <span class="k">in</span> <span class="nx">the</span> <span class="nx">file</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Example failure JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s2">&quot;success&quot;</span><span class="o">:</span> <span class="kc">false</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+</div>
+<div class="section" id="directory-helpers">
+<h3>Directory Helpers<a class="headerlink" href="#directory-helpers" title="Permalink to this headline">¶</a></h3>
+<p>The <em>directory_helpers</em> module contains a number of endpoints for working
+directory manipulation. The frontend uses these endpoints to grab directory
+information (within a prefix path for security), return result directory
+information, and other things.</p>
+<dl class="get">
+<dt id="get--list-">
+<tt class="descname">GET </tt><tt class="descname">/list/</tt><a class="headerlink" href="#get--list-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return the listing of a supplied path.</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>dir_path</strong> (<em>String</em>) &#8211; The directory path to list.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary containing the directory listing if possible.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Example successful JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s1">&#39;listing&#39;</span><span class="o">:</span> <span class="p">[</span>
+        <span class="s1">&#39;/bar/&#39;</span><span class="p">,</span>
+        <span class="s1">&#39;/baz.txt&#39;</span><span class="p">,</span>
+        <span class="s1">&#39;/test.txt&#39;</span>
+    <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Example failure JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span><span class="s1">&#39;listing&#39;</span><span class="o">:</span> <span class="p">[]}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--list-(dir_path-path)">
+<tt class="descname">GET </tt><tt class="descname">/list/</tt><big>(</big><em class="property">dir_path: </em><em>path</em><big>)</big><a class="headerlink" href="#get--list-(dir_path-path)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return the listing of a supplied path.</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>dir_path</strong> (<em>String</em>) &#8211; The directory path to list.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary containing the directory listing if possible.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Example successful JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s1">&#39;listing&#39;</span><span class="o">:</span> <span class="p">[</span>
+        <span class="s1">&#39;/bar/&#39;</span><span class="p">,</span>
+        <span class="s1">&#39;/baz.txt&#39;</span><span class="p">,</span>
+        <span class="s1">&#39;/test.txt&#39;</span>
+    <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Example failure JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span><span class="s1">&#39;listing&#39;</span><span class="o">:</span> <span class="p">[]}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--results-">
+<tt class="descname">GET </tt><tt class="descname">/results/</tt><a class="headerlink" href="#get--results-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve results directory information.</p>
+<p>The backend&#8217;s results directory is determined by WORK_DIR. All the 
+directories there are formatted and returned as results. If WORK_DIR does
+not exist, an empty listing will be returned (shown as a &#8216;failure below&#8217;).</p>
+<p><strong>Successful JSON Response</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s1">&#39;listing&#39;</span><span class="o">:</span> <span class="p">[</span>
+        <span class="s1">&#39;/bar&#39;</span><span class="p">,</span>
+        <span class="s1">&#39;/foo&#39;</span>
+    <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Failure JSON Response</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s1">&#39;listing&#39;</span><span class="o">:</span> <span class="p">[]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--path_leader-">
+<tt class="descname">GET </tt><tt class="descname">/path_leader/</tt><a class="headerlink" href="#get--path_leader-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return the path leader used for clean path creation.</p>
+<p><strong>Example JSON Response</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span><span class="s1">&#39;leader&#39;</span><span class="o">:</span> <span class="s1">&#39;/usr/local/ocw&#39;</span><span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--results-(dir_path-path)">
+<tt class="descname">GET </tt><tt class="descname">/results/</tt><big>(</big><em class="property">dir_path: </em><em>path</em><big>)</big><a class="headerlink" href="#get--results-(dir_path-path)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve specific result files.</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>dir_path</strong> (<em>String</em>) &#8211; The relative results path to list.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary of the requested result&#8217;s directory listing.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Successful JSON Response</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s1">&#39;listing&#39;</span><span class="o">:</span> <span class="p">[</span>
+        <span class="s1">&#39;file1&#39;</span><span class="p">,</span>
+        <span class="s1">&#39;file2&#39;</span>
+    <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Failure JSON Response</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s1">&#39;listing&#39;</span><span class="o">:</span> <span class="p">[]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+</div>
+<div class="section" id="rcmed-helpers">
+<h3>RCMED Helpers<a class="headerlink" href="#rcmed-helpers" title="Permalink to this headline">¶</a></h3>
+<p>The <em>rcmed_helpers</em> module contains endpoints for loading datasets from the
+Regional Climate Model Evaluation Database at NASA&#8217;s Jet Propulsion Laboratory.</p>
+<dl class="get">
+<dt id="get--parameters-">
+<tt class="descname">GET </tt><tt class="descname">/parameters/</tt><a class="headerlink" href="#get--parameters-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return dataset specific parameter information from JPL&#8217;s RCMED.</p>
+<p><strong>Example Call Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre>/parameters/?dataset=&lt;dataset&#39;s short name&gt;
+</pre></div>
+</div>
+<p><strong>Example Return JSON Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">[</span>
+    <span class="p">{</span>
+        <span class="s2">&quot;parameter_id&quot;</span><span class="o">:</span> <span class="s2">&quot;80&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;shortname&quot;</span><span class="o">:</span> <span class="s2">&quot;The dataset&#39;s short name&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;datasetshortname&quot;</span><span class="o">:</span> <span class="s2">&quot;The dataset&#39;s short name again&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;longname&quot;</span><span class="o">:</span> <span class="s2">&quot;The dataset&#39;s long name&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;units&quot;</span><span class="o">:</span> <span class="s2">&quot;Units for the dataset&#39;s measurements&quot;</span>
+    <span class="p">}</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--parameters-bounds">
+<tt class="descname">GET </tt><tt class="descname">/parameters/bounds</tt><a class="headerlink" href="#get--parameters-bounds" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return temporal and spatial bounds metadata for all of JPL&#8217;s RCMED parameters.</p>
+<p><strong>Example Call Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre>/parameters/bounds/
+</pre></div>
+</div>
+<p><strong>Example Return JSON Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+  <span class="s2">&quot;38&quot;</span><span class="o">:</span> <span class="p">{</span>
+    <span class="s2">&quot;start_date&quot;</span><span class="o">:</span> <span class="s2">&quot;1901-01-15&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;end_date&quot;</span><span class="o">:</span> <span class="s2">&quot;2009-12-15&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;lat_max&quot;</span><span class="o">:</span> <span class="mf">89.75</span><span class="p">,</span>
+    <span class="s2">&quot;lat_min&quot;</span><span class="o">:</span> <span class="o">-</span><span class="mf">89.75</span><span class="p">,</span>
+    <span class="s2">&quot;lon_max&quot;</span><span class="o">:</span> <span class="mf">179.75</span><span class="p">,</span>
+    <span class="s2">&quot;lon_min&quot;</span><span class="o">:</span> <span class="o">-</span><span class="mf">179.75</span>
+  <span class="p">},</span>
+  <span class="s2">&quot;39&quot;</span><span class="o">:</span> <span class="p">{</span>
+    <span class="s2">&quot;start_date&quot;</span><span class="o">:</span> <span class="s2">&quot;1901-01-15&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;end_date&quot;</span><span class="o">:</span> <span class="s2">&quot;2009-12-15&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;lat_max&quot;</span><span class="o">:</span> <span class="mf">89.75</span><span class="p">,</span>
+    <span class="s2">&quot;lat_min&quot;</span><span class="o">:</span> <span class="o">-</span><span class="mf">89.75</span><span class="p">,</span>
+    <span class="s2">&quot;lon_max&quot;</span><span class="o">:</span> <span class="mf">179.75</span><span class="p">,</span>
+    <span class="s2">&quot;lon_min&quot;</span><span class="o">:</span> <span class="o">-</span><span class="mf">179.75</span>
+  <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--datasets-">
+<tt class="descname">GET </tt><tt class="descname">/datasets/</tt><a class="headerlink" href="#get--datasets-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return a list of dataset information from JPL&#8217;s RCMED.</p>
+<p><strong>Example Return JSON Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">[</span>
+    <span class="p">{</span>
+        <span class="s2">&quot;dataset_id&quot;</span><span class="o">:</span> <span class="s2">&quot;17&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;shortname&quot;</span><span class="o">:</span> <span class="s2">&quot;The dataset&#39;s short name&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;longname&quot;</span><span class="o">:</span> <span class="s2">&quot;The dataset&#39;s, full name&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;source&quot;</span><span class="o">:</span> <span class="s2">&quot;Where the dataset originated&quot;</span>
+    <span class="p">},</span>
+    <span class="p">...</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--parameters-bounds-">
+<tt class="descname">GET </tt><tt class="descname">/parameters/bounds/</tt><a class="headerlink" href="#get--parameters-bounds-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return temporal and spatial bounds metadata for all of JPL&#8217;s RCMED parameters.</p>
+<p><strong>Example Call Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre>/parameters/bounds/
+</pre></div>
+</div>
+<p><strong>Example Return JSON Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+  <span class="s2">&quot;38&quot;</span><span class="o">:</span> <span class="p">{</span>
+    <span class="s2">&quot;start_date&quot;</span><span class="o">:</span> <span class="s2">&quot;1901-01-15&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;end_date&quot;</span><span class="o">:</span> <span class="s2">&quot;2009-12-15&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;lat_max&quot;</span><span class="o">:</span> <span class="mf">89.75</span><span class="p">,</span>
+    <span class="s2">&quot;lat_min&quot;</span><span class="o">:</span> <span class="o">-</span><span class="mf">89.75</span><span class="p">,</span>
+    <span class="s2">&quot;lon_max&quot;</span><span class="o">:</span> <span class="mf">179.75</span><span class="p">,</span>
+    <span class="s2">&quot;lon_min&quot;</span><span class="o">:</span> <span class="o">-</span><span class="mf">179.75</span>
+  <span class="p">},</span>
+  <span class="s2">&quot;39&quot;</span><span class="o">:</span> <span class="p">{</span>
+    <span class="s2">&quot;start_date&quot;</span><span class="o">:</span> <span class="s2">&quot;1901-01-15&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;end_date&quot;</span><span class="o">:</span> <span class="s2">&quot;2009-12-15&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;lat_max&quot;</span><span class="o">:</span> <span class="mf">89.75</span><span class="p">,</span>
+    <span class="s2">&quot;lat_min&quot;</span><span class="o">:</span> <span class="o">-</span><span class="mf">89.75</span><span class="p">,</span>
+    <span class="s2">&quot;lon_max&quot;</span><span class="o">:</span> <span class="mf">179.75</span><span class="p">,</span>
+    <span class="s2">&quot;lon_min&quot;</span><span class="o">:</span> <span class="o">-</span><span class="mf">179.75</span>
+  <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+</div>
+<div class="section" id="processing-endpoints">
+<h3>Processing Endpoints<a class="headerlink" href="#processing-endpoints" title="Permalink to this headline">¶</a></h3>
+<p>The <em>processing</em> module contains all the endpoints related to the running of
+evaluations.</p>
+<dl class="get">
+<dt id="get--metrics-">
+<tt class="descname">GET </tt><tt class="descname">/metrics/</tt><a class="headerlink" href="#get--metrics-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve available metric names.</p>
+<p><strong>Example Return JSON Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s1">&#39;metrics&#39;</span><span class="o">:</span> <span class="p">[</span>
+        <span class="s1">&#39;MetricName1&#39;</span><span class="p">,</span>
+        <span class="s1">&#39;MetricName2&#39;</span><span class="p">,</span>
+        <span class="p">...</span>
+    <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="post">
+<dt id="post--run_evaluation-">
+<tt class="descname">POST </tt><tt class="descname">/run_evaluation/</tt><a class="headerlink" href="#post--run_evaluation-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Run an OCW Evaluation.</p>
+<p><em>run_evaluation</em> expects the Evaluation parameters to be POSTed in
+the following format.</p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="nx">reference_dataset</span><span class="o">:</span> <span class="p">{</span>
+        <span class="c1">// Id that tells us how we need to load this dataset.</span>
+        <span class="s1">&#39;data_source_id&#39;</span><span class="o">:</span> <span class="mi">1</span> <span class="o">==</span> <span class="nx">local</span><span class="p">,</span> <span class="mi">2</span> <span class="o">==</span> <span class="nx">rcmed</span><span class="p">,</span>
+
+        <span class="c1">// Dict of data_source specific identifying information.</span>
+        <span class="c1">//</span>
+        <span class="c1">// if data_source_id == 1 == local:</span>
+        <span class="c1">// {</span>
+        <span class="c1">//     &#39;id&#39;: The path to the local file on the server for loading.</span>
+        <span class="c1">//     &#39;var_name&#39;: The variable data to pull from the file.</span>
+        <span class="c1">//     &#39;lat_name&#39;: The latitude variable name.</span>
+        <span class="c1">//     &#39;lon_name&#39;: The longitude variable name.</span>
+        <span class="c1">//     &#39;time_name&#39;: The time variable name</span>
+        <span class="c1">//     &#39;name&#39;: Optional dataset name</span>
+        <span class="c1">// }</span>
+        <span class="c1">//</span>
+        <span class="c1">// if data_source_id == 2 == rcmed:</span>
+        <span class="c1">// {</span>
+        <span class="c1">//     &#39;dataset_id&#39;: The dataset id to grab from RCMED.</span>
+        <span class="c1">//     &#39;parameter_id&#39;: The variable id value used by RCMED.</span>
+        <span class="c1">//     &#39;name&#39;: Optional dataset name</span>
+        <span class="c1">// }</span>
+        <span class="s1">&#39;dataset_info&#39;</span><span class="o">:</span> <span class="p">{..}</span>
+    <span class="p">},</span>
+
+    <span class="c1">// The list of target datasets to use in the Evaluation. The data</span>
+    <span class="c1">// format for the dataset objects should be the same as the</span>
+    <span class="c1">// reference_dataset above.</span>
+    <span class="s1">&#39;target_datasets&#39;</span><span class="o">:</span> <span class="p">[{...},</span> <span class="p">{...},</span> <span class="p">...],</span>
+
+    <span class="c1">// All the datasets are re-binned to the reference dataset</span>
+    <span class="c1">// before being added to an experiment. This step (in degrees)</span>
+    <span class="c1">// is used when re-binning both the reference and target datasets.</span>
+    <span class="s1">&#39;spatial_rebin_lat_step&#39;</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">lat</span> <span class="nx">degree</span> <span class="nx">step</span><span class="p">.</span> <span class="nx">Integer</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">,</span>
+
+    <span class="c1">// Same as above, but for lon</span>
+    <span class="s1">&#39;spatial_rebin_lon_step&#39;</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">lon</span> <span class="nx">degree</span> <span class="nx">step</span><span class="p">.</span> <span class="nx">Integer</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">,</span>
+
+    <span class="c1">// The temporal resolution to use when doing a temporal re-bin</span>
+    <span class="c1">// This is a timedelta of days to use so daily == 1, monthly is</span>
+    <span class="c1">// (1, 31], annual/yearly is (31, 366], and full is anything &gt; 366.</span>
+    <span class="s1">&#39;temporal_resolution&#39;</span><span class="o">:</span> <span class="nx">Integer</span> <span class="k">in</span> <span class="nx">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">999</span><span class="p">),</span>
+
+    <span class="c1">// A list of the metric class names to use in the evaluation. The</span>
+    <span class="c1">// names must match the class name exactly.</span>
+    <span class="s1">&#39;metrics&#39;</span><span class="o">:</span> <span class="p">[</span><span class="nx">Bias</span><span class="p">,</span> <span class="nx">TemporalStdDev</span><span class="p">,</span> <span class="p">...]</span>
+
+    <span class="c1">// The bounding values used in the Evaluation. Note that lat values</span>
+    <span class="c1">// should range from -180 to 180 and lon values from -90 to 90.</span>
+    <span class="s1">&#39;start_time&#39;</span><span class="o">:</span> <span class="nx">start</span> <span class="nx">time</span> <span class="nx">value</span> <span class="k">in</span> <span class="nx">the</span> <span class="nx">format</span> <span class="s1">&#39;%Y-%m-%d %H:%M:%S&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;end_time&#39;</span><span class="o">:</span> <span class="nx">end</span> <span class="nx">time</span> <span class="nx">value</span> <span class="k">in</span> <span class="nx">the</span> <span class="nx">format</span> <span class="s1">&#39;%Y-%m-%d %H:%M:%S&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;lat_min&#39;</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">minimum</span> <span class="nx">latitude</span> <span class="nx">value</span><span class="p">,</span>
+    <span class="s1">&#39;lat_max&#39;</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">maximum</span> <span class="nx">latitude</span> <span class="nx">value</span><span class="p">,</span>
+    <span class="s1">&#39;lon_min&#39;</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">minimum</span> <span class="nx">longitude</span> <span class="nx">value</span><span class="p">,</span>
+    <span class="s1">&#39;lon_max&#39;</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">maximum</span> <span class="nx">longitude</span> <span class="nx">value</span><span class="p">,</span>
+
+    <span class="c1">// NOTE: At the moment, subregion support is fairly minimal. This</span>
+    <span class="c1">// will be addressed in the future. Ideally, the user should be able</span>
+    <span class="c1">// to load a file that they have locally. That would change the</span>
+    <span class="c1">// format that this data is passed.</span>
+    <span class="s1">&#39;subregion_information&#39;</span><span class="o">:</span> <span class="nx">Path</span> <span class="nx">to</span> <span class="nx">a</span> <span class="nx">subregion</span> <span class="nx">file</span> <span class="nx">on</span> <span class="nx">the</span> <span class="nx">server</span><span class="p">.</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+</div>
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Evaluation UI Webservices</a><ul>
+<li><a class="reference internal" href="#configuration-and-dependencies">Configuration and Dependencies</a></li>
+<li><a class="reference internal" href="#web-service-explanation">Web Service Explanation</a><ul>
+<li><a class="reference internal" href="#local-file-metadata-extractors">Local File Metadata Extractors</a></li>
+<li><a class="reference internal" href="#directory-helpers">Directory Helpers</a></li>
+<li><a class="reference internal" href="#rcmed-helpers">RCMED Helpers</a></li>
+<li><a class="reference internal" href="#processing-endpoints">Processing Endpoints</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="../data_source/data_sources.html"
+                        title="previous chapter">Data Sources</a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../_sources/ui-backend/backend.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
+  <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="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >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"
+             >previous</a> |</li>
+        <li><a href="../index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2013, Michael Joyce.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
+    </div>
+  </body>
+</html>
\ No newline at end of file


Mime
View raw message