Added: websites/staging/climate/trunk/content/api/current/config/config_writer.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/config/config_writer.html (added) +++ websites/staging/climate/trunk/content/api/current/config/config_writer.html Wed Jul 27 17:50:56 2016 @@ -0,0 +1,243 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>Configuration File Writer API — Apache Open Climate Workbench 1.1.0 documentation</title> + + <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '1.1.0', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="../index.html" /> + <link rel="next" title="Dataset Information" href="dataset_information.html" /> + <link rel="prev" title="Configuration File Overview" href="config_overview.html" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> + + </head> + <body role="document"> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="../http-routingtable.html" title="HTTP Routing Table" + >routing table</a> |</li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="right" > + <a href="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"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <div class="section" id="module-ocw_config_runner.configuration_writer"> +<span id="configuration-file-writer-api"></span><h1>Configuration File Writer API<a class="headerlink" href="#module-ocw_config_runner.configuration_writer" title="Permalink to this headline">¶</a></h1> +<dl class="function"> +<dt id="ocw_config_runner.configuration_writer.export_evaluation_to_config"> +<code class="descclassname">ocw_config_runner.configuration_writer.</code><code class="descname">export_evaluation_to_config</code><span class="sig-paren">(</span><em>evaluation</em>, <em>file_path='./exported_eval.yaml'</em><span class="sig-paren">)</span><a class="headerlink" href="#ocw_config_runner.configuration_writer.export_evaluation_to_config" title="Permalink to this definition">¶</a></dt> +<dd><p>Export an evaluation to a config file</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first 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> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="ocw_config_runner.configuration_writer.generate_dataset_config"> +<code class="descclassname">ocw_config_runner.configuration_writer.</code><code class="descname">generate_dataset_config</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#ocw_config_runner.configuration_writer.generate_dataset_config" title="Permalink to this definition">¶</a></dt> +<dd><p>Generate dataset config file output for a given Dataset object.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dataset</strong> (<a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – The dataset from which to extract configuration +information.</td> +</tr> +<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> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="ocw_config_runner.configuration_writer.generate_dataset_information"> +<code class="descclassname">ocw_config_runner.configuration_writer.</code><code class="descname">generate_dataset_information</code><span class="sig-paren">(</span><em>evaluation</em><span class="sig-paren">)</span><a class="headerlink" href="#ocw_config_runner.configuration_writer.generate_dataset_information" title="Permalink to this definition">¶</a></dt> +<dd><p>Generate dataset config file output for a given Evaluation object.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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 from which to extract metrics.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A <code class="xref py py-func docutils literal"><span class="pre">dict()</span></code> of dataset configuration information for export +to a configuration file.</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-func docutils literal"><span class="pre">dict()</span></code></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="ocw_config_runner.configuration_writer.generate_evaluation_information"> +<code class="descclassname">ocw_config_runner.configuration_writer.</code><code class="descname">generate_evaluation_information</code><span class="sig-paren">(</span><em>evaluation</em><span class="sig-paren">)</span><a class="headerlink" href="#ocw_config_runner.configuration_writer.generate_evaluation_information" title="Permalink to this definition">¶</a></dt> +<dd><p>Generate evaluation-related config file output.</p> +<p>Attempts to parse out temporal and spatial rebinning/regridding information +from the supplied evaluation object. If no datasets can be found, values +are defaulted to sane defaults or (potentially) excluded entirely.</p> +<p>It’s important to note that this function does its best to extrapolate the +configuration information. It’s possible that you will encounter a scenario +where the guessed values are not what you want/expect. Please double +check the output before blinding trusting what this generates.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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 from which to extract metrics.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A dictionary of valid <cite>evaluation</cite> section settings for export +to a configuration file.</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-func docutils literal"><span class="pre">dict()</span></code></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="ocw_config_runner.configuration_writer.generate_metric_information"> +<code class="descclassname">ocw_config_runner.configuration_writer.</code><code class="descname">generate_metric_information</code><span class="sig-paren">(</span><em>evaluation</em><span class="sig-paren">)</span><a class="headerlink" href="#ocw_config_runner.configuration_writer.generate_metric_information" title="Permalink to this definition">¶</a></dt> +<dd><p>Generate metric config file output from a given Evaluation object.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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 from which to extract metrics.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A <code class="xref py py-func docutils literal"><span class="pre">list()</span></code> of <a class="reference internal" href="../ocw/metrics.html#module-metrics" title="metrics"><code class="xref py py-mod docutils literal"><span class="pre">metrics</span></code></a> object names for output into +a configuration file.</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-func docutils literal"><span class="pre">list()</span></code> of <a class="reference internal" href="../ocw/metrics.html#module-metrics" title="metrics"><code class="xref py py-mod docutils literal"><span class="pre">metrics</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="ocw_config_runner.configuration_writer.generate_subregion_information"> +<code class="descclassname">ocw_config_runner.configuration_writer.</code><code class="descname">generate_subregion_information</code><span class="sig-paren">(</span><em>evaluation</em><span class="sig-paren">)</span><a class="headerlink" href="#ocw_config_runner.configuration_writer.generate_subregion_information" title="Permalink to this definition">¶</a></dt> +<dd><p>Generate subregion config file output from a given Evaluation object.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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 from which to extract metrics.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A <code class="xref py py-func docutils literal"><span class="pre">list()</span></code> of <code class="xref py py-func docutils literal"><span class="pre">list()</span></code> objects containing bounding +box info for export into a configuration file</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-func docutils literal"><span class="pre">list()</span></code> of <code class="xref py py-func docutils literal"><span class="pre">list()</span></code></td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> + <p class="logo"><a href="../index.html"> + <img class="logo" src="../_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/> + </a></p> + <h4>Previous topic</h4> + <p class="topless"><a href="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> + <div role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../_sources/config/config_writer.txt" + rel="nofollow">Show Source</a></li> + </ul> + </div> +<div id="searchbox" style="display: none" role="search"> + <h3>Quick search</h3> + <form class="search" action="../search.html" method="get"> + <input type="text" name="q" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + <p class="searchtip" style="font-size: 90%"> + Enter search terms or a module, class or function name. + </p> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2016, Apache Software Foundation. + + | + Powered by <a href="http://sphinx-doc.org/";>Sphinx 1.3.1</a> + & <a href="https://github.com/bitprophet/alabaster";>Alabaster 0.7.4</a> + + | + <a href="../_sources/config/config_writer.txt" + rel="nofollow">Page source</a></li> + </div> + + + + + </body> +</html> \ No newline at end of file
Added: websites/staging/climate/trunk/content/api/current/config/dataset_information.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/config/dataset_information.html (added) +++ websites/staging/climate/trunk/content/api/current/config/dataset_information.html Wed Jul 27 17:50:56 2016 @@ -0,0 +1,212 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>Dataset Information — Apache Open Climate Workbench 1.1.0 documentation</title> + + <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '1.1.0', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="../index.html" /> + <link rel="next" title="Evaluation Settings" href="evaluation_settings.html" /> + <link rel="prev" title="Configuration File Writer API" href="config_writer.html" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> + + </head> + <body role="document"> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="../http-routingtable.html" title="HTTP Routing Table" + >routing table</a> |</li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="right" > + <a href="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"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <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 +</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 +</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' +</pre></div> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">The <strong>file_count</strong> flag is currently not used. It is there to support planned future functionality. However, you still need to specify it! Leave it as 1.</p> +</div> +</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 +</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> +</div> +<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 +</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> +</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 +</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> +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> + <p class="logo"><a href="../index.html"> + <img class="logo" src="../_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/> + </a></p> + <h3><a href="../index.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">Dataset Information</a><ul> +<li><a class="reference internal" href="#local-dataset">Local Dataset</a></li> +<li><a class="reference internal" href="#rcmed-dataset">RCMED Dataset</a></li> +<li><a class="reference internal" href="#esgf-dataset">ESGF Dataset</a></li> +<li><a class="reference internal" href="#opendap-dataset">OpenDAP Dataset</a></li> +</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 role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../_sources/config/dataset_information.txt" + rel="nofollow">Show Source</a></li> + </ul> + </div> +<div id="searchbox" style="display: none" role="search"> + <h3>Quick search</h3> + <form class="search" action="../search.html" method="get"> + <input type="text" name="q" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + <p class="searchtip" style="font-size: 90%"> + Enter search terms or a module, class or function name. + </p> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2016, Apache Software Foundation. + + | + Powered by <a href="http://sphinx-doc.org/";>Sphinx 1.3.1</a> + & <a href="https://github.com/bitprophet/alabaster";>Alabaster 0.7.4</a> + + | + <a href="../_sources/config/dataset_information.txt" + rel="nofollow">Page source</a></li> + </div> + + + + + </body> +</html> \ No newline at end of file Added: websites/staging/climate/trunk/content/api/current/config/evaluation_settings.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/config/evaluation_settings.html (added) +++ websites/staging/climate/trunk/content/api/current/config/evaluation_settings.html Wed Jul 27 17:50:56 2016 @@ -0,0 +1,180 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>Evaluation Settings — Apache Open Climate Workbench 1.1.0 documentation</title> + + <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '1.1.0', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="../index.html" /> + <link rel="next" title="Metrics Information" href="metrics_information.html" /> + <link rel="prev" title="Dataset Information" href="dataset_information.html" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> + + </head> + <body role="document"> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="../http-routingtable.html" title="HTTP Routing Table" + >routing table</a> |</li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="right" > + <a href="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"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <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: + temporal_time_delta: 365 + spatial_regrid_lats: !!python/tuple [-20, 20, 1] + spatial_regrid_lons: !!python/tuple [-20, 20, 1] +</pre></div> +</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> +<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> +</div> +</div> +<div class="section" id="spatial-regrid"> +<h2>Spatial Regrid<a class="headerlink" href="#spatial-regrid" title="Permalink to this headline">¶</a></h2> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<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] +</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: + 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> +<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> +</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"] +</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> +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> + <p class="logo"><a href="../index.html"> + <img class="logo" src="../_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/> + </a></p> + <h3><a href="../index.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">Evaluation Settings</a><ul> +<li><a class="reference internal" href="#temporal-rebin">Temporal Rebin</a></li> +<li><a class="reference internal" href="#spatial-regrid">Spatial Regrid</a></li> +<li><a class="reference internal" href="#subset-bounds">Subset Bounds</a></li> +</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 role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../_sources/config/evaluation_settings.txt" + rel="nofollow">Show Source</a></li> + </ul> + </div> +<div id="searchbox" style="display: none" role="search"> + <h3>Quick search</h3> + <form class="search" action="../search.html" method="get"> + <input type="text" name="q" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + <p class="searchtip" style="font-size: 90%"> + Enter search terms or a module, class or function name. + </p> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2016, Apache Software Foundation. + + | + Powered by <a href="http://sphinx-doc.org/";>Sphinx 1.3.1</a> + & <a href="https://github.com/bitprophet/alabaster";>Alabaster 0.7.4</a> + + | + <a href="../_sources/config/evaluation_settings.txt" + rel="nofollow">Page source</a></li> + </div> + + + + + </body> +</html> \ No newline at end of file Added: websites/staging/climate/trunk/content/api/current/config/metrics_information.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/config/metrics_information.html (added) +++ websites/staging/climate/trunk/content/api/current/config/metrics_information.html Wed Jul 27 17:50:56 2016 @@ -0,0 +1,131 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>Metrics Information — Apache Open Climate Workbench 1.1.0 documentation</title> + + <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '1.1.0', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="../index.html" /> + <link rel="next" title="Plots Settings" href="plots_settings.html" /> + <link rel="prev" title="Evaluation Settings" href="evaluation_settings.html" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> + + </head> + <body role="document"> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="../http-routingtable.html" title="HTTP Routing Table" + >routing table</a> |</li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="right" > + <a href="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"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <div class="section" id="metrics-information"> +<h1>Metrics Information<a class="headerlink" href="#metrics-information" title="Permalink to this headline">¶</a></h1> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<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 +</pre></div> +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> + <p class="logo"><a href="../index.html"> + <img class="logo" src="../_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/> + </a></p> + <h4>Previous topic</h4> + <p class="topless"><a href="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> + <div role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../_sources/config/metrics_information.txt" + rel="nofollow">Show Source</a></li> + </ul> + </div> +<div id="searchbox" style="display: none" role="search"> + <h3>Quick search</h3> + <form class="search" action="../search.html" method="get"> + <input type="text" name="q" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + <p class="searchtip" style="font-size: 90%"> + Enter search terms or a module, class or function name. + </p> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2016, Apache Software Foundation. + + | + Powered by <a href="http://sphinx-doc.org/";>Sphinx 1.3.1</a> + & <a href="https://github.com/bitprophet/alabaster";>Alabaster 0.7.4</a> + + | + <a href="../_sources/config/metrics_information.txt" + rel="nofollow">Page source</a></li> + </div> + + + + + </body> +</html> \ No newline at end of file Added: websites/staging/climate/trunk/content/api/current/config/plots_settings.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/config/plots_settings.html (added) +++ websites/staging/climate/trunk/content/api/current/config/plots_settings.html Wed Jul 27 17:50:56 2016 @@ -0,0 +1,162 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>Plots Settings — Apache Open Climate Workbench 1.1.0 documentation</title> + + <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '1.1.0', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="../index.html" /> + <link rel="prev" title="Metrics Information" href="metrics_information.html" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> + + </head> + <body role="document"> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="../http-routingtable.html" title="HTTP Routing Table" + >routing table</a> |</li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="right" > + <a href="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"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <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: + - type: contour + results_indeces: + - !!python/tuple [0, 0] + lats: + range_min: -20 + range_max: 20 + range_step: 1 + lons: + range_min: -20 + range_max: 20 + range_step: 1 + output_name: wrf_bias_compared_to_knmi + optional_args: + gridshape: !!python/tuple [6, 6] +</pre></div> +</div> +<p>Each type of support plot has a different configuration format expected. Each of these are explained below. Note, most of these will require you to specify what result data you want included in the plots with the <strong>results_indeces</strong> flag. This relates the format that an Evaluation object outputs results in. Check the <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> documentation for more details.</p> +<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 + results_indeces: + - !!python/tuple [0, 0] + lats: + range_min: -20 + range_max: 20 + range_step: 1 + lons: + range_min: -20 + range_max: 20 + range_step: 1 + output_name: wrf_bias_compared_to_knmi + optional_args: + gridshape: !!python/tuple [6, 6] +</pre></div> +</div> +<p>The <strong>lat</strong> and <strong>lon</strong> parameters are specified as a range of values. Be aware that the <strong>range_max</strong> element is not included in the output range so you may need to adjust it slightly if you want a particular value included. The <strong>output_name</strong> parameter is the name of the resulting output graph. You may also pass any optional parameters that are supported by the <code class="xref py py-func docutils literal"><span class="pre">plotting.draw_contour_map()</span></code> function with the <strong>optional_args</strong> flag.</p> +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> + <p class="logo"><a href="../index.html"> + <img class="logo" src="../_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/> + </a></p> + <h3><a href="../index.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">Plots Settings</a><ul> +<li><a class="reference internal" href="#contour-maps">Contour Maps</a></li> +</ul> +</li> +</ul> + + <h4>Previous topic</h4> + <p class="topless"><a href="metrics_information.html" + title="previous chapter">Metrics Information</a></p> + <div role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../_sources/config/plots_settings.txt" + rel="nofollow">Show Source</a></li> + </ul> + </div> +<div id="searchbox" style="display: none" role="search"> + <h3>Quick search</h3> + <form class="search" action="../search.html" method="get"> + <input type="text" name="q" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + <p class="searchtip" style="font-size: 90%"> + Enter search terms or a module, class or function name. + </p> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2016, Apache Software Foundation. + + | + Powered by <a href="http://sphinx-doc.org/";>Sphinx 1.3.1</a> + & <a href="https://github.com/bitprophet/alabaster";>Alabaster 0.7.4</a> + + | + <a href="../_sources/config/plots_settings.txt" + rel="nofollow">Page source</a></li> + </div> + + + + + </body> +</html> \ No newline at end of file
