You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@climate.apache.org by le...@apache.org on 2017/04/24 21:36:18 UTC
svn commit: r1792548 [11/17] - in /climate/site/trunk/content/api: 1.1.0/
1.1.0/_sources/ 1.1.0/_sources/config/ 1.1.0/_sources/data_source/
1.1.0/_sources/ocw/ 1.1.0/_sources/ui-backend/ 1.1.0/_static/ 1.1.0/config/
1.1.0/data_source/ 1.1.0/ocw/ 1.1.0...
Modified: climate/site/trunk/content/api/current/_static/searchtools.js
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/_static/searchtools.js?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/_static/searchtools.js (original)
+++ climate/site/trunk/content/api/current/_static/searchtools.js Mon Apr 24 21:36:16 2017
@@ -2,14 +2,15 @@
* searchtools.js_t
* ~~~~~~~~~~~~~~~~
*
- * Sphinx JavaScript utilties for the full-text search.
+ * Sphinx JavaScript utilities for the full-text search.
*
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
+/* Non-minified version JS is _stemmer.js if file is provided */
/**
* Porter Stemmer
*/
@@ -323,7 +324,7 @@ var Search = {
var searchterms = [];
var excluded = [];
var hlterms = [];
- var tmp = query.split(/\s+/);
+ var tmp = query.split(/\W+/);
var objectterms = [];
for (i = 0; i < tmp.length; i++) {
if (tmp[i] !== "") {
@@ -373,8 +374,7 @@ var Search = {
}
// lookup as search terms in fulltext
- results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term))
- .concat(this.performTermsSearch(searchterms, excluded, titleterms, Scorer.title));
+ results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
// let the scorer override scores with a custom scoring function
if (Scorer.score) {
@@ -538,23 +538,47 @@ var Search = {
/**
* search for full-text terms in the index
*/
- performTermsSearch : function(searchterms, excluded, terms, score) {
+ performTermsSearch : function(searchterms, excluded, terms, titleterms) {
var filenames = this._index.filenames;
var titles = this._index.titles;
- var i, j, file, files;
+ var i, j, file;
var fileMap = {};
+ var scoreMap = {};
var results = [];
// perform the search on the required terms
for (i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
+ var files = [];
+ var _o = [
+ {files: terms[word], score: Scorer.term},
+ {files: titleterms[word], score: Scorer.title}
+ ];
+
// no match but word was a required one
- if ((files = terms[word]) === undefined)
+ if ($u.every(_o, function(o){return o.files === undefined;})) {
break;
- if (files.length === undefined) {
- files = [files];
}
+ // found search word in contents
+ $u.each(_o, function(o) {
+ var _files = o.files;
+ if (_files === undefined)
+ return
+
+ if (_files.length === undefined)
+ _files = [_files];
+ files = files.concat(_files);
+
+ // set score for the word in each file to Scorer.term
+ for (j = 0; j < _files.length; j++) {
+ file = _files[j];
+ if (!(file in scoreMap))
+ scoreMap[file] = {}
+ scoreMap[file][word] = o.score;
+ }
+ });
+
// create the mapping
for (j = 0; j < files.length; j++) {
file = files[j];
@@ -576,7 +600,9 @@ var Search = {
// ensure that none of the excluded terms is in the search result
for (i = 0; i < excluded.length; i++) {
if (terms[excluded[i]] == file ||
- $u.contains(terms[excluded[i]] || [], file)) {
+ titleterms[excluded[i]] == file ||
+ $u.contains(terms[excluded[i]] || [], file) ||
+ $u.contains(titleterms[excluded[i]] || [], file)) {
valid = false;
break;
}
@@ -584,6 +610,9 @@ var Search = {
// if we have still a valid result we can add it to the result list
if (valid) {
+ // select one (max) score for the file.
+ // for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
+ var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
results.push([filenames[file], titles[file], '', null, score]);
}
}
@@ -594,7 +623,7 @@ var Search = {
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
- * words. the first one is used to find the occurance, the
+ * words. the first one is used to find the occurrence, the
* latter for highlighting it.
*/
makeSearchSummary : function(text, keywords, hlwords) {
Modified: climate/site/trunk/content/api/current/_static/websupport.js
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/_static/websupport.js?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/_static/websupport.js (original)
+++ climate/site/trunk/content/api/current/_static/websupport.js Mon Apr 24 21:36:16 2017
@@ -2,9 +2,9 @@
* websupport.js
* ~~~~~~~~~~~~~
*
- * sphinx.websupport utilties for all documentation.
+ * sphinx.websupport utilities for all documentation.
*
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Modified: climate/site/trunk/content/api/current/config/config_overview.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/config/config_overview.html?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/config/config_overview.html (original)
+++ climate/site/trunk/content/api/current/config/config_overview.html Mon Apr 24 21:36:16 2017
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Configuration File Overview — Apache Open Climate Workbench 1.1.0 documentation</title>
+ <title>Configuration File Overview — 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 Writer API" href="config_writer.html" />
<link rel="prev" title="Evaluation UI Webservices" href="../ui-backend/backend.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_writer.html" title="Configuration File Writer API"
- accesskey="N">next</a> |</li>
- <li class="right" >
- <a href="../ui-backend/backend.html" title="Evaluation UI Webservices"
- 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">
@@ -65,7 +49,7 @@
<div class="section" id="getting-started">
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
<p>OCW configuration files are written in <a class="reference external" href="http://yaml.org/">YAML</a> with type annotations that are supported by the <a class="reference external" href="http://pyyaml.org/wiki/PyYAMLDocumentation">PyYAML library</a>. Let’s look at an example configuration file to get started.</p>
-<div class="code highlight-python"><div class="highlight"><pre>evaluation:
+<div class="code highlight-default"><div class="highlight"><pre><span></span>evaluation:
temporal_time_delta: 365
spatial_regrid_lats: !!python/tuple [-20, 20, 1]
spatial_regrid_lons: !!python/tuple [-20, 20, 1]
@@ -106,24 +90,24 @@ plots:
</div>
<div class="section" id="evaluation-settings">
<h2>Evaluation Settings<a class="headerlink" href="#evaluation-settings" title="Permalink to this headline">¶</a></h2>
-<p>This is where you will set evaluation specific settings such as temporal and spatial bin sizes to use during dataset preparation. Visit the <a class="reference internal" href="evaluation_settings.html"><em>Evaluation Settings</em></a> page for additional information.</p>
+<p>This is where you will set evaluation specific settings such as temporal and spatial bin sizes to use during dataset preparation. Visit the <a class="reference internal" href="evaluation_settings.html"><span class="doc">Evaluation Settings</span></a> page for additional information.</p>
</div>
<div class="section" id="dataset-information">
<h2>Dataset Information<a class="headerlink" href="#dataset-information" title="Permalink to this headline">¶</a></h2>
-<p>The datasets section is where you specify all the datasets to use for an evaluation. You can specify what the reference dataset should be as well as giving a list of target datasets. Visit the <a class="reference internal" href="dataset_information.html"><em>Dataset Information</em></a> page for additional information.</p>
+<p>The datasets section is where you specify all the datasets to use for an evaluation. You can specify what the reference dataset should be as well as giving a list of target datasets. Visit the <a class="reference internal" href="dataset_information.html"><span class="doc">Dataset Information</span></a> page for additional information.</p>
</div>
<div class="section" id="metrics-information">
<h2>Metrics Information<a class="headerlink" href="#metrics-information" title="Permalink to this headline">¶</a></h2>
-<p>You will need to load some metrics if you want to get anything useful out of your evaluation. Visit the <a class="reference internal" href="metrics_information.html"><em>Metrics Information</em></a> page to learn how to specify the metrics that should be used in the evaluation.</p>
+<p>You will need to load some metrics if you want to get anything useful out of your evaluation. Visit the <a class="reference internal" href="metrics_information.html"><span class="doc">Metrics Information</span></a> page to learn how to specify the metrics that should be used in the evaluation.</p>
</div>
<div class="section" id="plots-settings">
<h2>Plots Settings<a class="headerlink" href="#plots-settings" title="Permalink to this headline">¶</a></h2>
-<p>This is where you specify what plots to make after running the evaluation. The <a class="reference internal" href="plots_settings.html"><em>Plots Settings</em></a> page provides examples for the supported plot types.</p>
+<p>This is where you specify what plots to make after running the evaluation. The <a class="reference internal" href="plots_settings.html"><span class="doc">Plots Settings</span></a> page provides examples for the supported plot types.</p>
</div>
<div class="section" id="example-run">
<h2>Example Run<a class="headerlink" href="#example-run" title="Permalink to this headline">¶</a></h2>
<p>If you have tried the <strong>simple_model_to_model_bias.py</strong> example in the primary toolkit examples you can run the same evaluation but use a config file to do so instead of direct API scripting. From the <strong>climate/ocw-config-runner/</strong> directory run the following command to run the example:</p>
-<div class="highlight-python"><div class="highlight"><pre>python ocw_evaluation_from_config.py example/simple_model_to_model_bias.yaml
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">ocw_evaluation_from_config</span><span class="o">.</span><span class="n">py</span> <span class="n">example</span><span class="o">/</span><span class="n">simple_model_to_model_bias</span><span class="o">.</span><span class="n">yaml</span>
</pre></div>
</div>
<div class="admonition note">
@@ -133,7 +117,7 @@ plots:
</div>
<div class="section" id="writing-a-config-file">
<h2>Writing a Config File<a class="headerlink" href="#writing-a-config-file" title="Permalink to this headline">¶</a></h2>
-<p>You can export an <a class="reference internal" href="../ocw/evaluation.html#evaluation.Evaluation" title="evaluation.Evaluation"><code class="xref py py-class docutils literal"><span class="pre">evaluation.Evaluation</span></code></a> object to a configuration file for easily repeatable evaluations. Checkout the documentation on the <a class="reference internal" href="config_writer.html"><em>configuration file writer API</em></a> for additional information.</p>
+<p>You can export an <a class="reference internal" href="../ocw/evaluation.html#evaluation.Evaluation" title="evaluation.Evaluation"><code class="xref py py-class docutils literal"><span class="pre">evaluation.Evaluation</span></code></a> object to a configuration file for easily repeatable evaluations. Checkout the documentation on the <a class="reference internal" href="config_writer.html"><span class="doc">configuration file writer API</span></a> for additional information.</p>
</div>
</div>
@@ -159,13 +143,15 @@ plots:
</ul>
</li>
</ul>
-
- <h4>Previous topic</h4>
- <p class="topless"><a href="../ui-backend/backend.html"
- title="previous chapter">Evaluation UI Webservices</a></p>
- <h4>Next topic</h4>
- <p class="topless"><a href="config_writer.html"
- title="next chapter">Configuration File Writer API</a></p>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="../ui-backend/backend.html" title="previous chapter">Evaluation UI Webservices</a></li>
+ <li>Next: <a href="config_writer.html" title="next chapter">Configuration File Writer API</a></li>
+ </ul></li>
+</ul>
+</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
@@ -176,14 +162,11 @@ plots:
<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>
@@ -194,12 +177,12 @@ plots:
©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/config/config_overview.txt"
- rel="nofollow">Page source</a></li>
+ rel="nofollow">Page source</a>
</div>
Modified: climate/site/trunk/content/api/current/config/config_writer.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/config/config_writer.html?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/config/config_writer.html (original)
+++ climate/site/trunk/content/api/current/config/config_writer.html Mon Apr 24 21:36:16 2017
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Configuration File Writer API — Apache Open Climate Workbench 1.1.0 documentation</title>
+ <title>Configuration File Writer API — 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="Dataset Information" href="dataset_information.html" />
<link rel="prev" title="Configuration File Overview" href="config_overview.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="dataset_information.html" title="Dataset Information"
- accesskey="N">next</a> |</li>
- <li class="right" >
- <a href="config_overview.html" title="Configuration File Overview"
- 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">
@@ -71,7 +55,7 @@
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>evaluation</strong> (<a class="reference internal" href="../ocw/evaluation.html#evaluation.Evaluation" title="evaluation.Evaluation"><code class="xref py py-class docutils literal"><span class="pre">evaluation.Evaluation</span></code></a>) – The evaluation object to export.</li>
-<li><strong>file_path</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Optional file path where the config file should be saved.</li>
+<li><strong>file_path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Optional file path where the config file should be saved.</li>
</ul>
</td>
</tr>
@@ -93,8 +77,7 @@ information.</td>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-func docutils literal"><span class="pre">dict()</span></code> containing necessary information for
dataset to be saved into a configuration object.</td>
</tr>
-<tr class="field-odd field"><th class="field-name" colspan="2">Raises AttributeError:</th></tr>
-<tr class="field-odd field"><td> </td><td class="field-body">If dataset does not contain expected source data.</td>
+<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>AttributeError</strong> – If dataset does not contain expected source data.</td>
</tr>
</tbody>
</table>
@@ -193,13 +176,15 @@ box info for export into a configuration
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/>
- </a></p>
- <h4>Previous topic</h4>
- <p class="topless"><a href="config_overview.html"
- title="previous chapter">Configuration File Overview</a></p>
- <h4>Next topic</h4>
- <p class="topless"><a href="dataset_information.html"
- title="next chapter">Dataset Information</a></p>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="config_overview.html" title="previous chapter">Configuration File Overview</a></li>
+ <li>Next: <a href="dataset_information.html" title="next chapter">Dataset Information</a></li>
+ </ul></li>
+</ul>
+</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
@@ -210,14 +195,11 @@ box info for export into a configuration
<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>
@@ -228,12 +210,12 @@ box info for export into a configuration
©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/config/config_writer.txt"
- rel="nofollow">Page source</a></li>
+ rel="nofollow">Page source</a>
</div>
Modified: climate/site/trunk/content/api/current/config/dataset_information.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/config/dataset_information.html?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/config/dataset_information.html (original)
+++ climate/site/trunk/content/api/current/config/dataset_information.html Mon Apr 24 21:36:16 2017
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Dataset Information — Apache Open Climate Workbench 1.1.0 documentation</title>
+ <title>Dataset Information — 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="Evaluation Settings" href="evaluation_settings.html" />
<link rel="prev" title="Configuration File Writer API" href="config_writer.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="evaluation_settings.html" title="Evaluation Settings"
- accesskey="N">next</a> |</li>
- <li class="right" >
- <a href="config_writer.html" title="Configuration File Writer API"
- 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">
@@ -62,41 +46,41 @@
<div class="section" id="dataset-information">
<h1>Dataset Information<a class="headerlink" href="#dataset-information" title="Permalink to this headline">¶</a></h1>
<p>Dataset configuration information is passed in the <strong>datasets</strong> section of the configuration file. You can specify one reference dataset and one or more target datasets for your evaluation:</p>
-<div class="highlight-python"><div class="highlight"><pre>datasets:
- reference:
- data_source: local
- file_count: 1
- path: /tmp/AFRICA_KNMI-RACMO2.2b_CTL_ERAINT_MM_50km_1989-2008_tasmax.nc
- variable: tasmax
-
- targets:
- - data_source: local
- file_count: 1
- path: /tmp/AFRICA_UC-WRF311_CTL_ERAINT_MM_50km-rg_1989-2008_tasmax.nc
- variable: tasmax
- - data_source: local
- file_count: 1
- path: /tmp/AFRICA_UC-WRF311_CTL_ERAINT_MM_50km-rg_1989-2008_tasmax.nc
- variable: tasmax
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">datasets</span><span class="p">:</span>
+ <span class="n">reference</span><span class="p">:</span>
+ <span class="n">data_source</span><span class="p">:</span> <span class="n">local</span>
+ <span class="n">file_count</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="n">path</span><span class="p">:</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">AFRICA_KNMI</span><span class="o">-</span><span class="n">RACMO2</span><span class="o">.</span><span class="mi">2</span><span class="n">b_CTL_ERAINT_MM_50km_1989</span><span class="o">-</span><span class="mi">2008</span><span class="n">_tasmax</span><span class="o">.</span><span class="n">nc</span>
+ <span class="n">variable</span><span class="p">:</span> <span class="n">tasmax</span>
+
+ <span class="n">targets</span><span class="p">:</span>
+ <span class="o">-</span> <span class="n">data_source</span><span class="p">:</span> <span class="n">local</span>
+ <span class="n">file_count</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="n">path</span><span class="p">:</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">AFRICA_UC</span><span class="o">-</span><span class="n">WRF311_CTL_ERAINT_MM_50km</span><span class="o">-</span><span class="n">rg_1989</span><span class="o">-</span><span class="mi">2008</span><span class="n">_tasmax</span><span class="o">.</span><span class="n">nc</span>
+ <span class="n">variable</span><span class="p">:</span> <span class="n">tasmax</span>
+ <span class="o">-</span> <span class="n">data_source</span><span class="p">:</span> <span class="n">local</span>
+ <span class="n">file_count</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="n">path</span><span class="p">:</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">AFRICA_UC</span><span class="o">-</span><span class="n">WRF311_CTL_ERAINT_MM_50km</span><span class="o">-</span><span class="n">rg_1989</span><span class="o">-</span><span class="mi">2008</span><span class="n">_tasmax</span><span class="o">.</span><span class="n">nc</span>
+ <span class="n">variable</span><span class="p">:</span> <span class="n">tasmax</span>
</pre></div>
</div>
<p>Each <strong>data_source</strong> module requires datasets to be passed in a slightly different manner. Below is an explanation of the format for each of the supported data sources.</p>
<div class="section" id="local-dataset">
<h2>Local Dataset<a class="headerlink" href="#local-dataset" title="Permalink to this headline">¶</a></h2>
-<div class="code highlight-python"><div class="highlight"><pre>data_source: local
-file_count: 1
-path: /tmp/AFRICA_KNMI-RACMO2.2b_CTL_ERAINT_MM_50km_1989-2008_tasmax.nc
-variable: tasmax
+<div class="code highlight-default"><div class="highlight"><pre><span></span><span class="n">data_source</span><span class="p">:</span> <span class="n">local</span>
+<span class="n">file_count</span><span class="p">:</span> <span class="mi">1</span>
+<span class="n">path</span><span class="p">:</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">AFRICA_KNMI</span><span class="o">-</span><span class="n">RACMO2</span><span class="o">.</span><span class="mi">2</span><span class="n">b_CTL_ERAINT_MM_50km_1989</span><span class="o">-</span><span class="mi">2008</span><span class="n">_tasmax</span><span class="o">.</span><span class="n">nc</span>
+<span class="n">variable</span><span class="p">:</span> <span class="n">tasmax</span>
</pre></div>
</div>
<p>The <strong>path</strong> flag is the location where the dataset is located on your computer. The <strong>variable</strong> flag is the variable that should be pulled out of the NetCDF file once it has been opened. You pass any optional flags that are accepted by <a class="reference internal" href="../data_source/data_sources.html#local.load_file" title="local.load_file"><code class="xref py py-func docutils literal"><span class="pre">local.load_file()</span></code></a> by using the <strong>optional_args</strong> flag:</p>
-<div class="highlight-python"><div class="highlight"><pre>data_source: local
-file_count: 1
-path: /tmp/AFRICA_KNMI-RACMO2.2b_CTL_ERAINT_MM_50km_1989-2008_tasmax.nc
-variable: tasmax
-optional_args:
- elevation_index=0,
- name='foo'
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">data_source</span><span class="p">:</span> <span class="n">local</span>
+<span class="n">file_count</span><span class="p">:</span> <span class="mi">1</span>
+<span class="n">path</span><span class="p">:</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">AFRICA_KNMI</span><span class="o">-</span><span class="n">RACMO2</span><span class="o">.</span><span class="mi">2</span><span class="n">b_CTL_ERAINT_MM_50km_1989</span><span class="o">-</span><span class="mi">2008</span><span class="n">_tasmax</span><span class="o">.</span><span class="n">nc</span>
+<span class="n">variable</span><span class="p">:</span> <span class="n">tasmax</span>
+<span class="n">optional_args</span><span class="p">:</span>
+ <span class="n">elevation_index</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
+ <span class="n">name</span><span class="o">=</span><span class="s1">'foo'</span>
</pre></div>
</div>
<div class="admonition note">
@@ -106,15 +90,15 @@ optional_args:
</div>
<div class="section" id="rcmed-dataset">
<h2>RCMED Dataset<a class="headerlink" href="#rcmed-dataset" title="Permalink to this headline">¶</a></h2>
-<div class="code highlight-python"><div class="highlight"><pre>data_source: rcmed
-dataset_id: 4
-parameter_id: 32
-min_lat: -10
-max_lat: 10
-min_lon: -20
-max_lon: 20
-start_time: 1997-01-01
-end_time: 2000-01-01
+<div class="code highlight-default"><div class="highlight"><pre><span></span><span class="n">data_source</span><span class="p">:</span> <span class="n">rcmed</span>
+<span class="n">dataset_id</span><span class="p">:</span> <span class="mi">4</span>
+<span class="n">parameter_id</span><span class="p">:</span> <span class="mi">32</span>
+<span class="n">min_lat</span><span class="p">:</span> <span class="o">-</span><span class="mi">10</span>
+<span class="n">max_lat</span><span class="p">:</span> <span class="mi">10</span>
+<span class="n">min_lon</span><span class="p">:</span> <span class="o">-</span><span class="mi">20</span>
+<span class="n">max_lon</span><span class="p">:</span> <span class="mi">20</span>
+<span class="n">start_time</span><span class="p">:</span> <span class="mi">1997</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">01</span>
+<span class="n">end_time</span><span class="p">:</span> <span class="mi">2000</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">01</span>
</pre></div>
</div>
<p>To load a dataset from the Jet Propulsion Laboratory’s RCMED you will need to specify the above flags. The <strong>dataset_id</strong> and <strong>parameter_id</strong> are dataset specific and can be looked up on the <a class="reference external" href="https://rcmes.jpl.nasa.gov/content/rcmes-and-data">RCMES project website</a>. Pretty much any common time format will be accepted for the start and end times. However, just to be safe you should try to stick with something very standard such as <a class="reference external" href="http://www.w3.org/TR/NOTE-datetime">ISO-8601</a> formatted time values. You may also pass any optional parameters that are accepted by <a class="reference internal" href="../data_source/data_sources.html#rcmed.parameter_dataset" title="rcmed.parameter_dataset"><code class="xref py py-func docutils literal"><span class="pre">rcmed.parameter_dataset()</span></code></a> with the <strong>optional_args</strong> flag.</p>
@@ -122,24 +106,24 @@ end_time: 2000-01-01
<div class="section" id="esgf-dataset">
<h2>ESGF Dataset<a class="headerlink" href="#esgf-dataset" title="Permalink to this headline">¶</a></h2>
<p>In order to load an ESGF dataset you will need to specify the following parameters in addition to having an ESGF login:</p>
-<div class="highlight-python"><div class="highlight"><pre>data_source: esgf
-dataset_id: obs4MIPs.CNES.AVISO.mon.v1|esg-datanode.jpl.nasa.gov
-variable: zosStderr
-esgf_password: totallynotmypassword
-esgf_username: totallynotmyusername
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">data_source</span><span class="p">:</span> <span class="n">esgf</span>
+<span class="n">dataset_id</span><span class="p">:</span> <span class="n">obs4MIPs</span><span class="o">.</span><span class="n">CNES</span><span class="o">.</span><span class="n">AVISO</span><span class="o">.</span><span class="n">mon</span><span class="o">.</span><span class="n">v1</span><span class="o">|</span><span class="n">esg</span><span class="o">-</span><span class="n">datanode</span><span class="o">.</span><span class="n">jpl</span><span class="o">.</span><span class="n">nasa</span><span class="o">.</span><span class="n">gov</span>
+<span class="n">variable</span><span class="p">:</span> <span class="n">zosStderr</span>
+<span class="n">esgf_password</span><span class="p">:</span> <span class="n">totallynotmypassword</span>
+<span class="n">esgf_username</span><span class="p">:</span> <span class="n">totallynotmyusername</span>
</pre></div>
</div>
-<p>The <strong>dataset_id</strong> and <strong>variable</strong> flags are ESGF dataset specific. You can locate them through and ESGF nodes search page. You may also pass any optional parameters that are accepted by <a class="reference internal" href="../data_source/data_sources.html#esgf.load_dataset" title="esgf.load_dataset"><code class="xref py py-func docutils literal"><span class="pre">esgf.load_dataset()</span></code></a> with the <strong>optional_args</strong> flag.</p>
+<p>The <strong>dataset_id</strong> and <strong>variable</strong> flags are ESGF dataset specific. You can locate them through and ESGF nodes search page. You may also pass any optional parameters that are accepted by <code class="xref py py-func docutils literal"><span class="pre">esgf.load_dataset()</span></code> with the <strong>optional_args</strong> flag.</p>
</div>
<div class="section" id="opendap-dataset">
<h2>OpenDAP Dataset<a class="headerlink" href="#opendap-dataset" title="Permalink to this headline">¶</a></h2>
<p>A dataset can be downloaded from an OpenDAP URL with the following settings:</p>
-<div class="highlight-python"><div class="highlight"><pre>data_source: dap
-url: http://test.opendap.org/dap/data/nc/sst.mnmean.nc.gz
-variable: sst
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">data_source</span><span class="p">:</span> <span class="n">dap</span>
+<span class="n">url</span><span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">test</span><span class="o">.</span><span class="n">opendap</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">dap</span><span class="o">/</span><span class="n">data</span><span class="o">/</span><span class="n">nc</span><span class="o">/</span><span class="n">sst</span><span class="o">.</span><span class="n">mnmean</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">gz</span>
+<span class="n">variable</span><span class="p">:</span> <span class="n">sst</span>
</pre></div>
</div>
-<p>You may also pass any optional parameters that are accepted by <a class="reference internal" href="../data_source/data_sources.html#dap.load" title="dap.load"><code class="xref py py-func docutils literal"><span class="pre">dap.load()</span></code></a> with the <strong>optional_args</strong> flag.</p>
+<p>You may also pass any optional parameters that are accepted by <code class="xref py py-func docutils literal"><span class="pre">dap.load()</span></code> with the <strong>optional_args</strong> flag.</p>
</div>
</div>
@@ -162,13 +146,15 @@ variable: sst
</ul>
</li>
</ul>
-
- <h4>Previous topic</h4>
- <p class="topless"><a href="config_writer.html"
- title="previous chapter">Configuration File Writer API</a></p>
- <h4>Next topic</h4>
- <p class="topless"><a href="evaluation_settings.html"
- title="next chapter">Evaluation Settings</a></p>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="config_writer.html" title="previous chapter">Configuration File Writer API</a></li>
+ <li>Next: <a href="evaluation_settings.html" title="next chapter">Evaluation Settings</a></li>
+ </ul></li>
+</ul>
+</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
@@ -179,14 +165,11 @@ variable: sst
<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>
@@ -197,12 +180,12 @@ variable: sst
©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/config/dataset_information.txt"
- rel="nofollow">Page source</a></li>
+ rel="nofollow">Page source</a>
</div>
Modified: climate/site/trunk/content/api/current/config/evaluation_settings.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/config/evaluation_settings.html?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/config/evaluation_settings.html (original)
+++ climate/site/trunk/content/api/current/config/evaluation_settings.html Mon Apr 24 21:36:16 2017
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Evaluation Settings — Apache Open Climate Workbench 1.1.0 documentation</title>
+ <title>Evaluation Settings — 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="Metrics Information" href="metrics_information.html" />
<link rel="prev" title="Dataset Information" href="dataset_information.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="metrics_information.html" title="Metrics Information"
- accesskey="N">next</a> |</li>
- <li class="right" >
- <a href="dataset_information.html" title="Dataset Information"
- 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">
@@ -62,7 +46,7 @@
<div class="section" id="evaluation-settings">
<h1>Evaluation Settings<a class="headerlink" href="#evaluation-settings" title="Permalink to this headline">¶</a></h1>
<p>The evaluation settings section of the configuration file allows you to set attributes that are critical for making adjustments to the loaded datasets prior to an evaluation run. Here is an example evaluation settings section of a configuration file. Below, we’ll look at each of the configuration options in detail.</p>
-<div class="code highlight-python"><div class="highlight"><pre>evaluation:
+<div class="code highlight-default"><div class="highlight"><pre><span></span>evaluation:
temporal_time_delta: 365
spatial_regrid_lats: !!python/tuple [-20, 20, 1]
spatial_regrid_lons: !!python/tuple [-20, 20, 1]
@@ -70,7 +54,7 @@
</div>
<div class="section" id="temporal-rebin">
<h2>Temporal Rebin<a class="headerlink" href="#temporal-rebin" title="Permalink to this headline">¶</a></h2>
-<p>It is often necessary to temporally rebin datasets prior to an evaluation. The <strong>temporal_time_delta</strong> flag is where you can set the <strong>temporal_resolution</strong> parameter for <a class="reference internal" href="../ocw/dataset_processor.html#dataset_processor.temporal_rebin" title="dataset_processor.temporal_rebin"><code class="xref py py-func docutils literal"><span class="pre">dataset_processor.temporal_rebin()</span></code></a>. The value that you pass here is interpreted as the number of days to assign to a <a class="reference external" href="http://docs.python.org/2/library/datetime.html#datetime.timedelta" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.timedelta</span></code></a> object before running the <a class="reference internal" href="../ocw/dataset_processor.html#dataset_processor.temporal_rebin" title="dataset_processor.temporal_rebin"><code class="xref py py-func docutils literal"><span class
="pre">dataset_processor.temporal_rebin()</span></code></a> function.</p>
+<p>It is often necessary to temporally rebin datasets prior to an evaluation. The <strong>temporal_time_delta</strong> flag is where you can set the <strong>temporal_resolution</strong> parameter for <a class="reference internal" href="../ocw/dataset_processor.html#dataset_processor.temporal_rebin" title="dataset_processor.temporal_rebin"><code class="xref py py-func docutils literal"><span class="pre">dataset_processor.temporal_rebin()</span></code></a>. The value that you pass here is interpreted as the number of days to assign to a <a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime.timedelta" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.timedelta</span></code></a> object before running the <a class="reference internal" href="../ocw/dataset_processor.html#dataset_processor.temporal_rebin" title="dataset_processor.temporal_rebin"><code class="xref py py-func docutils literal"><span clas
s="pre">dataset_processor.temporal_rebin()</span></code></a> function.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is only useful if you use the configuration data to create an <a class="reference internal" href="../ocw/evaluation.html#evaluation.Evaluation" title="evaluation.Evaluation"><code class="xref py py-class docutils literal"><span class="pre">evaluation.Evaluation</span></code></a> object with the <code class="xref py py-func docutils literal"><span class="pre">evaluation_creation.generate_evaluation_from_config()</span></code> config parser function.</p>
@@ -83,29 +67,29 @@
<p class="last">Some funcitonality here is still in development. Specifically, passing the spatial_regrid_* flags as lists of values.</p>
</div>
<p>If you need to regrid your datasets onto a new lat/lon grid you will need to set the <strong>spatial_regrid_lats</strong> and <strong>spatial_regrid_lons</strong> options. These will be passed to the <a class="reference internal" href="../ocw/dataset_processor.html#dataset_processor.spatial_regrid" title="dataset_processor.spatial_regrid"><code class="xref py py-func docutils literal"><span class="pre">dataset_processor.spatial_regrid()</span></code></a> function along with each dataset. There are two valid ways to pass these parameters. First, you can pass them as a list of all values:</p>
-<div class="highlight-python"><div class="highlight"><pre>evaluation:
- spatial_regrid_lats: [-10, -5, 0, 5, 10]
- spatial_regrid_lons: [-10, -5, 0, 5, 10]
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">evaluation</span><span class="p">:</span>
+ <span class="n">spatial_regrid_lats</span><span class="p">:</span> <span class="p">[</span><span class="o">-</span><span class="mi">10</span><span class="p">,</span> <span class="o">-</span><span class="mi">5</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">]</span>
+ <span class="n">spatial_regrid_lons</span><span class="p">:</span> <span class="p">[</span><span class="o">-</span><span class="mi">10</span><span class="p">,</span> <span class="o">-</span><span class="mi">5</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">]</span>
</pre></div>
</div>
<p>This is generally useful if you only need to pass a few parameters or if the sequence isn’t easy to define as a valid <strong>range</strong> in Python. The other option is to pass <strong>range</strong> information as a tuple. This requires you to use <a class="reference external" href="http://pyyaml.org/wiki/PyYAMLDocumentation#YAMLtagsandPythontypes">PyYAML’s Python Type Annotations</a> but provides a far more compact representation:</p>
-<div class="highlight-python"><div class="highlight"><pre>evaluation:
+<div class="highlight-default"><div class="highlight"><pre><span></span>evaluation:
spatial_regrid_lats: !!python/tuple [-20, 20, 1]
spatial_regrid_lons: !!python/tuple [-20, 20, 1]
</pre></div>
</div>
-<p>Using this style directly maps to a call to <a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.arange.html#numpy.arange" title="(in NumPy v1.11)"><code class="xref py py-func docutils literal"><span class="pre">numpy.arange()</span></code></a>:</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="c"># spatial_regrid_lats: !!python/tuple [-20, 20, 1] becomes</span>
+<p>Using this style directly maps to a call to <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.arange.html#numpy.arange" title="(in NumPy v1.12)"><code class="xref py py-func docutils literal"><span class="pre">numpy.arange()</span></code></a>:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># spatial_regrid_lats: !!python/tuple [-20, 20, 1] becomes</span>
<span class="n">lats</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="o">-</span><span class="mi">20</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
-<p>Be sure to pay special attention to the end value for your interval. The <a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.arange.html#numpy.arange" title="(in NumPy v1.11)"><code class="xref py py-func docutils literal"><span class="pre">numpy.arange()</span></code></a> function does not include the end value in the returned interval.</p>
+<p>Be sure to pay special attention to the end value for your interval. The <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.arange.html#numpy.arange" title="(in NumPy v1.12)"><code class="xref py py-func docutils literal"><span class="pre">numpy.arange()</span></code></a> function does not include the end value in the returned interval.</p>
</div>
<div class="section" id="subset-bounds">
<h2>Subset Bounds<a class="headerlink" href="#subset-bounds" title="Permalink to this headline">¶</a></h2>
<p>In order to subset the datasets down to an area of interest you will need to pass bounds information:</p>
-<div class="highlight-python"><div class="highlight"><pre>evaluation:
- subset: [-10, 10, -20, 20, "1997-01-01", "2000-01-01"]
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">evaluation</span><span class="p">:</span>
+ <span class="n">subset</span><span class="p">:</span> <span class="p">[</span><span class="o">-</span><span class="mi">10</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="o">-</span><span class="mi">20</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="s2">"1997-01-01"</span><span class="p">,</span> <span class="s2">"2000-01-01"</span><span class="p">]</span>
</pre></div>
</div>
<p>Here you’re passing the bounding lat/lon box with the first 4 values as well as the valid temporal range bounds with the starting and end time values. Pretty much any common time format will be accepted. However, just to be safe you should try to stick with something very standard such as <a class="reference external" href="http://www.w3.org/TR/NOTE-datetime">ISO-8601</a> formatted time values.</p>
@@ -130,13 +114,15 @@
</ul>
</li>
</ul>
-
- <h4>Previous topic</h4>
- <p class="topless"><a href="dataset_information.html"
- title="previous chapter">Dataset Information</a></p>
- <h4>Next topic</h4>
- <p class="topless"><a href="metrics_information.html"
- title="next chapter">Metrics Information</a></p>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="dataset_information.html" title="previous chapter">Dataset Information</a></li>
+ <li>Next: <a href="metrics_information.html" title="next chapter">Metrics Information</a></li>
+ </ul></li>
+</ul>
+</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
@@ -147,14 +133,11 @@
<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>
@@ -165,12 +148,12 @@
©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/config/evaluation_settings.txt"
- rel="nofollow">Page source</a></li>
+ rel="nofollow">Page source</a>
</div>
Modified: climate/site/trunk/content/api/current/config/metrics_information.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/config/metrics_information.html?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/config/metrics_information.html (original)
+++ climate/site/trunk/content/api/current/config/metrics_information.html Mon Apr 24 21:36:16 2017
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Metrics Information — Apache Open Climate Workbench 1.1.0 documentation</title>
+ <title>Metrics Information — 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="Plots Settings" href="plots_settings.html" />
<link rel="prev" title="Evaluation Settings" href="evaluation_settings.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="plots_settings.html" title="Plots Settings"
- accesskey="N">next</a> |</li>
- <li class="right" >
- <a href="evaluation_settings.html" title="Evaluation Settings"
- 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">
@@ -66,9 +50,9 @@
<p class="last">At the moment, you can only load metrics that are in <code class="xref py py-mod docutils literal"><span class="pre">ocw.metrics</span></code>. In the future you will also be able to specify user defined metrics here as well. However, as a work around you can define your custom metrics in the <code class="xref py py-mod docutils literal"><span class="pre">ocw.metrics</span></code> module.</p>
</div>
<p>You can set the metrics you want to use in the evaluation in the <strong>metrics</strong> section of the config. You simply need to supply a list of the metric class names that you want to be used:</p>
-<div class="highlight-python"><div class="highlight"><pre>metrics:
- - Bias
- - TemporalStdDev
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">metrics</span><span class="p">:</span>
+ <span class="o">-</span> <span class="n">Bias</span>
+ <span class="o">-</span> <span class="n">TemporalStdDev</span>
</pre></div>
</div>
</div>
@@ -81,13 +65,15 @@
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/>
- </a></p>
- <h4>Previous topic</h4>
- <p class="topless"><a href="evaluation_settings.html"
- title="previous chapter">Evaluation Settings</a></p>
- <h4>Next topic</h4>
- <p class="topless"><a href="plots_settings.html"
- title="next chapter">Plots Settings</a></p>
+ </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="evaluation_settings.html" title="previous chapter">Evaluation Settings</a></li>
+ <li>Next: <a href="plots_settings.html" title="next chapter">Plots Settings</a></li>
+ </ul></li>
+</ul>
+</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
@@ -98,14 +84,11 @@
<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>
@@ -116,12 +99,12 @@
©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/config/metrics_information.txt"
- rel="nofollow">Page source</a></li>
+ rel="nofollow">Page source</a>
</div>
Modified: climate/site/trunk/content/api/current/config/plots_settings.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/config/plots_settings.html?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/config/plots_settings.html (original)
+++ climate/site/trunk/content/api/current/config/plots_settings.html Mon Apr 24 21:36:16 2017
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Plots Settings — Apache Open Climate Workbench 1.1.0 documentation</title>
+ <title>Plots Settings — 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,32 +23,19 @@
<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="prev" title="Metrics Information" href="metrics_information.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="metrics_information.html" title="Metrics Information"
- 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">
@@ -58,7 +45,7 @@
<div class="section" id="plots-settings">
<h1>Plots Settings<a class="headerlink" href="#plots-settings" title="Permalink to this headline">¶</a></h1>
<p>Plotting configuration information is passed in the <strong>plots</strong> section of the configuration file:</p>
-<div class="highlight-python"><div class="highlight"><pre>plots:
+<div class="highlight-default"><div class="highlight"><pre><span></span>plots:
- type: contour
results_indeces:
- !!python/tuple [0, 0]
@@ -79,7 +66,7 @@
<div class="section" id="contour-maps">
<h2>Contour Maps<a class="headerlink" href="#contour-maps" title="Permalink to this headline">¶</a></h2>
<p>The contour maps config configures data for OCW’s contour plotter <code class="xref py py-func docutils literal"><span class="pre">plotting.draw_contour_map()</span></code>:</p>
-<div class="highlight-python"><div class="highlight"><pre>type: contour
+<div class="highlight-default"><div class="highlight"><pre><span></span>type: contour
results_indeces:
- !!python/tuple [0, 0]
lats:
@@ -115,10 +102,14 @@
</ul>
</li>
</ul>
-
- <h4>Previous topic</h4>
- <p class="topless"><a href="metrics_information.html"
- title="previous chapter">Metrics Information</a></p>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ <li>Previous: <a href="metrics_information.html" title="previous chapter">Metrics Information</a></li>
+ </ul></li>
+</ul>
+</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
@@ -129,14 +120,11 @@
<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>
@@ -147,12 +135,12 @@
©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/config/plots_settings.txt"
- rel="nofollow">Page source</a></li>
+ rel="nofollow">Page source</a>
</div>