Modified: websites/staging/climate/trunk/content/api/current/http-routingtable.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/http-routingtable.html (original) +++ websites/staging/climate/trunk/content/api/current/http-routingtable.html Mon Apr 24 21:37:01 2017 @@ -6,7 +6,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>HTTP Routing Table — Apache Open Climate Workbench 1.1.0 documentation</title> + <title>HTTP Routing Table — 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,11 +23,15 @@ <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="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" /> <script type="text/javascript"> @@ -37,21 +41,7 @@ </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="#" 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="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"> @@ -75,7 +65,7 @@ </div> <table class="indextable modindextable" cellspacing="0" cellpadding="2"> - <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="pcap"><td></td><td> </td><td></td></tr> <tr class="cap" id="cap-/datasets"><td></td><td> <strong>/datasets</strong></td><td></td></tr> <tr> @@ -83,7 +73,7 @@ <td> <a href="ui-backend/backend.html#get--datasets-"><code class="xref">GET /datasets/</code></a></td><td> <em></em></td></tr> - <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="pcap"><td></td><td> </td><td></td></tr> <tr class="cap" id="cap-/list"><td></td><td> <strong>/list</strong></td><td></td></tr> <tr> @@ -96,7 +86,7 @@ <td> <a href="ui-backend/backend.html#get--list-(dir_path-path)"><code class="xref">GET /list/(dir_path:path)</code></a></td><td> <em></em></td></tr> - <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="pcap"><td></td><td> </td><td></td></tr> <tr class="cap" id="cap-/list_latlon"><td></td><td> <strong>/list_latlon</strong></td><td></td></tr> <tr> @@ -104,7 +94,7 @@ <td> <a href="ui-backend/backend.html#get--list_latlon-(file_path-path)"><code class="xref">GET /list_latlon/(file_path:path)</code></a></td><td> <em></em></td></tr> - <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="pcap"><td></td><td> </td><td></td></tr> <tr class="cap" id="cap-/list_time"><td></td><td> <strong>/list_time</strong></td><td></td></tr> <tr> @@ -112,7 +102,7 @@ <td> <a href="ui-backend/backend.html#get--list_time-(file_path-path)"><code class="xref">GET /list_time/(file_path:path)</code></a></td><td> <em></em></td></tr> - <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="pcap"><td></td><td> </td><td></td></tr> <tr class="cap" id="cap-/list_vars"><td></td><td> <strong>/list_vars</strong></td><td></td></tr> <tr> @@ -120,7 +110,7 @@ <td> <a href="ui-backend/backend.html#get--list_vars-(file_path-path)"><code class="xref">GET /list_vars/(file_path:path)</code></a></td><td> <em></em></td></tr> - <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="pcap"><td></td><td> </td><td></td></tr> <tr class="cap" id="cap-/metrics"><td></td><td> <strong>/metrics</strong></td><td></td></tr> <tr> @@ -128,7 +118,7 @@ <td> <a href="ui-backend/backend.html#get--metrics-"><code class="xref">GET /metrics/</code></a></td><td> <em></em></td></tr> - <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="pcap"><td></td><td> </td><td></td></tr> <tr class="cap" id="cap-/parameters"><td></td><td> <strong>/parameters</strong></td><td></td></tr> <tr> @@ -146,7 +136,7 @@ <td> <a href="ui-backend/backend.html#get--parameters-bounds-"><code class="xref">GET /parameters/bounds/</code></a></td><td> <em></em></td></tr> - <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="pcap"><td></td><td> </td><td></td></tr> <tr class="cap" id="cap-/path_leader"><td></td><td> <strong>/path_leader</strong></td><td></td></tr> <tr> @@ -154,7 +144,7 @@ <td> <a href="ui-backend/backend.html#get--path_leader-"><code class="xref">GET /path_leader/</code></a></td><td> <em></em></td></tr> - <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="pcap"><td></td><td> </td><td></td></tr> <tr class="cap" id="cap-/results"><td></td><td> <strong>/results</strong></td><td></td></tr> <tr> @@ -167,7 +157,7 @@ <td> <a href="ui-backend/backend.html#get--results-(dir_path-path)"><code class="xref">GET /results/(dir_path:path)</code></a></td><td> <em></em></td></tr> - <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="pcap"><td></td><td> </td><td></td></tr> <tr class="cap" id="cap-/run_evaluation"><td></td><td> <strong>/run_evaluation</strong></td><td></td></tr> <tr> @@ -190,18 +180,21 @@ <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> + </a></p><div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="index.html">Documentation overview</a><ul> + </ul></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" /> + <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> @@ -212,8 +205,8 @@ ©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> </div>
Modified: websites/staging/climate/trunk/content/api/current/index.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/index.html (original) +++ websites/staging/climate/trunk/content/api/current/index.html Mon Apr 24 21:37:01 2017 @@ -6,7 +6,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Welcome to Apache Open Climate Workbenchâs documentation! — Apache Open Climate Workbench 1.1.0 documentation</title> + <title>Welcome to Apache Open Climate Workbenchâs documentation! — 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="#" /> + <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="#" /> <link rel="next" title="Overview" href="ocw/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="ocw/overview.html" title="Overview" - accesskey="N">next</a> |</li> - <li class="nav-item nav-item-0"><a href="#">Apache Open Climate Workbench 1.1.0 documentation</a> »</li> - </ul> - </div> + <div class="document"> <div class="documentwrapper"> @@ -74,6 +61,7 @@ <li class="toctree-l2"><a class="reference internal" href="ocw/dataset.html#dataset">Dataset</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="ocw/dataset_loader.html">Dataset Loader Module</a></li> <li class="toctree-l1"><a class="reference internal" href="ocw/dataset_processor.html">Dataset Processor Module</a></li> <li class="toctree-l1"><a class="reference internal" href="ocw/evaluation.html">Evaluation Module</a></li> <li class="toctree-l1"><a class="reference internal" href="ocw/metrics.html">Metrics Module</a></li> @@ -82,8 +70,9 @@ <li class="toctree-l1"><a class="reference internal" href="data_source/data_sources.html">Data Sources</a><ul> <li class="toctree-l2"><a class="reference internal" href="data_source/data_sources.html#module-local">Local Module</a></li> <li class="toctree-l2"><a class="reference internal" href="data_source/data_sources.html#module-rcmed">RCMED Module</a></li> -<li class="toctree-l2"><a class="reference internal" href="data_source/data_sources.html#module-dap">DAP Module</a></li> -<li class="toctree-l2"><a class="reference internal" href="data_source/data_sources.html#module-esgf">ESGF Module</a></li> +<li class="toctree-l2"><a class="reference internal" href="data_source/data_sources.html#dap-module">DAP Module</a></li> +<li class="toctree-l2"><a class="reference internal" href="data_source/data_sources.html#esgf-module">ESGF Module</a></li> +<li class="toctree-l2"><a class="reference internal" href="data_source/data_sources.html#module-podaac_datasource">PODAAC Module</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="ui-backend/backend.html">Evaluation UI Webservices</a><ul> @@ -132,9 +121,9 @@ <div class="section" id="indices-and-tables"> <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1> <ul class="simple"> -<li><a class="reference internal" href="genindex.html"><span>Index</span></a></li> -<li><a class="reference internal" href="py-modindex.html"><span>Module Index</span></a></li> -<li><a class="reference internal" href="search.html"><span>Search Page</span></a></li> +<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li> +<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li> +<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li> </ul> </div> @@ -152,10 +141,14 @@ <li><a class="reference internal" href="#">Welcome to Apache Open Climate Workbench’s documentation!</a></li> <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li> </ul> - - <h4>Next topic</h4> - <p class="topless"><a href="ocw/overview.html" - title="next chapter">Overview</a></p> +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="#">Documentation overview</a><ul> + <li>Next: <a href="ocw/overview.html" title="next chapter">Overview</a></li> + </ul></li> +</ul> +</div> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> @@ -166,14 +159,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> @@ -184,12 +174,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/index.txt" - rel="nofollow">Page source</a></li> + rel="nofollow">Page source</a> </div> Modified: websites/staging/climate/trunk/content/api/current/objects.inv ============================================================================== Binary files - no diff available. Modified: websites/staging/climate/trunk/content/api/current/ocw/dataset.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/ocw/dataset.html (original) +++ websites/staging/climate/trunk/content/api/current/ocw/dataset.html Mon Apr 24 21:37:01 2017 @@ -6,7 +6,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Dataset Module — Apache Open Climate Workbench 1.1.0 documentation</title> + <title>Dataset Module — 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="next" title="Dataset Processor Module" href="dataset_processor.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 Loader Module" href="dataset_loader.html" /> <link rel="prev" title="Overview" href="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_processor.html" title="Dataset Processor Module" - accesskey="N">next</a> |</li> - <li class="right" > - <a href="overview.html" title="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"> @@ -65,32 +49,41 @@ <h2>Bounds<a class="headerlink" href="#bounds" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt id="dataset.Bounds"> -<em class="property">class </em><code class="descclassname">dataset.</code><code class="descname">Bounds</code><span class="sig-paren">(</span><em>lat_min</em>, <em>lat_max</em>, <em>lon_min</em>, <em>lon_max</em>, <em>start=None</em>, <em>end=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset.Bounds" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><code class="descclassname">dataset.</code><code class="descname">Bounds</code><span class="sig-paren">(</span><em>boundary_type='rectangular'</em>, <em>us_states=None</em>, <em>countries=None</em>, <em>user_mask_file=None</em>, <em>mask_variable_name=None</em>, <em>longitude_name=None</em>, <em>latitude_name=None</em>, <em>lat_min=-90</em>, <em>lat_max=90</em>, <em>lon_min=-180</em>, <em>lon_max=180</em>, <em>start=None</em>, <em>end=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset.Bounds" title="Permalink to this definition">¶</a></dt> <dd><p>Container for holding spatial and temporal bounds information.</p> <p>Certain operations require valid bounding information to be present for correct functioning. Bounds guarantees that a function receives well formed information without the need to do the validation manually.</p> -<p>Spatial and temporal bounds must follow the following guidelines.</p> +<p>boundary_type may be one of the following: +* ‘rectangular’ +* ‘CORDEX (CORDEX region name)’: pre-defined CORDEX boundary +* ‘us_states’: an array of US states abbreviation is required (ex) us_states = [‘CA’,’NV’]) +* ‘countries’: an array of county names is required (ex) countries = [‘United States’,’Canada’,’Mexico’] +* ‘user’: user_mask_file in a netCDF format with two dimensional mask variable is required.</p> +<p>If boundary_type == ‘rectangular’, spatial and temporal bounds must follow the following guidelines.</p> <ul class="simple"> <li>Latitude values must be in the range [-90, 90]</li> <li>Longitude values must be in the range [-180, 180]</li> <li>Lat/Lon Min values must be less than the corresponding Lat/Lon Max values.</li> -<li>Temporal bounds must a valid datetime object</li> </ul> -<p>Default Bounds constructor</p> +<p>Temporal bounds must a valid datetime object</p> +<p>Default Bounds constructor +:param boundary_type: The type of spatial subset boundary. +:type boundary_type: :mod:<a href="#id1"><span class="problematic" id="id2">`</span></a>string’</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>lat_min</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – The minimum latitude bound.</li> -<li><strong>lat_max</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – The maximum latitude bound.</li> -<li><strong>lon_min</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – The minimum longitude bound.</li> -<li><strong>lon_max</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – The maximum longitude bound.</li> -<li><strong>start</strong> (<a class="reference external" href="http://docs.python.org/2/library/datetime.html#datetime.datetime" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></a>) – An optional datetime object for the starting +<li><strong>lat_min</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – The minimum latitude bound.</li> +<li><strong>lat_min</strong> – The minimum latitude bound.</li> +<li><strong>lat_max</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – The maximum latitude bound.</li> +<li><strong>lon_min</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – The minimum longitude bound.</li> +<li><strong>lon_max</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – The maximum longitude bound.</li> +<li><strong>start</strong> (<a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime.datetime" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></a>) – An optional datetime object for the starting datetime bound.</li> -<li><strong>end</strong> (<a class="reference external" href="http://docs.python.org/2/library/datetime.html#datetime.datetime" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></a>) – An optional datetime object for the ending datetime bound.</li> +<li><strong>end</strong> (<a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime.datetime" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></a>) – An optional datetime object for the ending datetime bound.</li> </ul> </td> </tr> @@ -114,16 +107,16 @@ datetime bound.</li> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>lats</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – One dimensional numpy array of unique latitude values.</li> -<li><strong>lons</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – One dimensional numpy array of unique longitude values.</li> -<li><strong>times</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – One dimensional numpy array of unique python datetime +<li><strong>lats</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – One dimensional numpy array of unique latitude values.</li> +<li><strong>lons</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – One dimensional numpy array of unique longitude values.</li> +<li><strong>times</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – One dimensional numpy array of unique python datetime objects.</li> -<li><strong>values</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – Three dimensional numpy array of parameter values with +<li><strong>values</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – Three dimensional numpy array of parameter values with shape [timesLength, latsLength, lonsLength].</li> -<li><strong>variable</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>) – Name of the value variable.</li> -<li><strong>units</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>) – Name of the value units</li> -<li><strong>name</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>) – An optional string name for the Dataset.</li> -<li><strong>origin</strong> (<a class="reference external" href="http://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">dict</span></code></a>) – An optional object used to specify information on where +<li><strong>variable</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>) – Name of the value variable.</li> +<li><strong>units</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>) – Name of the value units</li> +<li><strong>name</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>) – An optional string name for the Dataset.</li> +<li><strong>origin</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">dict</span></code></a>) – An optional object used to specify information on where this dataset was loaded from.</li> </ul> </td> @@ -144,8 +137,8 @@ this dataset was loaded from.</li> <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The Dataset’s bounding latitude and longitude values as a tuple in the form (min_lat, max_lat, min_lon, max_lon)</td> </tr> -<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="http://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><code class="xref py py-func docutils literal"><span class="pre">tuple()</span></code></a> of the form (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>, <a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>, -<a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>, <a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>).</td> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><code class="xref py py-func docutils literal"><span class="pre">tuple()</span></code></a> of the form (<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>, <a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>, +<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>, <a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>).</td> </tr> </tbody> </table> @@ -165,44 +158,43 @@ the output resolutions are approximate v <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The Dataset’s latitudinal and longitudinal spatial resolution as a tuple of the form (lat_resolution, lon_resolution).</td> </tr> -<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">(<a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>, <a class="reference external" href="http://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>)</td> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">(<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>, <a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>)</td> </tr> </tbody> </table> </dd></dl> <dl class="method"> -<dt id="dataset.Dataset.temporal_resolution"> -<code class="descname">temporal_resolution</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dataset.Dataset.temporal_resolution" title="Permalink to this definition">¶</a></dt> -<dd><p>Calculate the temporal resolution.</p> +<dt id="dataset.Dataset.temporal_boundaries"> +<code class="descname">temporal_boundaries</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dataset.Dataset.temporal_boundaries" title="Permalink to this definition">¶</a></dt> +<dd><p>Calculate the temporal range</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" colspan="2">Raises ValueError:</th></tr> -<tr class="field-odd field"><td> </td><td class="field-body">If timedelta.days as calculated from the sorted list of times is an unrecognized value a ValueError is raised.</td> -</tr> -<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The temporal resolution.</td> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The start and end date of the Dataset’s temporal range as +a tuple in the form (start_time, end_time).</td> </tr> -<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><code class="xref py py-func docutils literal"><span class="pre">tuple()</span></code></a> of the form (<a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime.datetime" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></a>, +<a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime.datetime" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></a>)</td> </tr> </tbody> </table> </dd></dl> <dl class="method"> -<dt id="dataset.Dataset.time_range"> -<code class="descname">time_range</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dataset.Dataset.time_range" title="Permalink to this definition">¶</a></dt> -<dd><p>Calculate the temporal range</p> +<dt id="dataset.Dataset.temporal_resolution"> +<code class="descname">temporal_resolution</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dataset.Dataset.temporal_resolution" title="Permalink to this definition">¶</a></dt> +<dd><p>Calculate the temporal resolution.</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">Returns:</th><td class="field-body">The start and end date of the Dataset’s temporal range as -a tuple in the form (start_time, end_time).</td> +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> – If timedelta.days as calculated from the sorted list of times is an unrecognized value a ValueError is raised.</td> </tr> -<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="http://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><code class="xref py py-func docutils literal"><span class="pre">tuple()</span></code></a> of the form (<a class="reference external" href="http://docs.python.org/2/library/datetime.html#datetime.datetime" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></a>, -<a class="reference external" href="http://docs.python.org/2/library/datetime.html#datetime.datetime" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></a>)</td> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The temporal resolution.</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td> </tr> </tbody> </table> @@ -230,13 +222,15 @@ a tuple in the form (start_time, end_tim </ul> </li> </ul> - - <h4>Previous topic</h4> - <p class="topless"><a href="overview.html" - title="previous chapter">Overview</a></p> - <h4>Next topic</h4> - <p class="topless"><a href="dataset_processor.html" - title="next chapter">Dataset Processor Module</a></p> +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../index.html">Documentation overview</a><ul> + <li>Previous: <a href="overview.html" title="previous chapter">Overview</a></li> + <li>Next: <a href="dataset_loader.html" title="next chapter">Dataset Loader Module</a></li> + </ul></li> +</ul> +</div> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> @@ -247,14 +241,11 @@ a tuple in the form (start_time, end_tim <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> @@ -265,12 +256,12 @@ a tuple in the form (start_time, end_tim ©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/ocw/dataset.txt" - rel="nofollow">Page source</a></li> + rel="nofollow">Page source</a> </div> Added: websites/staging/climate/trunk/content/api/current/ocw/dataset_loader.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/ocw/dataset_loader.html (added) +++ websites/staging/climate/trunk/content/api/current/ocw/dataset_loader.html Mon Apr 24 21:37:01 2017 @@ -0,0 +1,253 @@ +<!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 Loader Module — 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" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '1.2.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="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 Processor Module" href="dataset_processor.html" /> + <link rel="prev" title="Dataset Module" href="dataset.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" /> + + </head> + <body role="document"> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <div class="section" id="module-dataset_loader"> +<span id="dataset-loader-module"></span><h1>Dataset Loader Module<a class="headerlink" href="#module-dataset_loader" title="Permalink to this headline">¶</a></h1> +<dl class="docutils"> +<dt>Classes:</dt> +<dd>DatasetLoader - Generate OCW Dataset objects from a variety of sources.</dd> +</dl> +<dl class="class"> +<dt id="dataset_loader.DatasetLoader"> +<em class="property">class </em><code class="descclassname">dataset_loader.</code><code class="descname">DatasetLoader</code><span class="sig-paren">(</span><em>*loader_opts</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_loader.DatasetLoader" title="Permalink to this definition">¶</a></dt> +<dd><p>Generate a list of OCW Dataset objects from a variety of sources.</p> +<p>Generate a list of OCW Dataset objects from a variety of sources.</p> +<p>Each keyword argument can be information for a dataset in dictionary +form. For example: +`` +>>> loader_opt1 = {‘loader_name’: ‘rcmed’, ‘name’: ‘cru’,</p> +<blockquote> +<div>‘dataset_id’: 10, ‘parameter_id’: 34}</div></blockquote> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">loader_opt2</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'path'</span><span class="p">:</span> <span class="s1">'./data/TRMM_v7_3B43_1980-2010.nc,</span> +<span class="go"> 'variable': 'pcp'}</span> +<span class="gp">>>> </span><span class="n">loader</span> <span class="o">=</span> <span class="n">DatasetLoader</span><span class="p">(</span><span class="n">loader_opt1</span><span class="p">,</span> <span class="n">loader_opt2</span><span class="p">)</span> +<span class="go">``</span> +</pre></div> +</div> +<p>Or more conveniently if the loader configuration is defined in a +yaml file named config_file (see RCMES examples): +`` +>>> import yaml +>>> config = yaml.load(open(config_file)) +>>> obs_loader_config = config[‘datasets’][‘reference’] +>>> loader = DatasetLoader(<a href="#id1"><span class="problematic" id="id2">*</span></a>obs_loader_config) +``</p> +<p>As shown in the first example, the dictionary for each argument should +contain a loader name and parameters specific to the particular loader. +Once the configuration is entered, the datasets may be loaded using: +`` +>>> loader.load_datasets() +>>> obs_datasets = loader.datasets +``</p> +<p>Additionally, each dataset must have a <code class="docutils literal"><span class="pre">loader_name</span></code> keyword. This may +be one of the following: +* <code class="docutils literal"><span class="pre">'local'</span></code> - One or multiple dataset files in a local directory +* <code class="docutils literal"><span class="pre">'local_split'</span></code> - A single dataset split accross multiple files in a</p> +<blockquote> +<div>local directory</div></blockquote> +<ul> +<li><dl class="first docutils"> +<dt><code class="docutils literal"><span class="pre">'esgf'</span></code> - Download the dataset from the Earth System Grid</dt> +<dd><p class="first last">Federation</p> +</dd> +</dl> +</li> +<li><dl class="first docutils"> +<dt><code class="docutils literal"><span class="pre">'rcmed'</span></code> - Download the dataset from the Regional Climate Model</dt> +<dd><p class="first last">Evaluation System Database</p> +</dd> +</dl> +</li> +<li><p class="first"><code class="docutils literal"><span class="pre">'dap'</span></code> - Download the dataset from an OPeNDAP URL</p> +</li> +<li><dl class="first docutils"> +<dt><code class="docutils literal"><span class="pre">'podaac'</span></code> - Download the dataset from Physical Oceanography</dt> +<dd><p class="first last">Distributed Active Archive Center</p> +</dd> +</dl> +</li> +</ul> +<p>Users who wish to load datasets from loaders not described above may +define their own custom dataset loader function and incorporate it as +follows: +>>> loader.add_source_loader(‘my_loader_name’, my_loader_func)</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>loader_opts</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">dict</span></code></a>) – Dictionaries containing the each dataset loader +configuration, representing the keyword arguments of +the loader function specified by an additional key +called ‘loader_name’. If not specified by the user, +this defaults to local.</td> +</tr> +<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>KeyError</strong> – If an invalid argument is passed to a data source</td> +</tr> +</tbody> +</table> +<p>loader function.</p> +<dl class="method"> +<dt id="dataset_loader.DatasetLoader.add_loader_opts"> +<code class="descname">add_loader_opts</code><span class="sig-paren">(</span><em>*loader_opts</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_loader.DatasetLoader.add_loader_opts" title="Permalink to this definition">¶</a></dt> +<dd><p>A convenient means of adding loader options for each dataset to the +loader.</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>loader_opts</strong> (<code class="xref py py-mod docutils literal"><span class="pre">dict</span></code>) – Dictionaries containing the each dataset loader +configuration, representing the keyword arguments of +the loader function specified by an additional key +called ‘loader_name’. If not specified by the user, +this defaults to local.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="dataset_loader.DatasetLoader.add_source_loader"> +<code class="descname">add_source_loader</code><span class="sig-paren">(</span><em>loader_name</em>, <em>loader_func</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_loader.DatasetLoader.add_source_loader" title="Permalink to this definition">¶</a></dt> +<dd><p>Add a custom source loader.</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>loader_name</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>) – The name of the data source.</li> +<li><strong>loader_func</strong> – Reference to a custom defined function. This should</li> +</ul> +</td> +</tr> +</tbody> +</table> +<p>return an OCW Dataset object, and have an origin which satisfies +origin[‘source’] == loader_name. +:type loader_func: <code class="xref py py-class docutils literal"><span class="pre">callable</span></code></p> +</dd></dl> + +<dl class="method"> +<dt id="dataset_loader.DatasetLoader.load_datasets"> +<code class="descname">load_datasets</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dataset_loader.DatasetLoader.load_datasets" title="Permalink to this definition">¶</a></dt> +<dd><p>Loads the datasets from the given loader configurations.</p> +</dd></dl> + +<dl class="method"> +<dt id="dataset_loader.DatasetLoader.set_loader_opts"> +<code class="descname">set_loader_opts</code><span class="sig-paren">(</span><em>*loader_opts</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_loader.DatasetLoader.set_loader_opts" title="Permalink to this definition">¶</a></dt> +<dd><p>Reset the dataset loader config.</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>loader_opts</strong> (<code class="xref py py-mod docutils literal"><span class="pre">dict</span></code>) – Dictionaries containing the each dataset loader +configuration, representing the keyword arguments of +the loader function specified by an additional key +called ‘loader_name’. If not specified by the user, +this defaults to local.</td> +</tr> +</tbody> +</table> +</dd></dl> + +</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><div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../index.html">Documentation overview</a><ul> + <li>Previous: <a href="dataset.html" title="previous chapter">Dataset Module</a></li> + <li>Next: <a href="dataset_processor.html" title="next chapter">Dataset Processor Module</a></li> + </ul></li> +</ul> +</div> + <div role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../_sources/ocw/dataset_loader.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"> + <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> +</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.4.8</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a> + + | + <a href="../_sources/ocw/dataset_loader.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html> \ No newline at end of file Modified: websites/staging/climate/trunk/content/api/current/ocw/dataset_processor.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/ocw/dataset_processor.html (original) +++ websites/staging/climate/trunk/content/api/current/ocw/dataset_processor.html Mon Apr 24 21:37:01 2017 @@ -6,7 +6,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Dataset Processor Module — Apache Open Climate Workbench 1.1.0 documentation</title> + <title>Dataset Processor Module — 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 Module" href="evaluation.html" /> - <link rel="prev" title="Dataset Module" href="dataset.html" /> + <link rel="prev" title="Dataset Loader Module" href="dataset_loader.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.html" title="Evaluation Module" - accesskey="N">next</a> |</li> - <li class="right" > - <a href="dataset.html" title="Dataset Module" - 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,6 +46,25 @@ <div class="section" id="module-dataset_processor"> <span id="dataset-processor-module"></span><h1>Dataset Processor Module<a class="headerlink" href="#module-dataset_processor" title="Permalink to this headline">¶</a></h1> <dl class="function"> +<dt id="dataset_processor.deseasonalize_dataset"> +<code class="descclassname">dataset_processor.</code><code class="descname">deseasonalize_dataset</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_processor.deseasonalize_dataset" title="Permalink to this definition">¶</a></dt> +<dd><p>Calculate daily climatology and subtract the climatology from +the input dataset</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="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 to convert.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A Dataset with values converted to new units.</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> <dt id="dataset_processor.ensemble"> <code class="descclassname">dataset_processor.</code><code class="descname">ensemble</code><span class="sig-paren">(</span><em>datasets</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_processor.ensemble" title="Permalink to this definition">¶</a></dt> <dd><p>Generate a single dataset which is the mean of the input datasets</p> @@ -101,7 +104,7 @@ Force monthly data to the first of the m <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> <li><strong>dataset</strong> (<a class="reference internal" href="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 which will have its time value normalized.</li> -<li><strong>timestep</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>) – The timestep of the Dataset’s values. Either ‘daily’ or +<li><strong>timestep</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>) – The timestep of the Dataset’s values. Either ‘daily’ or ‘monthly’.</li> </ul> </td> @@ -118,9 +121,9 @@ Force monthly data to the first of the m <dl class="function"> <dt id="dataset_processor.safe_subset"> -<code class="descclassname">dataset_processor.</code><code class="descname">safe_subset</code><span class="sig-paren">(</span><em>subregion</em>, <em>target_dataset</em>, <em>subregion_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_processor.safe_subset" title="Permalink to this definition">¶</a></dt> -<dd><p>Safely subset given dataset with subregion information</p> -<p>A standard subset requires that the provided subregion be entirely +<code class="descclassname">dataset_processor.</code><code class="descname">safe_subset</code><span class="sig-paren">(</span><em>target_dataset</em>, <em>subregion</em>, <em>subregion_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_processor.safe_subset" title="Permalink to this definition">¶</a></dt> +<dd><p>Safely subset given dataset with subregion information +A standard subset requires that the provided subregion be entirely contained within the datasets bounds. <cite>safe_subset</cite> returns the overlap of the subregion and dataset without returning an error.</p> <table class="docutils field-list" frame="void" rules="none"> @@ -130,7 +133,7 @@ overlap of the subregion and dataset wit <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> <li><strong>subregion</strong> (<a class="reference internal" href="dataset.html#dataset.Bounds" title="dataset.Bounds"><code class="xref py py-class docutils literal"><span class="pre">dataset.Bounds</span></code></a>) – The Bounds with which to subset the target Dataset.</li> <li><strong>target_dataset</strong> (<a class="reference internal" href="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 object to subset.</li> -<li><strong>subregion_name</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>) – The subset-ed Dataset name</li> +<li><strong>subregion_name</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>) – The subset-ed Dataset name</li> </ul> </td> </tr> @@ -154,9 +157,9 @@ overlap of the subregion and dataset wit <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> <li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – Dataset object that needs spatially regridded</li> -<li><strong>new_latitudes</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – Array of latitudes</li> -<li><strong>new_longitudes</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.11)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – Array of longitudes</li> -<li><strong>boundary_check</strong> (<em>:class:’bool’</em>) – Check if the regriding domain’s boundaries +<li><strong>new_latitudes</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – Array of latitudes</li> +<li><strong>new_longitudes</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) – Array of longitudes</li> +<li><strong>boundary_check</strong> (<em>:class:'bool'</em>) – Check if the regriding domain’s boundaries are outside target_dataset’s domain</li> </ul> </td> @@ -173,7 +176,7 @@ are outside target_dataset’s domai <dl class="function"> <dt id="dataset_processor.subset"> -<code class="descclassname">dataset_processor.</code><code class="descname">subset</code><span class="sig-paren">(</span><em>subregion</em>, <em>target_dataset</em>, <em>subregion_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_processor.subset" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">dataset_processor.</code><code class="descname">subset</code><span class="sig-paren">(</span><em>target_dataset, subregion, subregion_name=None, extract=True, user_mask_values=[1]</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_processor.subset" title="Permalink to this definition">¶</a></dt> <dd><p>Subset given dataset(s) with subregion information</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> @@ -182,7 +185,9 @@ are outside target_dataset’s domai <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> <li><strong>subregion</strong> (<a class="reference internal" href="dataset.html#dataset.Bounds" title="dataset.Bounds"><code class="xref py py-class docutils literal"><span class="pre">dataset.Bounds</span></code></a>) – The Bounds with which to subset the target Dataset.</li> <li><strong>target_dataset</strong> (<a class="reference internal" href="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 object to subset.</li> -<li><strong>subregion_name</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>) – The subset-ed Dataset name</li> +<li><strong>subregion_name</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>) – The subset-ed Dataset name</li> +<li><strong>extract</strong> (<code class="xref py py-mod docutils literal"><span class="pre">boolean</span></code>) – If False, the dataset inside regions will be masked.</li> +<li><strong>user_mask_value</strong> (<code class="xref py py-mod docutils literal"><span class="pre">int</span></code>) – grid points where mask_variable == user_mask_value will be extracted or masked .</li> </ul> </td> </tr> @@ -202,24 +207,14 @@ are outside target_dataset’s domai <dl class="function"> <dt id="dataset_processor.temperature_unit_conversion"> <code class="descclassname">dataset_processor.</code><code class="descname">temperature_unit_conversion</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_processor.temperature_unit_conversion" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert temperature units as necessary</p> -<p>Automatically convert Celcius to Kelvin in the given dataset.</p> +<dd><p>Convert temperature units as necessary Automatically convert Celcius to Kelvin in the given dataset.</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> – The dataset for which units should be updated.</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dataset</strong> – The dataset for which units should be updated. :type dataset; <a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a></td> </tr> -</tbody> -</table> -<p>:type dataset; <a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a></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">Returns:</th><td class="field-body">The dataset with (potentially) updated units.</td> -</tr> -<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a></td> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The dataset with (potentially) updated units. :rtype: <a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a></td> </tr> </tbody> </table> @@ -235,7 +230,7 @@ are outside target_dataset’s domai <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> <li><strong>target_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a>) – Dataset object that needs temporal rebinned</li> -<li><strong>temporal_resolution</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>) – The new temporal resolution</li> +<li><strong>temporal_resolution</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>) – The new temporal resolution</li> </ul> </td> </tr> @@ -278,7 +273,7 @@ length of time dimension in the rebinned <dl class="function"> <dt id="dataset_processor.temporal_slice"> -<code class="descclassname">dataset_processor.</code><code class="descname">temporal_slice</code><span class="sig-paren">(</span><em>start_time_index</em>, <em>end_time_index</em>, <em>target_dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_processor.temporal_slice" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">dataset_processor.</code><code class="descname">temporal_slice</code><span class="sig-paren">(</span><em>target_dataset</em>, <em>start_time</em>, <em>end_time</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_processor.temporal_slice" title="Permalink to this definition">¶</a></dt> <dd><p>Temporally slice given dataset(s) with subregion information. This does not spatially subset the target_Dataset</p> <table class="docutils field-list" frame="void" rules="none"> @@ -286,8 +281,8 @@ spatially subset the target_Dataset</p> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>start_time_index</strong> (<em>:class:’int’</em>) – time index of the start time</li> -<li><strong>end_time_index</strong> (<em>:class:’int’</em>) – time index of the end time</li> +<li><strong>start_time</strong> (<em>:class:'int'</em>) – start time</li> +<li><strong>end_time</strong> (<em>:class:'datetime.datetime'</em>) – end time</li> <li><strong>target_dataset</strong> (<a class="reference internal" href="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 object to subset.</li> </ul> </td> @@ -307,17 +302,17 @@ spatially subset the target_Dataset</p> <dl class="function"> <dt id="dataset_processor.temporal_subset"> -<code class="descclassname">dataset_processor.</code><code class="descname">temporal_subset</code><span class="sig-paren">(</span><em>month_start</em>, <em>month_end</em>, <em>target_dataset</em>, <em>average_each_year=False</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_processor.temporal_subset" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">dataset_processor.</code><code class="descname">temporal_subset</code><span class="sig-paren">(</span><em>target_dataset</em>, <em>month_start</em>, <em>month_end</em>, <em>average_each_year=False</em><span class="sig-paren">)</span><a class="headerlink" href="#dataset_processor.temporal_subset" title="Permalink to this definition">¶</a></dt> <dd><p>Temporally subset data given month_index.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>month_start</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) – An integer for beginning month (Jan=1)</li> -<li><strong>month_end</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) – An integer for ending month (Jan=1)</li> +<li><strong>month_start</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) – An integer for beginning month (Jan=1)</li> +<li><strong>month_end</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) – An integer for ending month (Jan=1)</li> <li><strong>target_dataset</strong> (<em>Open Climate Workbench Dataset Object</em>) – Dataset object that needs temporal subsetting</li> -<li><strong>average_each_year</strong> (<em>:class:’boolean’</em>) – If True, output dataset is averaged for each year</li> +<li><strong>average_each_year</strong> (<em>:class:'boolean'</em>) – If True, output dataset is averaged for each year</li> </ul> </td> </tr> @@ -381,7 +376,7 @@ For temperature, convert Celcius to Kelv <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>dataset</strong> (<a class="reference internal" href="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 to write.</li> -<li><strong>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>) – The output file path.</li> +<li><strong>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>) – The output file path.</li> </ul> </td> </tr> @@ -399,13 +394,15 @@ For temperature, convert Celcius to Kelv <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="dataset.html" - title="previous chapter">Dataset Module</a></p> - <h4>Next topic</h4> - <p class="topless"><a href="evaluation.html" - title="next chapter">Evaluation Module</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="dataset_loader.html" title="previous chapter">Dataset Loader Module</a></li> + <li>Next: <a href="evaluation.html" title="next chapter">Evaluation Module</a></li> + </ul></li> +</ul> +</div> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> @@ -416,14 +413,11 @@ For temperature, convert Celcius to Kelv <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> @@ -434,12 +428,12 @@ For temperature, convert Celcius to Kelv ©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/ocw/dataset_processor.txt" - rel="nofollow">Page source</a></li> + rel="nofollow">Page source</a> </div>