climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r1029317 [12/12] - in /websites/staging/climate/trunk/content: ./ api/current/ api/current/_sources/ api/current/_sources/config/ api/current/_sources/data_source/ api/current/_sources/ocw/ api/current/_sources/ui-backend/ api/current/_stat...
Date Wed, 02 May 2018 18:42:26 GMT
Modified: websites/staging/climate/trunk/content/api/current/ui-backend/backend.html
==============================================================================
--- websites/staging/climate/trunk/content/api/current/ui-backend/backend.html (original)
+++ websites/staging/climate/trunk/content/api/current/ui-backend/backend.html Wed May  2 18:42:25 2018
@@ -1,23 +1,21 @@
+
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
-
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    
-    <title>Evaluation UI Webservices &#8212; Apache Open Climate Workbench 1.2.0 documentation</title>
-    
+    <title>Evaluation UI Webservices &#8212; Apache Open Climate Workbench 1.3.0 documentation</title>
     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '1.2.0',
+        VERSION:     '1.3.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
       };
     </script>
     <script type="text/javascript" src="../_static/jquery.js"></script>
@@ -25,7 +23,6 @@
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="top" title="Apache Open Climate Workbench 1.2.0 documentation" href="../index.html" />
     <link rel="next" title="Configuration File Overview" href="../config/config_overview.html" />
     <link rel="prev" title="Data Sources" href="../data_source/data_sources.html" />
    
@@ -35,7 +32,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head>
-  <body role="document">
+  <body>
   
 
     <div class="document">
@@ -51,7 +48,7 @@ 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
+function properly. Please check the toolkit’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-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">bottle</span>
@@ -93,7 +90,7 @@ a user wishes to <em>load</em> a local f
 <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
+<li><strong>file_path</strong> (<em>string:</em>) – Path to the NetCDF file from which lat/lon information
 should be extracted</li>
 </ul>
 </td>
@@ -134,7 +131,7 @@ failure information is returned.</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>file_path</strong> (<em>String:</em>) &#8211; Path to the NetCDF file from which time information
+<li><strong>file_path</strong> (<em>String:</em>) – Path to the NetCDF file from which time information
 should be extracted</li>
 </ul>
 </td>
@@ -172,7 +169,7 @@ failure information is returned.</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>file_path</strong> (<em>String:</em>) &#8211; Path to the NetCDF file from which variable information
+<li><strong>file_path</strong> (<em>String:</em>) – Path to the NetCDF file from which variable information
 should be extracted</li>
 </ul>
 </td>
@@ -214,7 +211,7 @@ information, and other things.</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>dir_path</strong> (<em>String</em>) &#8211; The directory path to list.</li>
+<li><strong>dir_path</strong> (<em>String</em>) – The directory path to list.</li>
 </ul>
 </td>
 </tr>
@@ -248,7 +245,7 @@ information, and other things.</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>dir_path</strong> (<em>String</em>) &#8211; The directory path to list.</li>
+<li><strong>dir_path</strong> (<em>String</em>) – The directory path to list.</li>
 </ul>
 </td>
 </tr>
@@ -277,9 +274,9 @@ information, and other things.</p>
 <dt id="get--results-">
 <code class="descname">GET </code><code class="descname">/results/</code><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 
+<p>The backend’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>
+not exist, an empty listing will be returned (shown as a ‘failure below’).</p>
 <p><strong>Successful JSON Response</strong></p>
 <div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
     <span class="s1">&#39;listing&#39;</span><span class="o">:</span> <span class="p">[</span>
@@ -306,11 +303,11 @@ not exist, an empty listing will be retu
 <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>
+<li><strong>dir_path</strong> (<em>String</em>) – 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>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary of the requested result’s directory listing.</p>
 </td>
 </tr>
 </tbody>
@@ -346,11 +343,11 @@ not exist, an empty listing will be retu
 <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>
+Regional Climate Model Evaluation Database at NASA’s Jet Propulsion Laboratory.</p>
 <dl class="get">
 <dt id="get--datasets-">
 <code class="descname">GET </code><code class="descname">/datasets/</code><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>
+<dd><p>Return a list of dataset information from JPL’s RCMED.</p>
 <p><strong>Example Return JSON Format</strong></p>
 <div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">[</span>
     <span class="p">{</span>
@@ -366,11 +363,11 @@ Regional Climate Model Evaluation Databa
 </dd></dl>
 
 <dl class="get">
-<dt id="get--parameters-">
-<code class="descname">GET </code><code class="descname">/parameters/</code><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>
+<dt id="get--parameters-dataset-(name)">
+<code class="descname">GET </code><code class="descname">/parameters/dataset/</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#get--parameters-dataset-(name)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return dataset specific parameter information from JPL’s RCMED.</p>
 <p><strong>Example Call Format</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span></span>/parameters/?dataset=&lt;dataset&#39;s short name&gt;
+<div class="highlight-text"><div class="highlight"><pre><span></span>/parameters/?dataset=&lt;dataset&#39;s short name&gt;
 </pre></div>
 </div>
 <p><strong>Example Return JSON Format</strong></p>
@@ -390,9 +387,9 @@ Regional Climate Model Evaluation Databa
 <dl class="get">
 <dt id="get--parameters-bounds">
 <code class="descname">GET </code><code class="descname">/parameters/bounds</code><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>
+<dd><p>Return temporal and spatial bounds metadata for all of JPL’s RCMED parameters.</p>
 <p><strong>Example Call Format</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span></span>/parameters/bounds/
+<div class="highlight-text"><div class="highlight"><pre><span></span>/parameters/bounds/
 </pre></div>
 </div>
 <p><strong>Example Return JSON Format</strong></p>
@@ -421,9 +418,9 @@ Regional Climate Model Evaluation Databa
 <dl class="get">
 <dt id="get--parameters-bounds-">
 <code class="descname">GET </code><code class="descname">/parameters/bounds/</code><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>
+<dd><p>Return temporal and spatial bounds metadata for all of JPL’s RCMED parameters.</p>
 <p><strong>Example Call Format</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span></span>/parameters/bounds/
+<div class="highlight-text"><div class="highlight"><pre><span></span>/parameters/bounds/
 </pre></div>
 </div>
 <p><strong>Example Return JSON Format</strong></p>
@@ -460,11 +457,11 @@ evaluations.</p>
 <dd><p>Retrieve available metric names.</p>
 <p><strong>Example Return JSON Format</strong></p>
 <div class="highlight-javascript"><div class="highlight"><pre><span></span><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="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>
@@ -477,67 +474,67 @@ evaluations.</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></span><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="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>
@@ -550,67 +547,67 @@ the following format.</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></span><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="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>
@@ -655,7 +652,7 @@ the following format.</p>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
-      <li><a href="../_sources/ui-backend/backend.txt"
+      <li><a href="../_sources/ui-backend/backend.rst.txt"
             rel="nofollow">Show Source</a></li>
     </ul>
    </div>
@@ -674,14 +671,14 @@ the following format.</p>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2016, Apache Software Foundation.
+      &copy;2017, Apache Software Foundation.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.4</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
       
       |
-      <a href="../_sources/ui-backend/backend.txt"
+      <a href="../_sources/ui-backend/backend.rst.txt"
           rel="nofollow">Page source</a>
     </div>
 



Mime
View raw message