You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@climate.apache.org by bu...@apache.org on 2017/04/24 21:37:04 UTC
svn commit: r1011072 [17/17] - in /websites/staging/climate/trunk/content:
./ api/1.1.0/ api/1.1.0/_sources/ api/1.1.0/_sources/config/
api/1.1.0/_sources/data_source/ api/1.1.0/_sources/ocw/
api/1.1.0/_sources/ui-backend/ api/1.1.0/_static/ api/1.1.0/...
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 Mon Apr 24 21:37:01 2017
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Evaluation UI Webservices — Apache Open Climate Workbench 1.1.0 documentation</title>
+ <title>Evaluation UI Webservices — Apache Open Climate Workbench 1.2.0 documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
- VERSION: '1.1.0',
+ VERSION: '1.2.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@@ -23,36 +23,20 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="../index.html" />
+ <link rel="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" />
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
- <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
- <div class="related" role="navigation" aria-label="related navigation">
- <h3>Navigation</h3>
- <ul>
- <li class="right" style="margin-right: 10px">
- <a href="../genindex.html" title="General Index"
- accesskey="I">index</a></li>
- <li class="right" >
- <a href="../http-routingtable.html" title="HTTP Routing Table"
- >routing table</a> |</li>
- <li class="right" >
- <a href="../py-modindex.html" title="Python Module Index"
- >modules</a> |</li>
- <li class="right" >
- <a href="../config/config_overview.html" title="Configuration File Overview"
- accesskey="N">next</a> |</li>
- <li class="right" >
- <a href="../data_source/data_sources.html" title="Data Sources"
- accesskey="P">previous</a> |</li>
- <li class="nav-item nav-item-0"><a href="../index.html">Apache Open Climate Workbench 1.1.0 documentation</a> »</li>
- </ul>
- </div>
+
<div class="document">
<div class="documentwrapper">
@@ -70,7 +54,7 @@ of the Bottle Web Framework.</p>
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-python"><div class="highlight"><pre>pip install bottle
+<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>
</pre></div>
</div>
<p>The backend serves the static files for the evaluation frontend as well. If you
@@ -78,12 +62,12 @@ plan to use the frontend you need to ens
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
+<div class="code highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">ocw</span><span class="o">-</span><span class="n">ui</span><span class="o">/</span><span class="n">backend</span>
+<span class="n">ln</span> <span class="o">-</span><span class="n">s</span> <span class="o">../</span><span class="n">frontend</span><span class="o">/</span><span class="n">app</span> <span class="n">app</span>
</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
+<div class="code highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">run_webservices</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
</div>
@@ -121,7 +105,7 @@ failure information is returned.</p>
</tbody>
</table>
<p><strong>Example successful JSON return</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s1">'success'</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
<span class="s1">'lat_name'</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">'lon_name'</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>
@@ -133,9 +117,9 @@ failure information is returned.</p>
</pre></div>
</div>
<p><strong>Example failure JSON return</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s1">'success'</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
- <span class="s1">'variables'</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="s1">'variables'</span><span class="o">:</span> <span class="nx">List</span> <span class="k">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>
@@ -162,7 +146,7 @@ failure information is returned.</p>
</tbody>
</table>
<p><strong>Example successful JSON return</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"success"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
<span class="s2">"time_name"</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">"start_time"</span><span class="o">:</span> <span class="s2">"1988-06-10 00:00:00"</span><span class="p">,</span>
@@ -171,9 +155,9 @@ failure information is returned.</p>
</pre></div>
</div>
<p><strong>Example failure JSON return</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"success"</span><span class="o">:</span> <span class="kc">false</span>
- <span class="s2">"variables"</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="s2">"variables"</span><span class="o">:</span> <span class="nx">List</span> <span class="k">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>
@@ -200,14 +184,14 @@ failure information is returned.</p>
</tbody>
</table>
<p><strong>Example successful JSON return</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"success"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
- <span class="s2">"variables"</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="s2">"variables"</span><span class="o">:</span> <span class="nx">List</span> <span class="k">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>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"success"</span><span class="o">:</span> <span class="kc">false</span>
<span class="p">}</span>
</pre></div>
@@ -240,7 +224,7 @@ information, and other things.</p>
</tbody>
</table>
<p><strong>Example successful JSON return</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s1">'listing'</span><span class="o">:</span> <span class="p">[</span>
<span class="s1">'/bar/'</span><span class="p">,</span>
<span class="s1">'/baz.txt'</span><span class="p">,</span>
@@ -250,7 +234,7 @@ information, and other things.</p>
</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">'listing'</span><span class="o">:</span> <span class="p">[]}</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">'listing'</span><span class="o">:</span> <span class="p">[]}</span>
</pre></div>
</div>
</dd></dl>
@@ -274,7 +258,7 @@ information, and other things.</p>
</tbody>
</table>
<p><strong>Example successful JSON return</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s1">'listing'</span><span class="o">:</span> <span class="p">[</span>
<span class="s1">'/bar/'</span><span class="p">,</span>
<span class="s1">'/baz.txt'</span><span class="p">,</span>
@@ -284,7 +268,7 @@ information, and other things.</p>
</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">'listing'</span><span class="o">:</span> <span class="p">[]}</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">'listing'</span><span class="o">:</span> <span class="p">[]}</span>
</pre></div>
</div>
</dd></dl>
@@ -297,7 +281,7 @@ information, and other things.</p>
directories there are formatted and returned as results. If WORK_DIR does
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 class="p">{</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s1">'listing'</span><span class="o">:</span> <span class="p">[</span>
<span class="s1">'/bar'</span><span class="p">,</span>
<span class="s1">'/foo'</span>
@@ -306,7 +290,7 @@ not exist, an empty listing will be retu
</pre></div>
</div>
<p><strong>Failure JSON Response</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s1">'listing'</span><span class="o">:</span> <span class="p">[]</span>
<span class="p">}</span>
</pre></div>
@@ -332,7 +316,7 @@ not exist, an empty listing will be retu
</tbody>
</table>
<p><strong>Successful JSON Response</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s1">'listing'</span><span class="o">:</span> <span class="p">[</span>
<span class="s1">'file1'</span><span class="p">,</span>
<span class="s1">'file2'</span>
@@ -341,7 +325,7 @@ not exist, an empty listing will be retu
</pre></div>
</div>
<p><strong>Failure JSON Response</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s1">'listing'</span><span class="o">:</span> <span class="p">[]</span>
<span class="p">}</span>
</pre></div>
@@ -353,7 +337,7 @@ not exist, an empty listing will be retu
<code class="descname">GET </code><code class="descname">/path_leader/</code><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">'leader'</span><span class="o">:</span> <span class="s1">'/usr/local/ocw'</span><span class="p">}</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">'leader'</span><span class="o">:</span> <span class="s1">'/usr/local/ocw'</span><span class="p">}</span>
</pre></div>
</div>
</dd></dl>
@@ -368,7 +352,7 @@ Regional Climate Model Evaluation Databa
<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’s RCMED.</p>
<p><strong>Example Return JSON Format</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span class="p">[</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">[</span>
<span class="p">{</span>
<span class="s2">"dataset_id"</span><span class="o">:</span> <span class="s2">"17"</span><span class="p">,</span>
<span class="s2">"shortname"</span><span class="o">:</span> <span class="s2">"The dataset's short name"</span><span class="p">,</span>
@@ -386,11 +370,11 @@ Regional Climate Model Evaluation Databa
<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’s RCMED.</p>
<p><strong>Example Call Format</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre>/parameters/?dataset=<dataset's short name>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span>/parameters/?dataset=<dataset's short name>
</pre></div>
</div>
<p><strong>Example Return JSON Format</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre><span class="p">[</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">[</span>
<span class="p">{</span>
<span class="s2">"parameter_id"</span><span class="o">:</span> <span class="s2">"80"</span><span class="p">,</span>
<span class="s2">"shortname"</span><span class="o">:</span> <span class="s2">"The dataset's short name"</span><span class="p">,</span>
@@ -408,11 +392,11 @@ Regional Climate Model Evaluation Databa
<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’s RCMED parameters.</p>
<p><strong>Example Call Format</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre>/parameters/bounds/
+<div class="highlight-javascript"><div class="highlight"><pre><span></span>/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>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"38"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"start_date"</span><span class="o">:</span> <span class="s2">"1901-01-15"</span><span class="p">,</span>
<span class="s2">"end_date"</span><span class="o">:</span> <span class="s2">"2009-12-15"</span><span class="p">,</span>
@@ -439,11 +423,11 @@ Regional Climate Model Evaluation Databa
<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’s RCMED parameters.</p>
<p><strong>Example Call Format</strong></p>
-<div class="highlight-javascript"><div class="highlight"><pre>/parameters/bounds/
+<div class="highlight-javascript"><div class="highlight"><pre><span></span>/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>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"38"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"start_date"</span><span class="o">:</span> <span class="s2">"1901-01-15"</span><span class="p">,</span>
<span class="s2">"end_date"</span><span class="o">:</span> <span class="s2">"2009-12-15"</span><span class="p">,</span>
@@ -475,12 +459,12 @@ evaluations.</p>
<code class="descname">GET </code><code class="descname">/metrics/</code><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">'metrics'</span><span class="o">:</span> <span class="p">[</span>
- <span class="s1">'MetricName1'</span><span class="p">,</span>
- <span class="s1">'MetricName2'</span><span class="p">,</span>
- <span class="p">...</span>
- <span class="p">]</span>
+<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s1">'metrics'</span><span class="o">:</span> <span class="p">[</span>
+ <span class="s1">'MetricName1'</span><span class="p">,</span>
+ <span class="s1">'MetricName2'</span><span class="p">,</span>
+ <span class="p">...</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -492,68 +476,68 @@ evaluations.</p>
<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">'data_source_id'</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">// 'id': The path to the local file on the server for loading.</span>
- <span class="c1">// 'var_name': The variable data to pull from the file.</span>
- <span class="c1">// 'lat_name': The latitude variable name.</span>
- <span class="c1">// 'lon_name': The longitude variable name.</span>
- <span class="c1">// 'time_name': The time variable name</span>
- <span class="c1">// 'name': 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">// 'dataset_id': The dataset id to grab from RCMED.</span>
- <span class="c1">// 'parameter_id': The variable id value used by RCMED.</span>
- <span class="c1">// 'name': Optional dataset name</span>
- <span class="c1">// }</span>
- <span class="s1">'dataset_info'</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">'target_datasets'</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">'spatial_rebin_lat_step'</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">></span> <span class="mi">0</span><span class="p">,</span>
-
- <span class="c1">// Same as above, but for lon</span>
- <span class="s1">'spatial_rebin_lon_step'</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">></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 > 366.</span>
- <span class="s1">'temporal_resolution'</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">'metrics'</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">'start_time'</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">'%Y-%m-%d %H:%M:%S'</span><span class="p">,</span>
- <span class="s1">'end_time'</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">'%Y-%m-%d %H:%M:%S'</span><span class="p">,</span>
- <span class="s1">'lat_min'</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">'lat_max'</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">'lon_min'</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">'lon_max'</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">'subregion_information'</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>
+<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">'data_source_id'</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">// 'id': The path to the local file on the server for loading.</span>
+ <span class="c1">// 'var_name': The variable data to pull from the file.</span>
+ <span class="c1">// 'lat_name': The latitude variable name.</span>
+ <span class="c1">// 'lon_name': The longitude variable name.</span>
+ <span class="c1">// 'time_name': The time variable name</span>
+ <span class="c1">// 'name': 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">// 'dataset_id': The dataset id to grab from RCMED.</span>
+ <span class="c1">// 'parameter_id': The variable id value used by RCMED.</span>
+ <span class="c1">// 'name': Optional dataset name</span>
+ <span class="c1">// }</span>
+ <span class="s1">'dataset_info'</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">'target_datasets'</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">'spatial_rebin_lat_step'</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">></span> <span class="mi">0</span><span class="p">,</span>
+
+ <span class="c1">// Same as above, but for lon</span>
+ <span class="s1">'spatial_rebin_lon_step'</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">></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 > 366.</span>
+ <span class="s1">'temporal_resolution'</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">'metrics'</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">'start_time'</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">'%Y-%m-%d %H:%M:%S'</span><span class="p">,</span>
+ <span class="s1">'end_time'</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">'%Y-%m-%d %H:%M:%S'</span><span class="p">,</span>
+ <span class="s1">'lat_min'</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">'lat_max'</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">'lon_min'</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">'lon_max'</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">'subregion_information'</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>
@@ -565,68 +549,68 @@ the following format.</p>
<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">'data_source_id'</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">// 'id': The path to the local file on the server for loading.</span>
- <span class="c1">// 'var_name': The variable data to pull from the file.</span>
- <span class="c1">// 'lat_name': The latitude variable name.</span>
- <span class="c1">// 'lon_name': The longitude variable name.</span>
- <span class="c1">// 'time_name': The time variable name</span>
- <span class="c1">// 'name': 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">// 'dataset_id': The dataset id to grab from RCMED.</span>
- <span class="c1">// 'parameter_id': The variable id value used by RCMED.</span>
- <span class="c1">// 'name': Optional dataset name</span>
- <span class="c1">// }</span>
- <span class="s1">'dataset_info'</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">'target_datasets'</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">'spatial_rebin_lat_step'</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">></span> <span class="mi">0</span><span class="p">,</span>
-
- <span class="c1">// Same as above, but for lon</span>
- <span class="s1">'spatial_rebin_lon_step'</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">></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 > 366.</span>
- <span class="s1">'temporal_resolution'</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">'metrics'</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">'start_time'</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">'%Y-%m-%d %H:%M:%S'</span><span class="p">,</span>
- <span class="s1">'end_time'</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">'%Y-%m-%d %H:%M:%S'</span><span class="p">,</span>
- <span class="s1">'lat_min'</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">'lat_max'</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">'lon_min'</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">'lon_max'</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">'subregion_information'</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>
+<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">'data_source_id'</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">// 'id': The path to the local file on the server for loading.</span>
+ <span class="c1">// 'var_name': The variable data to pull from the file.</span>
+ <span class="c1">// 'lat_name': The latitude variable name.</span>
+ <span class="c1">// 'lon_name': The longitude variable name.</span>
+ <span class="c1">// 'time_name': The time variable name</span>
+ <span class="c1">// 'name': 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">// 'dataset_id': The dataset id to grab from RCMED.</span>
+ <span class="c1">// 'parameter_id': The variable id value used by RCMED.</span>
+ <span class="c1">// 'name': Optional dataset name</span>
+ <span class="c1">// }</span>
+ <span class="s1">'dataset_info'</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">'target_datasets'</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">'spatial_rebin_lat_step'</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">></span> <span class="mi">0</span><span class="p">,</span>
+
+ <span class="c1">// Same as above, but for lon</span>
+ <span class="s1">'spatial_rebin_lon_step'</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">></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 > 366.</span>
+ <span class="s1">'temporal_resolution'</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">'metrics'</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">'start_time'</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">'%Y-%m-%d %H:%M:%S'</span><span class="p">,</span>
+ <span class="s1">'end_time'</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">'%Y-%m-%d %H:%M:%S'</span><span class="p">,</span>
+ <span class="s1">'lat_min'</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">'lat_max'</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">'lon_min'</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">'lon_max'</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">'subregion_information'</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>
@@ -659,13 +643,15 @@ the following format.</p>
</ul>
</li>
</ul>
-
- <h4>Previous topic</h4>
- <p class="topless"><a href="../data_source/data_sources.html"
- title="previous chapter">Data Sources</a></p>
- <h4>Next topic</h4>
- <p class="topless"><a href="../config/config_overview.html"
- title="next chapter">Configuration File Overview</a></p>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="../data_source/data_sources.html" title="previous chapter">Data Sources</a></li>
+ <li>Next: <a href="../config/config_overview.html" title="next chapter">Configuration File Overview</a></li>
+ </ul></li>
+</ul>
+</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
@@ -676,14 +662,11 @@ the following format.</p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
- <input type="text" name="q" />
- <input type="submit" value="Go" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
@@ -694,12 +677,12 @@ the following format.</p>
©2016, Apache Software Foundation.
|
- Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
- & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.4</a>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
|
<a href="../_sources/ui-backend/backend.txt"
- rel="nofollow">Page source</a></li>
+ rel="nofollow">Page source</a>
</div>