Added: websites/staging/climate/trunk/content/api/current/ocw/statistical_downscaling.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/ocw/statistical_downscaling.html (added) +++ websites/staging/climate/trunk/content/api/current/ocw/statistical_downscaling.html Wed May 2 18:42:25 2018 @@ -0,0 +1,203 @@ + +<!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>Downscaling Module — Apache Open Climate Workbench 1.3.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.3.0', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </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="next" title="Utils Module" href="utils.html" /> + <link rel="prev" title="Plotter Module" href="plotter.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> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <div class="section" id="downscaling-module"> +<h1>Downscaling Module<a class="headerlink" href="#downscaling-module" title="Permalink to this headline">¶</a></h1> +<div class="section" id="downscaling"> +<h2>Downscaling<a class="headerlink" href="#downscaling" title="Permalink to this headline">¶</a></h2> +<dl class="class"> +<dt id="statistical_downscaling.Downscaling"> +<em class="property">class </em><code class="descclassname">statistical_downscaling.</code><code class="descname">Downscaling</code><span class="sig-paren">(</span><em>ref_dataset</em>, <em>model_present</em>, <em>model_future</em><span class="sig-paren">)</span><a class="headerlink" href="#statistical_downscaling.Downscaling" title="Permalink to this definition">¶</a></dt> +<dd><p>Statistical downscaling infers higher resolution information from lower resolution data. +For example, data collected at a more coarse regional level applied to a more refined +local level.</p> +<p>Statistical downscaling establishes a relationship between different variables in the large scale +and the local scale and applies that relationship to the local scale.</p> +<p>Default Downscaling 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 last simple"> +<li><strong>ref_dataset</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><em>Dataset</em></a>) â The Dataset to use as the reference dataset (observation)</li> +<li><strong>model_present</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><em>Dataset</em></a>) â model simulation to be compared with observation</li> +<li><strong>model_future</strong> (<a class="reference internal" href="dataset.html#dataset.Dataset" title="dataset.Dataset"><em>Dataset</em></a>) â model simulation to be calibrated for prediction</li> +</ul> +</td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="statistical_downscaling.Downscaling.Asynchronous_regression"> +<code class="descname">Asynchronous_regression</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#statistical_downscaling.Downscaling.Asynchronous_regression" title="Permalink to this definition">¶</a></dt> +<dd><p>Remove the biases by fitting a linear regression model with ordered observational and +model datasets</p> +<p>Stoner et al (2013) An asynchronous regional regression model for statistical downscaling of +daily climate variables</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">downscaled model_present and model_future</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="statistical_downscaling.Downscaling.Delta_addition"> +<code class="descname">Delta_addition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#statistical_downscaling.Downscaling.Delta_addition" title="Permalink to this definition">¶</a></dt> +<dd><dl class="docutils"> +<dt>Calculate the mean difference between future and present simulation,</dt> +<dd>then add the difference to the observed distribution</dd> +</dl> +<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">downscaled model_present and model_future</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="statistical_downscaling.Downscaling.Delta_correction"> +<code class="descname">Delta_correction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#statistical_downscaling.Downscaling.Delta_correction" title="Permalink to this definition">¶</a></dt> +<dd><dl class="docutils"> +<dt>Calculate the mean difference between observation and present simulation,</dt> +<dd>then add the difference to the future distribution</dd> +</dl> +<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">downscaled model_present and model_future</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="statistical_downscaling.Downscaling.Quantile_mapping"> +<code class="descname">Quantile_mapping</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#statistical_downscaling.Downscaling.Quantile_mapping" title="Permalink to this definition">¶</a></dt> +<dd><p>Remove the biases for each quantile value</p> +<p>Wood et al (2004) HYDROLOGIC IMPLICATIONS OF DYNAMICAL +AND STATISTICAL APPROACHES TO DOWNSCALING CLIMATE MODEL OUTPUTS</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">downscaled model_present and model_future</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> + <p class="logo"><a href="../index.html"> + <img class="logo" src="../_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/> + </a></p> + <h3><a href="../index.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">Downscaling Module</a><ul> +<li><a class="reference internal" href="#downscaling">Downscaling</a></li> +</ul> +</li> +</ul> +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../index.html">Documentation overview</a><ul> + <li>Previous: <a href="plotter.html" title="previous chapter">Plotter Module</a></li> + <li>Next: <a href="utils.html" title="next chapter">Utils 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/statistical_downscaling.rst.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"> + ©2017, Apache Software Foundation. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.4</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a> + + | + <a href="../_sources/ocw/statistical_downscaling.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html> \ No newline at end of file
Modified: websites/staging/climate/trunk/content/api/current/ocw/utils.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/ocw/utils.html (original) +++ websites/staging/climate/trunk/content/api/current/ocw/utils.html Wed May 2 18:42:25 2018 @@ -1,23 +1,21 @@ + <!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>Utils Module — Apache Open Climate Workbench 1.2.0 documentation</title> - + <title>Utils Module — Apache Open Climate Workbench 1.3.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', + VERSION: '1.3.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> @@ -25,9 +23,8 @@ <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="Data Sources" href="../data_source/data_sources.html" /> - <link rel="prev" title="Plotter Module" href="plotter.html" /> + <link rel="prev" title="Downscaling Module" href="statistical_downscaling.html" /> <link rel="stylesheet" href="../_static/custom.css" type="text/css" /> @@ -35,7 +32,7 @@ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> </head> - <body role="document"> + <body> <div class="document"> @@ -52,7 +49,7 @@ <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>domain_name</strong> (<em>:mod:'string'</em>) – CORDEX domain name (<a class="reference external" href="http://www.cordex.org/">http://www.cordex.org/</a>)</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>domain_name</strong> (<em>:mod:'string'</em>) â CORDEX domain name (<a class="reference external" href="http://www.cordex.org/">http://www.cordex.org/</a>)</td> </tr> </tbody> </table> @@ -66,7 +63,7 @@ <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>) – Dataset object</td> +<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>) â Dataset object</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">time series for the dataset of shape (nT)</td> </tr> @@ -85,14 +82,14 @@ but the min year allowed in Python is 1 <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>) – Monthly binned Dataset object with the number of months +<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>) â Monthly binned Dataset object with the number of months divisible by 12</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Mean values for each month of the year of shape (12, num_lats, num_lons) and times array of datetime objects of length 12</td> </tr> -<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> – If the number of monthly bins is not divisible by 12</td> +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> â If the number of monthly bins is not divisible by 12</td> </tr> </tbody> </table> @@ -101,18 +98,18 @@ of length 12</td> <dl class="function"> <dt id="utils.calc_climatology_year"> <code class="descclassname">utils.</code><code class="descname">calc_climatology_year</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.calc_climatology_year" title="Permalink to this definition">¶</a></dt> -<dd><p>Calculate climatology of dataset’s values for each year</p> +<dd><p>Calculate climatology of datasetâs values for each year</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>) – Monthly binned Dataset object with an evenly divisible +<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>) â Monthly binned Dataset object with an evenly divisible number of months.</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Mean values for each year (annual_mean) and mean values for all years (total_mean)</td> </tr> -<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> – If the number of monthly bins is not evenly divisible +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> â If the number of monthly bins is not evenly divisible by 12.</td> </tr> </tbody> @@ -128,8 +125,8 @@ by 12.</td> <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_array</strong> – An array of OCW Dataset Objects :type list: :mod:’list’</li> -<li><strong>subregions</strong> – list of subregions :type subregions: <code class="xref py py-class docutils literal"><span class="pre">numpy.ma.array</span></code></li> +<li><strong>dataset_array</strong> â An array of OCW Dataset Objects :type list: :mod:âlistâ</li> +<li><strong>subregions</strong> â list of subregions :type subregions: <code class="xref py py-class docutils literal"><span class="pre">numpy.ma.array</span></code></li> </ul> </td> </tr> @@ -143,12 +140,12 @@ by 12.</td> <dl class="function"> <dt id="utils.calc_temporal_mean"> <code class="descclassname">utils.</code><code class="descname">calc_temporal_mean</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.calc_temporal_mean" title="Permalink to this definition">¶</a></dt> -<dd><p>Calculate temporal mean of dataset’s values</p> +<dd><p>Calculate temporal mean of datasetâs values</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>) – OCW Dataset whose first dimension is time</td> +<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>) â OCW Dataset whose first dimension is time</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Mean values averaged for the first dimension (time)</td> </tr> @@ -164,7 +161,7 @@ by 12.</td> <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>) – Dataset object</td> +<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>) â Dataset object</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">time series for the dataset of shape (nT)</td> </tr> @@ -177,16 +174,16 @@ by 12.</td> <code class="descclassname">utils.</code><code class="descname">calculate_ensemble_temporal_trends</code><span class="sig-paren">(</span><em>timeseries_array</em>, <em>number_of_samples=1000</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.calculate_ensemble_temporal_trends" title="Permalink to this definition">¶</a></dt> <dd><p>Calculate temporal trends in an ensemble of time series :param timeseries_array: Two dimensional array. 1st index: model, 2nd index: time. -:type timeseries_array: :class:<a href="#id1"><span class="problematic" id="id2">`</span></a>numpy.ndarray’</p> +:type timeseries_array: <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.14)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</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">Parameters:</th><td class="field-body"><strong>sampling</strong> – A list whose elements are one-dimensional numpy arrays</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sampling</strong> â A list whose elements are one-dimensional numpy arrays</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">temporal trend and estimated error from bootstrapping</td> </tr> -<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">:float:<a href="#id5"><span class="problematic" id="id6">`</span></a>float’,’float’</td> +<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/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> @@ -195,18 +192,18 @@ by 12.</td> <dl class="function"> <dt id="utils.calculate_temporal_trend_of_time_series"> <code class="descclassname">utils.</code><code class="descname">calculate_temporal_trend_of_time_series</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.calculate_temporal_trend_of_time_series" title="Permalink to this definition">¶</a></dt> -<dd><p>Calculate least-square trends (a) in y = ax+b and a’s standard error +<dd><p>Calculate least-square trends (a) in y = ax+b and aâs standard error :param x: time series -:type x: :class:<a href="#id7"><span class="problematic" id="id8">`</span></a>numpy.ndarray’</p> +:type x: <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.14)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</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">Parameters:</th><td class="field-body"><strong>x</strong> (:class:<a href="#id9"><span class="problematic" id="id10">`</span></a>numpy.ndarray’) – time series</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.14)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) â time series</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">temporal trend and standard error</td> </tr> -<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">:float:<a href="#id11"><span class="problematic" id="id12">`</span></a>float’,’float’</td> +<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/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> @@ -217,7 +214,7 @@ by 12.</td> <code class="descclassname">utils.</code><code class="descname">calculate_temporal_trends</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.calculate_temporal_trends" title="Permalink to this definition">¶</a></dt> <dd><p>Calculate temporal trends in dataset.values :param dataset: The dataset from which time values should be extracted. -:type dataset: :class:<a href="#id13"><span class="problematic" id="id14">`</span></a>dataset.Dataset’</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" /> @@ -239,16 +236,16 @@ by 12.</td> <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</strong> (<em>netCDF4.Dataset</em>) – The dataset from which time values should be extracted.</li> -<li><strong>time_var_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 time variable in dataset.</li> +<li><strong>dataset</strong> (<em>netCDF4.Dataset</em>) â The dataset from which time values should be extracted.</li> +<li><strong>time_var_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 time variable in dataset.</li> </ul> </td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The list of converted datetime values.</p> </td> </tr> -<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> – If the time units value couldn’t be parsed, if the -base time value couldn’t be parsed, or if the time_var_name could not +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> â If the time units value couldnât be parsed, if the +base time value couldnât be parsed, or if the time_var_name could not be found in the dataset.</p> </td> </tr> @@ -264,7 +261,11 @@ be found in the dataset.</p> <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_array</strong> – an array of OCW datasets</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>dataset_array</strong> â an array of OCW datasets</li> +<li><strong>idx</strong> (class:<cite>tuple</cite>) â start and end indices to denote subset of months used.</li> +</ul> +</td> </tr> </tbody> </table> @@ -282,9 +283,9 @@ expected range.</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>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>) – A 1D numpy array of sorted lat 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>) – A 1D numpy array of sorted lon values.</li> -<li><strong>values</strong> – A 3D array of data values.</li> +<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.14)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) â A 1D numpy array of sorted lat 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.14)"><code class="xref py py-class docutils literal"><span class="pre">numpy.ndarray</span></code></a>) â A 1D numpy array of sorted lon values.</li> +<li><strong>values</strong> â A 3D array of data values.</li> </ul> </td> </tr> @@ -292,7 +293,7 @@ expected range.</p> adjusted_values)</p> </td> </tr> -<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> – If the lat/lon values are not sorted.</p> +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> â If the lat/lon values are not sorted.</p> </td> </tr> </tbody> @@ -307,13 +308,13 @@ adjusted_values)</p> <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>time_format</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 time data units string from the dataset +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>time_format</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 time data units string from the dataset being processed. The string should be of the format -‘<units> since <base time date>’</td> +â<units> since <base time date>â</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The base time string split out of the time units information.</td> </tr> -<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> – When the time_format parameter is malformed.</td> +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> â When the time_format parameter is malformed.</td> </tr> </tbody> </table> @@ -327,14 +328,14 @@ being processed. The string should be of <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>time_format</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 time data units string from the dataset +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>time_format</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 time data units string from the dataset being processed. The string should be of the format -‘<units> since <base time date>’</td> +â<units> since <base time date>â</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The base time as a datetime object.</td> </tr> -<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> – When the base time string couldn’t be parsed from the -units time_format string or if the date string didn’t match any of the +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> â When the base time string couldnât be parsed from the +units time_format string or if the date string didnât match any of the expected formats.</td> </tr> </tbody> @@ -353,13 +354,13 @@ expected formats.</td> <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>time_format</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 time data units string from the dataset +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>time_format</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 time data units string from the dataset being processed. The string should be of the format -‘<units> since <base time date>’</td> +â<units> since <base time date>â</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The unit substring from the time units string</td> </tr> -<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> – If the units present in the time units string doesn’t +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> â If the units present in the time units string doesnât match one of the supported unit value.</td> </tr> </tbody> @@ -370,20 +371,20 @@ match one of the supported unit value.</ <dt id="utils.reshape_monthly_to_annually"> <code class="descclassname">utils.</code><code class="descname">reshape_monthly_to_annually</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.reshape_monthly_to_annually" title="Permalink to this definition">¶</a></dt> <dd><p>Reshape monthly binned dataset to annual bins.</p> -<p>Reshape a monthly binned dataset’s 3D value array with shape +<p>Reshape a monthly binned datasetâs 3D value array with shape (num_months, num_lats, num_lons) to a 4D array with shape (num_years, 12, num_lats, num_lons). This causes the data to be binned annually while retaining its original shape.</p> <p>It is assumed that the number of months in the dataset is evenly divisible by 12. If it is not you will receive error due to an invalid shape.</p> -<p>Example change of a dataset’s shape: +<p>Example change of a datasetâs shape: (24, 90, 180) -> (2, 12, 90, 180)</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>) – Dataset object with full-year format</td> +<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>) â Dataset object with full-year format</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Dataset values array with shape (num_year, 12, num_lat, num_lon)</td> </tr> @@ -399,8 +400,8 @@ an invalid shape.</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 last simple"> -<li><strong>boundary_type</strong> (<em>:mod:'string'</em>) – The type of spatial subset boundary</li> -<li><strong>region_names</strong> (<em>:mod:'list'</em>) – An array of regions for spatial subset</li> +<li><strong>boundary_type</strong> (<em>:mod:'string'</em>) â The type of spatial subset boundary</li> +<li><strong>region_names</strong> (<em>:mod:'list'</em>) â An array of regions for spatial subset</li> </ul> </td> </tr> @@ -408,6 +409,22 @@ an invalid shape.</p> </table> </dd></dl> +<dl class="function"> +<dt id="utils.trim_dataset"> +<code class="descclassname">utils.</code><code class="descname">trim_dataset</code><span class="sig-paren">(</span><em>dataset</em><span class="sig-paren">)</span><a class="headerlink" href="#utils.trim_dataset" title="Permalink to this definition">¶</a></dt> +<dd><p>Trim datasets such that first and last year of data have all 12 months</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>) â Dataset object</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Slice index for trimmed dataset</td> +</tr> +</tbody> +</table> +</dd></dl> + </div> @@ -422,7 +439,7 @@ an invalid shape.</p> <h3>Related Topics</h3> <ul> <li><a href="../index.html">Documentation overview</a><ul> - <li>Previous: <a href="plotter.html" title="previous chapter">Plotter Module</a></li> + <li>Previous: <a href="statistical_downscaling.html" title="previous chapter">Downscaling Module</a></li> <li>Next: <a href="../data_source/data_sources.html" title="next chapter">Data Sources</a></li> </ul></li> </ul> @@ -430,7 +447,7 @@ an invalid shape.</p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> - <li><a href="../_sources/ocw/utils.txt" + <li><a href="../_sources/ocw/utils.rst.txt" rel="nofollow">Show Source</a></li> </ul> </div> @@ -449,14 +466,14 @@ an invalid shape.</p> <div class="clearer"></div> </div> <div class="footer"> - ©2016, Apache Software Foundation. + ©2017, 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> + Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.4</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a> | - <a href="../_sources/ocw/utils.txt" + <a href="../_sources/ocw/utils.rst.txt" rel="nofollow">Page source</a> </div> Modified: websites/staging/climate/trunk/content/api/current/py-modindex.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/py-modindex.html (original) +++ websites/staging/climate/trunk/content/api/current/py-modindex.html Wed May 2 18:42:25 2018 @@ -1,23 +1,21 @@ + <!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>Python Module Index — Apache Open Climate Workbench 1.2.0 documentation</title> - + <title>Python Module Index — Apache Open Climate Workbench 1.3.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', + VERSION: '1.3.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="_static/jquery.js"></script> @@ -25,7 +23,6 @@ <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="stylesheet" href="_static/custom.css" type="text/css" /> @@ -40,7 +37,7 @@ </head> - <body role="document"> + <body> <div class="document"> @@ -53,6 +50,7 @@ <div class="modindex-jumpbox"> <a href="#cap-d"><strong>d</strong></a> | + <a href="#cap-e"><strong>e</strong></a> | <a href="#cap-l"><strong>l</strong></a> | <a href="#cap-m"><strong>m</strong></a> | <a href="#cap-o"><strong>o</strong></a> | @@ -61,13 +59,18 @@ <a href="#cap-u"><strong>u</strong></a> </div> - <table class="indextable modindextable" cellspacing="0" cellpadding="2"> + <table class="indextable modindextable"> <tr class="pcap"><td></td><td> </td><td></td></tr> <tr class="cap" id="cap-d"><td></td><td> <strong>d</strong></td><td></td></tr> <tr> <td></td> <td> + <a href="data_source/data_sources.html#module-dap"><code class="xref">dap</code></a></td><td> + <em></em></td></tr> + <tr> + <td></td> + <td> <a href="ocw/dataset_loader.html#module-dataset_loader"><code class="xref">dataset_loader</code></a></td><td> <em></em></td></tr> <tr> @@ -76,6 +79,14 @@ <a href="ocw/dataset_processor.html#module-dataset_processor"><code class="xref">dataset_processor</code></a></td><td> <em></em></td></tr> <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="cap" id="cap-e"><td></td><td> + <strong>e</strong></td><td></td></tr> + <tr> + <td></td> + <td> + <a href="data_source/data_sources.html#module-esgf"><code class="xref">esgf</code></a></td><td> + <em></em></td></tr> + <tr class="pcap"><td></td><td> </td><td></td></tr> <tr class="cap" id="cap-l"><td></td><td> <strong>l</strong></td><td></td></tr> <tr> @@ -166,11 +177,11 @@ <div class="clearer"></div> </div> <div class="footer"> - ©2016, Apache Software Foundation. + ©2017, 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> + Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.4</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a> </div> Modified: websites/staging/climate/trunk/content/api/current/search.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/search.html (original) +++ websites/staging/climate/trunk/content/api/current/search.html Wed May 2 18:42:25 2018 @@ -1,23 +1,21 @@ + <!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>Search — Apache Open Climate Workbench 1.2.0 documentation</title> - + <title>Search — Apache Open Climate Workbench 1.3.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', + VERSION: '1.3.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="_static/jquery.js"></script> @@ -26,7 +24,6 @@ <script type="text/javascript" src="_static/searchtools.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="#" /> - <link rel="top" title="Apache Open Climate Workbench 1.2.0 documentation" href="index.html" /> <script type="text/javascript"> jQuery(function() { Search.loadIndex("searchindex.js"); }); </script> @@ -41,7 +38,7 @@ </head> - <body role="document"> + <body> <div class="document"> @@ -92,11 +89,11 @@ <div class="clearer"></div> </div> <div class="footer"> - ©2016, Apache Software Foundation. + ©2017, 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> + Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.4</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a> </div>