Added: websites/staging/climate/trunk/content/api/1.0.0/config/evaluation_settings.html ============================================================================== --- websites/staging/climate/trunk/content/api/1.0.0/config/evaluation_settings.html (added) +++ websites/staging/climate/trunk/content/api/1.0.0/config/evaluation_settings.html Wed Jul 27 17:50:56 2016 @@ -0,0 +1,161 @@ +<!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.0.0 documentation</title> + + <link rel="stylesheet" href="../_static/default.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.0.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.0.0 documentation" href="../index.html" /> + </head> + <body> + <div class="related"> + <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><a href="../index.html">Apache Open Climate Workbench 1.0.0 documentation</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <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"><tt class="xref py py-func docutils literal"><span class="pre">dataset_processor.temporal_rebin()</span></tt></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)"><tt class="xref py py-class docutils literal"><span class="pre">datetime.timedelta</span></tt></a> object before running the <a class="reference internal" href="../ocw/dataset_processor.html#dataset_processor.temporal_rebin" title="dataset_processor.temporal_rebin"><tt class="xref py py-func docutils literal"><span class="pre">dat aset_processor.temporal_rebin()</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">evaluation.Evaluation</span></tt></a> object with the <tt class="xref py py-func docutils literal"><span class="pre">evaluation_creation.generate_evaluation_from_config()</span></tt> 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"><tt class="xref py py-func docutils literal"><span class="pre">dataset_processor.spatial_regrid()</span></tt></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.9)"><tt class="xref py py-func docutils literal"><span class="pre">numpy.arange()</span></tt></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.9)"><tt class="xref py py-func docutils literal"><span class="pre">numpy.arange()</span></tt></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"> + <div class="sphinxsidebarwrapper"> + <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> + + <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 id="searchbox" style="display: none"> + <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="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + >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><a href="../index.html">Apache Open Climate Workbench 1.0.0 documentation</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2013, Apache Software Foundation. + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.2.1. + </div> + </body> +</html> \ No newline at end of file
Added: websites/staging/climate/trunk/content/api/1.0.0/config/metrics_information.html ============================================================================== --- websites/staging/climate/trunk/content/api/1.0.0/config/metrics_information.html (added) +++ websites/staging/climate/trunk/content/api/1.0.0/config/metrics_information.html Wed Jul 27 17:50:56 2016 @@ -0,0 +1,112 @@ +<!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.0.0 documentation</title> + + <link rel="stylesheet" href="../_static/default.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.0.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.0.0 documentation" href="../index.html" /> + </head> + <body> + <div class="related"> + <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><a href="../index.html">Apache Open Climate Workbench 1.0.0 documentation</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <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 <tt class="xref py py-mod docutils literal"><span class="pre">ocw.metrics</span></tt>. 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 <tt class="xref py py-mod docutils literal"><span class="pre">ocw.metrics</span></tt> 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"> + <div class="sphinxsidebarwrapper"> + <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 id="searchbox" style="display: none"> + <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="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + >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><a href="../index.html">Apache Open Climate Workbench 1.0.0 documentation</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2013, Apache Software Foundation. + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.2.1. + </div> + </body> +</html> \ No newline at end of file Added: websites/staging/climate/trunk/content/api/1.0.0/config/plots_settings.html ============================================================================== --- websites/staging/climate/trunk/content/api/1.0.0/config/plots_settings.html (added) +++ websites/staging/climate/trunk/content/api/1.0.0/config/plots_settings.html Wed Jul 27 17:50:56 2016 @@ -0,0 +1,150 @@ +<!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.0.0 documentation</title> + + <link rel="stylesheet" href="../_static/default.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.0.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.0.0 documentation" href="../index.html" /> + </head> + <body> + <div class="related"> + <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><a href="../index.html">Apache Open Climate Workbench 1.0.0 documentation</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <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"><tt class="xref py py-class docutils literal"><span class="pre">evaluation.Evaluation</span></tt></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 <tt class="xref py py-func docutils literal"><span class="pre">plotting.draw_contour_map()</span></tt>:</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 <tt class="xref py py-func docutils literal"><span class="pre">plotting.draw_contour_map()</span></tt> function with the <strong>optional_args</strong> flag.</p> +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + <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> + + <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 id="searchbox" style="display: none"> + <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="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + >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><a href="../index.html">Apache Open Climate Workbench 1.0.0 documentation</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2013, Apache Software Foundation. + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.2.1. + </div> + </body> +</html> \ No newline at end of file Added: websites/staging/climate/trunk/content/api/1.0.0/data_source/data_sources.html ============================================================================== --- websites/staging/climate/trunk/content/api/1.0.0/data_source/data_sources.html (added) +++ websites/staging/climate/trunk/content/api/1.0.0/data_source/data_sources.html Wed Jul 27 17:50:56 2016 @@ -0,0 +1,373 @@ +<!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>Data Sources — Apache Open Climate Workbench 1.0.0 documentation</title> + + <link rel="stylesheet" href="../_static/default.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.0.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.0.0 documentation" href="../index.html" /> + <link rel="next" title="Evaluation UI Webservices" href="../ui-backend/backend.html" /> + <link rel="prev" title="Utils Module" href="../ocw/utils.html" /> + </head> + <body> + <div class="related"> + <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="../ui-backend/backend.html" title="Evaluation UI Webservices" + accesskey="N">next</a> |</li> + <li class="right" > + <a href="../ocw/utils.html" title="Utils Module" + accesskey="P">previous</a> |</li> + <li><a href="../index.html">Apache Open Climate Workbench 1.0.0 documentation</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <div class="section" id="data-sources"> +<h1>Data Sources<a class="headerlink" href="#data-sources" title="Permalink to this headline">¶</a></h1> +<div class="section" id="module-local"> +<span id="local-module"></span><h2>Local Module<a class="headerlink" href="#module-local" title="Permalink to this headline">¶</a></h2> +<dl class="function"> +<dt id="local.load_WRF_2d_files"> +<tt class="descclassname">local.</tt><tt class="descname">load_WRF_2d_files</tt><big>(</big><em>file_path</em>, <em>filename_pattern</em>, <em>variable_name</em>, <em>name=''</em><big>)</big><a class="headerlink" href="#local.load_WRF_2d_files" title="Permalink to this definition">¶</a></dt> +<dd><p>Load multiple WRF (or nuWRF) original output files containing 2D fields such as precipitation and surface variables into a Dataset. +The dataset can be spatially subset. +:param file_path: Directory to the NetCDF file to load. +:type file_path: <a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a> +:param filename_pattern: Path to the NetCDF file to load. +:type filename_pattern: <a href="#id1"><span class="problematic" id="id2">:list:`string`</span></a> +:param variable_name: The variable name to load from the NetCDF file. +:type variable_name: <a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a> +:param name: (Optional) A name for the loaded dataset. +:type name: <a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a> +:returns: An OCW Dataset object with the requested variable’s data from</p> +<blockquote> +<div>the NetCDF file.</div></blockquote> +<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">Return type:</th><td class="field-body"><a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><tt class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></tt></a></td> +</tr> +<tr class="field-even field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> +<tr class="field-even field"><td> </td><td class="field-body"></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="local.load_file"> +<tt class="descclassname">local.</tt><tt class="descname">load_file</tt><big>(</big><em>file_path</em>, <em>variable_name</em>, <em>variable_unit=None</em>, <em>elevation_index=0</em>, <em>name=''</em>, <em>lat_name=None</em>, <em>lon_name=None</em>, <em>time_name=None</em><big>)</big><a class="headerlink" href="#local.load_file" title="Permalink to this definition">¶</a></dt> +<dd><p>Load a NetCDF file into a 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"><ul class="first simple"> +<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)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – Path to the NetCDF file to load.</li> +<li><strong>variable_name</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – The variable name to load from the NetCDF file.</li> +<li><strong>variable_unit</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) The variable unit to load from the NetCDF file.</li> +<li><strong>elevation_index</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#int"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">int</span></tt></a>) – (Optional) The elevation index for which data should +be returned. Climate data is often times 4 dimensional data. Some +datasets will have readins at different height/elevation levels. OCW +expects 3D data so a single layer needs to be stripped out when loading. +By default, the first elevation layer is used. If desired you may +specify the elevation value to use.</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)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) A name for the loaded dataset.</li> +<li><strong>lat_name</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) The latitude variable name to extract from the +dataset.</li> +<li><strong>lon_name</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) The longitude variable name to extract from the +dataset.</li> +<li><strong>time_name</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) The time variable name to extract from the +dataset.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object with the requested variable’s data from +the NetCDF file.</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><tt class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></tt></a></p> +</td> +</tr> +<tr class="field-even field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> +<tr class="field-even field"><td> </td><td class="field-body"><p class="first last">When the specified file path cannot be loaded by ndfCDF4 +or when the lat/lon/time variable name cannot be determined +automatically.</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="local.load_multiple_files"> +<tt class="descclassname">local.</tt><tt class="descname">load_multiple_files</tt><big>(</big><em>file_path</em>, <em>variable_name</em>, <em>dataset_name='model'</em>, <em>variable_unit=None</em>, <em>lat_name=None</em>, <em>lon_name=None</em>, <em>time_name=None</em><big>)</big><a class="headerlink" href="#local.load_multiple_files" title="Permalink to this definition">¶</a></dt> +<dd><p>load multiple netcdf files with common filename pattern and return an array of OCW datasets</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>file_path</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – directory name and common file name patterns where the NetCDF files to load are stored.</li> +<li><strong>dataset_name</strong> (<em>:mod:’string’</em>) – a name of dataset when reading a single file</li> +<li><strong>variable_name</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – The variable name to load from the NetCDF file.</li> +<li><strong>variable_unit</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) The variable unit to load from the NetCDF file.</li> +<li><strong>elevation_index</strong> – (Optional) The elevation index for which data should +be returned. Climate data is often times 4 dimensional data. Some +datasets will have readins at different height/elevation levels. OCW +expects 3D data so a single layer needs to be stripped out when loading. +By default, the first elevation layer is used. If desired you may +specify the elevation value to use.</li> +<li><strong>lat_name</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) The latitude variable name to extract from the +dataset.</li> +<li><strong>lon_name</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) The longitude variable name to extract from the +dataset.</li> +<li><strong>time_name</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) The time variable name to extract from the +dataset.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An array of OCW Dataset objects, an array of dataset names</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="http://docs.python.org/2/library/functions.html#list"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a></p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> +<div class="section" id="module-rcmed"> +<span id="rcmed-module"></span><h2>RCMED Module<a class="headerlink" href="#module-rcmed" title="Permalink to this headline">¶</a></h2> +<dl class="docutils"> +<dt>Classes:</dt> +<dd>RCMED - A class for retrieving data from Regional Climate Model Evalutaion Database (JPL).</dd> +</dl> +<dl class="function"> +<dt id="rcmed.get_parameters_metadata"> +<tt class="descclassname">rcmed.</tt><tt class="descname">get_parameters_metadata</tt><big>(</big><big>)</big><a class="headerlink" href="#rcmed.get_parameters_metadata" title="Permalink to this definition">¶</a></dt> +<dd><p>Get the metadata of all parameter from RCMED.</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">Dictionary of information for each parameter stored in one list</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#list"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference external" href="http://docs.python.org/2/library/stdtypes.html#dict"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="rcmed.parameter_dataset"> +<tt class="descclassname">rcmed.</tt><tt class="descname">parameter_dataset</tt><big>(</big><em>dataset_id</em>, <em>parameter_id</em>, <em>min_lat</em>, <em>max_lat</em>, <em>min_lon</em>, <em>max_lon</em>, <em>start_time</em>, <em>end_time</em>, <em>name=''</em><big>)</big><a class="headerlink" href="#rcmed.parameter_dataset" title="Permalink to this definition">¶</a></dt> +<dd><p>Get data from one database(parameter).</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>dataset_id</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#int"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">int</span></tt></a>) – Dataset id.</li> +<li><strong>parameter_id</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#int"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">int</span></tt></a>) – Parameter id</li> +<li><strong>min_lat</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></a>) – Minimum latitude</li> +<li><strong>max_lat</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></a>) – Maximum latitude</li> +<li><strong>min_lon</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></a>) – Minimum longitude</li> +<li><strong>max_lon</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></a>) – Maximum longitude</li> +<li><strong>start_time</strong> (<a class="reference external" href="http://docs.python.org/2/library/datetime.html#datetime.datetime"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt></a>) – Start time</li> +<li><strong>end_time</strong> (<a class="reference external" href="http://docs.python.org/2/library/datetime.html#datetime.datetime"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt></a>) – End time</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)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) A name for the loaded dataset.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object contained the requested data from RCMED.</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><tt class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></tt></a></p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> +<div class="section" id="module-dap"> +<span id="dap-module"></span><h2>DAP Module<a class="headerlink" href="#module-dap" title="Permalink to this headline">¶</a></h2> +<dl class="function"> +<dt id="dap.load"> +<tt class="descclassname">dap.</tt><tt class="descname">load</tt><big>(</big><em>url</em>, <em>variable</em>, <em>name=''</em><big>)</big><a class="headerlink" href="#dap.load" title="Permalink to this definition">¶</a></dt> +<dd><p>Load a Dataset from an OpenDAP URL</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>url</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – The OpenDAP URL for the dataset of interest.</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)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – The name of the variable to read from the dataset.</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)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) A name for the loaded dataset.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A <a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><tt class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></tt></a> containing the dataset pointed to by +the OpenDAP URL.</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">ServerError</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> +<div class="section" id="module-esgf"> +<span id="esgf-module"></span><h2>ESGF Module<a class="headerlink" href="#module-esgf" title="Permalink to this headline">¶</a></h2> +<dl class="function"> +<dt id="esgf.load_dataset"> +<tt class="descclassname">esgf.</tt><tt class="descname">load_dataset</tt><big>(</big><em>dataset_id</em>, <em>variable</em>, <em>esgf_username</em>, <em>esgf_password</em>, <em>search_url='http://esg-datanode.jpl.nasa.gov/esg-search/search'</em>, <em>elevation_index=0</em>, <em>name=''</em>, <em>save_path='/tmp'</em>, <em>**additional_constraints</em><big>)</big><a class="headerlink" href="#esgf.load_dataset" title="Permalink to this definition">¶</a></dt> +<dd><p>Load an ESGF 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"><ul class="first simple"> +<li><strong>dataset_id</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – The ESGF ID of the dataset to load.</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)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – The variable to load.</li> +<li><strong>esgf_username</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – ESGF OpenID value to use for authentication.</li> +<li><strong>esgf_password</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – ESGF Password to use for authentication.</li> +<li><strong>search_url</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) The ESGF node to use for searching. Defaults +to the Jet Propulsion Laboratory node.</li> +<li><strong>elevation_index</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#int"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">int</span></tt></a>) – (Optional) The elevation level to strip out when +loading the dataset using ocw.data_source.local.</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)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) A name for the loaded dataset.</li> +<li><strong>save_path</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string"; title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a>) – (Optional) Path to where downloaded files should be saved.</li> +<li><strong>additional_constraints</strong> – (Optional) Additional key,value pairs to +pass as constraints to the search wrapper. These can be anything found +on the ESGF metadata page for a dataset.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A <a class="reference external" href="http://docs.python.org/2/library/functions.html#list"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><tt class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></tt></a> contained the +requested dataset. If the dataset is stored in multiple files each will +be loaded into a separate <a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><tt class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></tt></a>.</p> +</td> +</tr> +<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"><p class="first last">If no dataset can be found for the supplied ID and +variable, or if the requested dataset is a multi-file dataset.</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + <h3><a href="../index.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">Data Sources</a><ul> +<li><a class="reference internal" href="#module-local">Local Module</a></li> +<li><a class="reference internal" href="#module-rcmed">RCMED Module</a></li> +<li><a class="reference internal" href="#module-dap">DAP Module</a></li> +<li><a class="reference internal" href="#module-esgf">ESGF Module</a></li> +</ul> +</li> +</ul> + + <h4>Previous topic</h4> + <p class="topless"><a href="../ocw/utils.html" + title="previous chapter">Utils Module</a></p> + <h4>Next topic</h4> + <p class="topless"><a href="../ui-backend/backend.html" + title="next chapter">Evaluation UI Webservices</a></p> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../_sources/data_source/data_sources.txt" + rel="nofollow">Show Source</a></li> + </ul> +<div id="searchbox" style="display: none"> + <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="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + >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="../ui-backend/backend.html" title="Evaluation UI Webservices" + >next</a> |</li> + <li class="right" > + <a href="../ocw/utils.html" title="Utils Module" + >previous</a> |</li> + <li><a href="../index.html">Apache Open Climate Workbench 1.0.0 documentation</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2013, Apache Software Foundation. + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.2.1. + </div> + </body> +</html> \ No newline at end of file Added: websites/staging/climate/trunk/content/api/1.0.0/ocw/dataset.html ============================================================================== --- websites/staging/climate/trunk/content/api/1.0.0/ocw/dataset.html (added) +++ websites/staging/climate/trunk/content/api/1.0.0/ocw/dataset.html Wed Jul 27 17:50:56 2016 @@ -0,0 +1,279 @@ +<!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 Module — Apache Open Climate Workbench 1.0.0 documentation</title> + + <link rel="stylesheet" href="../_static/default.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.0.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.0.0 documentation" href="../index.html" /> + <link rel="next" title="Dataset Processor Module" href="dataset_processor.html" /> + <link rel="prev" title="Overview" href="overview.html" /> + </head> + <body> + <div class="related"> + <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><a href="../index.html">Apache Open Climate Workbench 1.0.0 documentation</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <div class="section" id="dataset-module"> +<h1>Dataset Module<a class="headerlink" href="#dataset-module" title="Permalink to this headline">¶</a></h1> +<div class="section" id="bounds"> +<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><tt class="descclassname">dataset.</tt><tt class="descname">Bounds</tt><big>(</big><em>lat_min</em>, <em>lat_max</em>, <em>lon_min</em>, <em>lon_max</em>, <em>start=None</em>, <em>end=None</em><big>)</big><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> +<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> +<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)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></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)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></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)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></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)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></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)"><tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt></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)"><tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt></a>) – An optional datetime object for the ending datetime bound.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">ValueError</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> +<div class="section" id="dataset"> +<h2>Dataset<a class="headerlink" href="#dataset" title="Permalink to this headline">¶</a></h2> +<dl class="class"> +<dt id="dataset.Dataset"> +<em class="property">class </em><tt class="descclassname">dataset.</tt><tt class="descname">Dataset</tt><big>(</big><em>lats</em>, <em>lons</em>, <em>times</em>, <em>values</em>, <em>variable=None</em>, <em>units=None</em>, <em>origin=None</em>, <em>name=''</em><big>)</big><a class="headerlink" href="#dataset.Dataset" title="Permalink to this definition">¶</a></dt> +<dd><p>Container for a dataset’s attributes and data.</p> +<p>Default Dataset constructor</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>lats</strong> (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray"; title="(in NumPy v1.9)"><tt class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></tt></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.9)"><tt class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></tt></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.9)"><tt class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></tt></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.9)"><tt class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></tt></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)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></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)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></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)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></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)"><tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt></a>) – An optional object used to specify information on where +this dataset was loaded from.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">ValueError</p> +</td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="dataset.Dataset.spatial_boundaries"> +<tt class="descname">spatial_boundaries</tt><big>(</big><big>)</big><a class="headerlink" href="#dataset.Dataset.spatial_boundaries" title="Permalink to this definition">¶</a></dt> +<dd><p>Calculate the spatial boundaries.</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’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)"><tt class="xref py py-func docutils literal"><span class="pre">tuple()</span></tt></a> of the form (<a class="reference external" href="http://docs.python.org/2/library/functions.html#float"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></a>, <a class="reference external" href="http://docs.python.org/2/library/functions.html#float"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></a>, +<a class="reference external" href="http://docs.python.org/2/library/functions.html#float"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></a>, <a class="reference external" href="http://docs.python.org/2/library/functions.html#float"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></a>).</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="dataset.Dataset.spatial_resolution"> +<tt class="descname">spatial_resolution</tt><big>(</big><big>)</big><a class="headerlink" href="#dataset.Dataset.spatial_resolution" title="Permalink to this definition">¶</a></dt> +<dd><p>Calculate the latitudinal and longitudinal spatial resolution.</p> +<blockquote> +<div>If self.lats and self.lons are from curvilinear coordinates, +the output resolutions are approximate values.</div></blockquote> +<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’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)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></a>, <a class="reference external" href="http://docs.python.org/2/library/functions.html#float"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></a>)</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="dataset.Dataset.temporal_resolution"> +<tt class="descname">temporal_resolution</tt><big>(</big><big>)</big><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" 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> +<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)"><tt class="xref py py-mod docutils literal"><span class="pre">string</span></tt></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="dataset.Dataset.time_range"> +<tt class="descname">time_range</tt><big>(</big><big>)</big><a class="headerlink" href="#dataset.Dataset.time_range" 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">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-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)"><tt class="xref py py-func docutils literal"><span class="pre">tuple()</span></tt></a> of the form (<a class="reference external" href="http://docs.python.org/2/library/datetime.html#datetime.datetime"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt></a>, +<a class="reference external" href="http://docs.python.org/2/library/datetime.html#datetime.datetime"; title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt></a>)</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + <h3><a href="../index.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">Dataset Module</a><ul> +<li><a class="reference internal" href="#bounds">Bounds</a></li> +<li><a class="reference internal" href="#dataset">Dataset</a></li> +</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> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../_sources/ocw/dataset.txt" + rel="nofollow">Show Source</a></li> + </ul> +<div id="searchbox" style="display: none"> + <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="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + >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" + >next</a> |</li> + <li class="right" > + <a href="overview.html" title="Overview" + >previous</a> |</li> + <li><a href="../index.html">Apache Open Climate Workbench 1.0.0 documentation</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2013, Apache Software Foundation. + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.2.1. + </div> + </body> +</html> \ No newline at end of file
