Modified: websites/staging/climate/trunk/content/api/current/data_source/data_sources.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/data_source/data_sources.html (original) +++ websites/staging/climate/trunk/content/api/current/data_source/data_sources.html Mon Apr 24 21:37:01 2017 @@ -6,7 +6,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Data Sources — Apache Open Climate Workbench 1.1.0 documentation</title> + <title>Data Sources — Apache Open Climate Workbench 1.2.0 documentation</title> <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> @@ -14,7 +14,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', - VERSION: '1.1.0', + VERSION: '1.2.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -23,36 +23,20 @@ <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> - <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="../index.html" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="top" title="Apache Open Climate Workbench 1.2.0 documentation" href="../index.html" /> <link rel="next" title="Evaluation UI Webservices" href="../ui-backend/backend.html" /> <link rel="prev" title="Utils Module" href="../ocw/utils.html" /> + <link rel="stylesheet" href="../_static/custom.css" type="text/css" /> - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> </head> <body role="document"> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="../genindex.html" title="General Index" - accesskey="I">index</a></li> - <li class="right" > - <a href="../http-routingtable.html" title="HTTP Routing Table" - >routing table</a> |</li> - <li class="right" > - <a href="../py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="../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 class="nav-item nav-item-0"><a href="../index.html">Apache Open Climate Workbench 1.1.0 documentation</a> »</li> - </ul> - </div> + <div class="document"> <div class="documentwrapper"> @@ -72,11 +56,11 @@ <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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Directory to the HDF files to load.</li> -<li><strong>filename_pattern</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Path to the HDF files to load.</li> -<li><strong>filelist</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – A list of filenames</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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – The variable name to load from the HDF file.</li> -<li><strong>name</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> +<li><strong>file_path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Directory to the HDF files to load.</li> +<li><strong>filename_pattern</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>) – Path to the HDF files to load.</li> +<li><strong>filelist</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>) – A list of filenames</li> +<li><strong>variable_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 variable name to load from the HDF file.</li> +<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> </ul> </td> </tr> @@ -86,8 +70,7 @@ <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"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></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"></p> +<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> – </p> </td> </tr> </tbody> @@ -95,6 +78,35 @@ </dd></dl> <dl class="function"> +<dt id="local.load_GPM_IMERG_files_with_spatial_filter"> +<code class="descclassname">local.</code><code class="descname">load_GPM_IMERG_files_with_spatial_filter</code><span class="sig-paren">(</span><em>file_path=None, filename_pattern=None, filelist=None, variable_name='precipitationCal', user_mask_file=None, mask_variable_name='mask', user_mask_values=[10], longitude_name='lon', latitude_name='lat'</em><span class="sig-paren">)</span><a class="headerlink" href="#local.load_GPM_IMERG_files_with_spatial_filter" title="Permalink to this definition">¶</a></dt> +<dd><p>Load multiple GPM Level 3 IMEGE files containing calibrated precipitation and generate a two-dimensional array for the masked grid points. +:param file_path: Directory to the HDF files to load. +:type file_path: <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> +:param filename_pattern: Path to the HDF files to load. +:type filename_pattern: <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> +:param filelist: A list of filenames +:type filelist: <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> +:param variable_name: The variable name to load from the HDF file. +:type variable_name: <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> +:param name: (Optional) A name for the loaded dataset. +:type name: <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> +:user_mask_file: user’s own gridded mask file(a netCDF file name) +:type name: <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> +:mask_variable_name: mask variables in user_mask_file +:type name: <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> +:longitude_name: longitude variable in user_mask_file +:type name: <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> +:latitude_name: latitude variable in user_mask_file +:type name: <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> +:param user_mask_values: grid points where mask_variable == user_mask_value will be extracted. +:type user_mask_values: list of strings +:returns: A two-dimensional array with the requested variable’s MASKED data from the HDF file. +:rtype: <a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a> +:raises ValueError:</p> +</dd></dl> + +<dl class="function"> <dt id="local.load_NLDAS_forcingA_files"> <code class="descclassname">local.</code><code class="descname">load_NLDAS_forcingA_files</code><span class="sig-paren">(</span><em>file_path=None</em>, <em>filename_pattern=None</em>, <em>filelist=None</em>, <em>variable_name='APCPsfc_110_SFC_acc1h'</em>, <em>name=''</em><span class="sig-paren">)</span><a class="headerlink" href="#local.load_NLDAS_forcingA_files" title="Permalink to this definition">¶</a></dt> <dd><p>Load multiple NLDAS2 forcingAWRF files containing 2D fields such as precipitation and surface variables into a Dataset. The dataset can be spatially subset.</p> @@ -103,11 +115,11 @@ <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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Directory to the NetCDF file to load.</li> -<li><strong>filename_pattern</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Path to the NetCDF file to load.</li> -<li><strong>filelist</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – A list of filenames</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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – The variable name to load from the NetCDF file.</li> -<li><strong>name</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> +<li><strong>file_path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Directory to the NetCDF file to load.</li> +<li><strong>filename_pattern</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>) – Path to the NetCDF file to load.</li> +<li><strong>filelist</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>) – A list of filenames</li> +<li><strong>variable_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 variable name to load from the NetCDF file.</li> +<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> </ul> </td> </tr> @@ -117,8 +129,7 @@ <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"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></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"></p> +<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> – </p> </td> </tr> </tbody> @@ -134,11 +145,11 @@ <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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Directory to the NetCDF file to load.</li> -<li><strong>filename_pattern</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Path to the NetCDF file to load.</li> -<li><strong>filelist</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – A list of filenames</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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – The variable name to load from the NetCDF file.</li> -<li><strong>name</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> +<li><strong>file_path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Directory to the NetCDF file to load.</li> +<li><strong>filename_pattern</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>) – Path to the NetCDF file to load.</li> +<li><strong>filelist</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>) – A list of filenames</li> +<li><strong>variable_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 variable name to load from the NetCDF file.</li> +<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> </ul> </td> </tr> @@ -148,8 +159,7 @@ <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"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></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"></p> +<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> – </p> </td> </tr> </tbody> @@ -165,9 +175,9 @@ <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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Directory to the NetCDF file to load.</li> -<li><strong>filename_pattern</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Path to the NetCDF file to load.</li> -<li><strong>name</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> +<li><strong>file_path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Directory to the NetCDF file to load.</li> +<li><strong>filename_pattern</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>) – Path to the NetCDF file to load.</li> +<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> </ul> </td> </tr> @@ -177,8 +187,7 @@ <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"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></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"></p> +<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> – </p> </td> </tr> </tbody> @@ -187,24 +196,25 @@ <dl class="function"> <dt id="local.load_dataset_from_multiple_netcdf_files"> -<code class="descclassname">local.</code><code class="descname">load_dataset_from_multiple_netcdf_files</code><span class="sig-paren">(</span><em>variable_name</em>, <em>lat_name=None</em>, <em>lon_name=None</em>, <em>time_name=None</em>, <em>name=''</em>, <em>file_list=None</em>, <em>file_path=None</em>, <em>filename_pattern=None</em>, <em>mask_file=None</em>, <em>mask_variable=None</em>, <em>mask_value=0</em><span class="sig-paren">)</span><a class="headerlink" href="#local.load_dataset_from_multiple_netcdf_files" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">local.</code><code class="descname">load_dataset_from_multiple_netcdf_files</code><span class="sig-paren">(</span><em>variable_name</em>, <em>variable_unit=None</em>, <em>lat_name=None</em>, <em>lon_name=None</em>, <em>time_name=None</em>, <em>name=''</em>, <em>file_list=None</em>, <em>file_path=None</em>, <em>filename_pattern=None</em>, <em>mask_file=None</em>, <em>mask_variable=None</em>, <em>mask_value=0</em><span class="sig-paren">)</span><a class="headerlink" href="#local.load_dataset_from_multiple_netcdf_files" title="Permalink to this definition">¶</a></dt> <dd><p>Load multiple netCDF files from the same source (an observation or a model) into a Dataset. The dataset can be spatially subset.</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>filelist</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – A text file including a list of filenames</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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – The variable name to load from the NetCDF file.</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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) The time variable name to extract 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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> -<li><strong>file_path</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Directory to the NetCDF file to load.</li> -<li><strong>filename_pattern</strong> (<a class="reference external" href="http://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Path to the NetCDF file to load.</li> +<li><strong>variable_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 variable name to load from the NetCDF file.</li> +<li><strong>variable_unit</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 variable’s unit to load from the NetCDF file.</li> +<li><strong>lat_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>) – (Optional) The latitude variable name to extract from the dataset.</li> +<li><strong>lon_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>) – (Optional) The longitude variable name to extract from the dataset.</li> +<li><strong>time_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>) – (Optional) The time variable name to extract from the dataset.</li> +<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> +<li><strong>file_list</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>) – A text file including a list of filenames</li> +<li><strong>file_path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Directory to the NetCDF file to load.</li> +<li><strong>filename_pattern</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>) – Path to the NetCDF file to load.</li> <li><strong>mask_file</strong> – A netcdf file with two-dimensional mask indices</li> <li><strong>mask_variable</strong> – The variable name to load from the mask_file.</li> -<li><strong>mask_value</strong> (<a class="reference external" href="http://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) – an index for spatial subsetting a dataset</li> +<li><strong>mask_value</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) – an index for spatial subsetting a dataset</li> </ul> </td> </tr> @@ -214,8 +224,7 @@ <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"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></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"></p> +<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> – </p> </td> </tr> </tbody> @@ -231,21 +240,21 @@ <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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) – (Optional) The elevation index for which data should +<li><strong>file_path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – Path to the NetCDF file to load.</li> +<li><strong>variable_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 variable name to load from the NetCDF file.</li> +<li><strong>variable_unit</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) The variable unit to load from the NetCDF file.</li> +<li><strong>elevation_index</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) – (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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) The latitude variable name to extract from the +<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> +<li><strong>lat_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>) – (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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) The longitude variable name to extract from the +<li><strong>lon_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>) – (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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) The time variable name to extract from the +<li><strong>time_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>) – (Optional) The time variable name to extract from the dataset.</li> </ul> </td> @@ -257,8 +266,7 @@ the NetCDF file.</p> <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"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></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 +<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> – When the specified file path cannot be loaded by ndfCDF4 or when the lat/lon/time variable name cannot be determined automatically.</p> </td> @@ -269,36 +277,31 @@ automatically.</p> <dl class="function"> <dt id="local.load_multiple_files"> -<code class="descclassname">local.</code><code class="descname">load_multiple_files</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#local.load_multiple_files" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">local.</code><code class="descname">load_multiple_files</code><span class="sig-paren">(</span><em>file_path</em>, <em>variable_name</em>, <em>generic_dataset_name=False</em>, <em>dataset_name=None</em>, <em>variable_unit=None</em>, <em>lat_name=None</em>, <em>lon_name=None</em>, <em>time_name=None</em><span class="sig-paren">)</span><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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) The latitude variable name to extract from the +<li><strong>file_path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – directory name and (optionally common file name patterns) where the NetCDF files to load are stored.</li> +<li><strong>dataset_name</strong> (<em>:mod:'list'</em>) – a list of dataset names. Data filenames must include the elements of dataset_name list.</li> +<li><strong>generic_dataset_name</strong> (<em>:mod:'bool'</em>) – If false, data filenames must include the elements of dataset_name list.</li> +<li><strong>variable_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 variable name to load from the NetCDF file.</li> +<li><strong>variable_unit</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) The variable unit to load from the NetCDF file.</li> +<li><strong>lat_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>) – (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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) The longitude variable name to extract from the +<li><strong>lon_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>) – (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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) The time variable name to extract from the +<li><strong>time_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>) – (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> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An array of OCW Dataset objects</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)"><code class="xref py py-class docutils literal"><span class="pre">list</span></code></a></p> +<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="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">list</span></code></a></p> </td> </tr> </tbody> @@ -324,7 +327,7 @@ More information about the RCMED Query S <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)"><code class="xref py py-class docutils literal"><span class="pre">list</span></code></a> of <a class="reference external" href="http://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">dict</span></code></a></td> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">dict</span></code></a></td> </tr> </tbody> </table> @@ -339,15 +342,15 @@ More information about the RCMED Query S <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)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></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)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></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)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></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)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></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)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></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)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></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)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></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)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> +<li><strong>dataset_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) – Dataset id.</li> +<li><strong>parameter_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>) – Parameter id</li> +<li><strong>min_lat</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – Minimum latitude</li> +<li><strong>max_lat</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – Maximum latitude</li> +<li><strong>min_lon</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – Minimum longitude</li> +<li><strong>max_lon</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">float</span></code></a>) – Maximum longitude</li> +<li><strong>start_time</strong> (<a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime.datetime" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></a>) – Start time</li> +<li><strong>end_time</strong> (<a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime.datetime" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></code></a>) – End time</li> +<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> </ul> </td> </tr> @@ -362,20 +365,46 @@ More information about the RCMED Query S </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> +<div class="section" id="dap-module"> +<h2>DAP Module<a class="headerlink" href="#dap-module" title="Permalink to this headline">¶</a></h2> +</div> +<div class="section" id="esgf-module"> +<h2>ESGF Module<a class="headerlink" href="#esgf-module" title="Permalink to this headline">¶</a></h2> +</div> +<div class="section" id="module-podaac_datasource"> +<span id="podaac-module"></span><h2>PODAAC Module<a class="headerlink" href="#module-podaac_datasource" title="Permalink to this headline">¶</a></h2> +<dl class="function"> +<dt id="podaac_datasource.convert_times_to_datetime"> +<code class="descclassname">podaac_datasource.</code><code class="descname">convert_times_to_datetime</code><span class="sig-paren">(</span><em>time</em><span class="sig-paren">)</span><a class="headerlink" href="#podaac_datasource.convert_times_to_datetime" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert the time object’s values to datetime objects</p> +<p>The time values are stored as some unit since an epoch. These need to be +converted into datetime objects for the OCW Dataset object.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>time</strong> (<em>pydap.model.BaseType</em>) – The time object’s values to convert</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of converted time values as datetime objects</td> +</tr> +</tbody> +</table> +</dd></dl> + <dl class="function"> -<dt id="dap.load"> -<code class="descclassname">dap.</code><code class="descname">load</code><span class="sig-paren">(</span><em>url</em>, <em>variable</em>, <em>name=''</em><span class="sig-paren">)</span><a class="headerlink" href="#dap.load" title="Permalink to this definition">¶</a></dt> -<dd><p>Load a Dataset from an OpenDAP URL</p> +<dt id="podaac_datasource.extract_l4_granule"> +<code class="descclassname">podaac_datasource.</code><code class="descname">extract_l4_granule</code><span class="sig-paren">(</span><em>variable</em>, <em>dataset_id=''</em>, <em>name=''</em>, <em>path='/tmp'</em><span class="sig-paren">)</span><a class="headerlink" href="#podaac_datasource.extract_l4_granule" title="Permalink to this definition">¶</a></dt> +<dd><p>Loads a Level4 gridded Dataset from PODAAC +:param variable: The name of the variable to read from the dataset. +:type variable: <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></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> +<li><strong>dataset_id</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>) – dataset persistent ID. datasetId or shortName is required for a granule search. Example: PODAAC-ASOP2-25X01</li> +<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> +<li><strong>path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – a path on the filesystem to store the granule.</li> </ul> </td> </tr> @@ -390,42 +419,31 @@ the OpenDAP URL.</p> </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"> -<code class="descclassname">esgf.</code><code class="descname">load_dataset</code><span class="sig-paren">(</span><em>dataset_id</em>, <em>variable</em>, <em>esgf_username</em>, <em>esgf_password</em>, <em>search_url='http://esgf-node.jpl.nasa.gov/esg-search/search'</em>, <em>elevation_index=0</em>, <em>name=''</em>, <em>save_path='/tmp'</em>, <em>**additional_constraints</em><span class="sig-paren">)</span><a class="headerlink" href="#esgf.load_dataset" title="Permalink to this definition">¶</a></dt> -<dd><p>Load an ESGF dataset.</p> +<dt id="podaac_datasource.list_available_extract_granule_dataset_ids"> +<code class="descclassname">podaac_datasource.</code><code class="descname">list_available_extract_granule_dataset_ids</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#podaac_datasource.list_available_extract_granule_dataset_ids" title="Permalink to this definition">¶</a></dt> +<dd><p>Convenience function which returns an up-to-date list of available granule dataset id’s which can be used in the granule extraction service. +:returns: a comma-seperated list of granule dataset id’s.</p> +</dd></dl> + +<dl class="function"> +<dt id="podaac_datasource.subset_granule"> +<code class="descclassname">podaac_datasource.</code><code class="descname">subset_granule</code><span class="sig-paren">(</span><em>variable</em>, <em>dataset_id=''</em>, <em>name=''</em>, <em>path='/tmp'</em>, <em>input_file_path=''</em><span class="sig-paren">)</span><a class="headerlink" href="#podaac_datasource.subset_granule" title="Permalink to this definition">¶</a></dt> +<dd><p>Subset Granule service allows users to Submit subset jobs. Use of this service should be preceded by a Granule Search in order to identify and generate a list of granules to be subsetted.</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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></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> +<li><strong>variable</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – The name of the variable to read from the dataset.</li> +<li><strong>dataset_id</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>) – dataset persistent ID. datasetId or shortName is required for a granule search. Example: PODAAC-ASOP2-25X01</li> +<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) A name for the loaded dataset.</li> +<li><strong>path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – (Optional) a path on the filesystem to store the granule.</li> +<li><strong>input_file_path</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">string</span></code></a>) – path to a json file which contains the the subset request that you want to send to PO.DAAC</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)"><code class="xref py py-class docutils literal"><span class="pre">list</span></code></a> of <a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a> 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"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></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> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a token on successful request reception. This can be further used to check the status of the request.</p> </td> </tr> </tbody> @@ -449,18 +467,21 @@ variable, or if the requested dataset is <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> +<li><a class="reference internal" href="#dap-module">DAP Module</a></li> +<li><a class="reference internal" href="#esgf-module">ESGF Module</a></li> +<li><a class="reference internal" href="#module-podaac_datasource">PODAAC 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> +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../index.html">Documentation overview</a><ul> + <li>Previous: <a href="../ocw/utils.html" title="previous chapter">Utils Module</a></li> + <li>Next: <a href="../ui-backend/backend.html" title="next chapter">Evaluation UI Webservices</a></li> + </ul></li> +</ul> +</div> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> @@ -471,14 +492,11 @@ variable, or if the requested dataset is <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> - <input type="text" name="q" /> - <input type="submit" value="Go" /> + <div><input type="text" name="q" /></div> + <div><input type="submit" value="Go" /></div> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> - <p class="searchtip" style="font-size: 90%"> - Enter search terms or a module, class or function name. - </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> @@ -489,12 +507,12 @@ variable, or if the requested dataset is ©2016, Apache Software Foundation. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.4</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a> | <a href="../_sources/data_source/data_sources.txt" - rel="nofollow">Page source</a></li> + rel="nofollow">Page source</a> </div>
Modified: websites/staging/climate/trunk/content/api/current/genindex.html ============================================================================== --- websites/staging/climate/trunk/content/api/current/genindex.html (original) +++ websites/staging/climate/trunk/content/api/current/genindex.html Mon Apr 24 21:37:01 2017 @@ -7,7 +7,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Index — Apache Open Climate Workbench 1.1.0 documentation</title> + <title>Index — Apache Open Climate Workbench 1.2.0 documentation</title> <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: '1.1.0', + VERSION: '1.2.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -24,28 +24,18 @@ <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> - <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="index.html" /> + <link rel="index" title="Index" href="#" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="top" title="Apache Open Climate Workbench 1.2.0 documentation" href="index.html" /> + <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> </head> <body role="document"> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="#" 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="nav-item nav-item-0"><a href="index.html">Apache Open Climate Workbench 1.1.0 documentation</a> »</li> - </ul> - </div> + <div class="document"> <div class="documentwrapper"> @@ -61,6 +51,7 @@ | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#E"><strong>E</strong></a> + | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> @@ -91,6 +82,10 @@ </dt> + <dt><a href="ocw/dataset_loader.html#dataset_loader.DatasetLoader.add_loader_opts">add_loader_opts() (dataset_loader.DatasetLoader method)</a> + </dt> + + <dt><a href="ocw/evaluation.html#evaluation.Evaluation.add_metric">add_metric() (evaluation.Evaluation method)</a> </dt> @@ -109,6 +104,10 @@ </dt> + <dt><a href="ocw/dataset_loader.html#dataset_loader.DatasetLoader.add_source_loader">add_source_loader() (dataset_loader.DatasetLoader method)</a> + </dt> + + <dt><a href="ocw/plotter.html#plotter.TaylorDiagram.add_stddev_contours">add_stddev_contours() (plotter.TaylorDiagram method)</a> </dt> @@ -122,12 +121,12 @@ <dt><a href="ocw/metrics.html#metrics.Bias">Bias (class in metrics)</a> </dt> + </dl></td> + <td style="width: 33%" valign="top"><dl> <dt><a href="ocw/metrics.html#metrics.BinaryMetric">BinaryMetric (class in metrics)</a> </dt> - </dl></td> - <td style="width: 33%" valign="top"><dl> <dt><a href="ocw/dataset.html#dataset.Bounds">Bounds (class in dataset)</a> </dt> @@ -159,15 +158,23 @@ </dt> + <dt><a href="ocw/metrics.html#metrics.calc_histogram_overlap">calc_histogram_overlap() (in module metrics)</a> + </dt> + + + <dt><a href="ocw/metrics.html#metrics.calc_joint_histogram">calc_joint_histogram() (in module metrics)</a> + </dt> + + <dt><a href="ocw/metrics.html#metrics.calc_rmse">calc_rmse() (in module metrics)</a> </dt> - </dl></td> - <td style="width: 33%" valign="top"><dl> <dt><a href="ocw/metrics.html#metrics.calc_stddev">calc_stddev() (in module metrics)</a> </dt> + </dl></td> + <td style="width: 33%" valign="top"><dl> <dt><a href="ocw/metrics.html#metrics.calc_stddev_ratio">calc_stddev_ratio() (in module metrics)</a> </dt> @@ -184,6 +191,26 @@ <dt><a href="ocw/utils.html#utils.calc_time_series">calc_time_series() (in module utils)</a> </dt> + + <dt><a href="ocw/utils.html#utils.calculate_ensemble_temporal_trends">calculate_ensemble_temporal_trends() (in module utils)</a> + </dt> + + + <dt><a href="ocw/utils.html#utils.calculate_temporal_trend_of_time_series">calculate_temporal_trend_of_time_series() (in module utils)</a> + </dt> + + + <dt><a href="ocw/utils.html#utils.calculate_temporal_trends">calculate_temporal_trends() (in module utils)</a> + </dt> + + + <dt><a href="data_source/data_sources.html#podaac_datasource.convert_times_to_datetime">convert_times_to_datetime() (in module podaac_datasource)</a> + </dt> + + + <dt><a href="ocw/utils.html#utils.CORDEX_boundary">CORDEX_boundary() (in module utils)</a> + </dt> + </dl></td> </tr></table> @@ -191,11 +218,11 @@ <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%" valign="top"><dl> - <dt><a href="data_source/data_sources.html#module-dap">dap (module)</a> + <dt><a href="ocw/dataset.html#dataset.Dataset">Dataset (class in dataset)</a> </dt> - <dt><a href="ocw/dataset.html#dataset.Dataset">Dataset (class in dataset)</a> + <dt><a href="ocw/dataset_loader.html#module-dataset_loader">dataset_loader (module)</a> </dt> @@ -203,10 +230,18 @@ </dt> + <dt><a href="ocw/dataset_loader.html#dataset_loader.DatasetLoader">DatasetLoader (class in dataset_loader)</a> + </dt> + + <dt><a href="ocw/utils.html#utils.decode_time_values">decode_time_values() (in module utils)</a> </dt> + <dt><a href="ocw/dataset_processor.html#dataset_processor.deseasonalize_dataset">deseasonalize_dataset() (in module dataset_processor)</a> + </dt> + + <dt><a href="ocw/plotter.html#plotter.draw_barchart">draw_barchart() (in module plotter)</a> </dt> @@ -225,10 +260,18 @@ </dt> + <dt><a href="ocw/plotter.html#plotter.draw_plot_to_compare_trends">draw_plot_to_compare_trends() (in module plotter)</a> + </dt> + + <dt><a href="ocw/plotter.html#plotter.draw_portrait_diagram">draw_portrait_diagram() (in module plotter)</a> </dt> + <dt><a href="ocw/plotter.html#plotter.draw_precipitation_JPDF">draw_precipitation_JPDF() (in module plotter)</a> + </dt> + + <dt><a href="ocw/plotter.html#plotter.draw_subregions">draw_subregions() (in module plotter)</a> </dt> @@ -251,17 +294,27 @@ </dt> - <dt><a href="data_source/data_sources.html#module-esgf">esgf (module)</a> + <dt><a href="ocw/evaluation.html#evaluation.Evaluation">Evaluation (class in evaluation)</a> </dt> </dl></td> <td style="width: 33%" valign="top"><dl> - <dt><a href="ocw/evaluation.html#evaluation.Evaluation">Evaluation (class in evaluation)</a> + <dt><a href="config/config_writer.html#ocw_config_runner.configuration_writer.export_evaluation_to_config">export_evaluation_to_config() (in module ocw_config_runner.configuration_writer)</a> </dt> - <dt><a href="config/config_writer.html#ocw_config_runner.configuration_writer.export_evaluation_to_config">export_evaluation_to_config() (in module ocw_config_runner.configuration_writer)</a> + <dt><a href="data_source/data_sources.html#podaac_datasource.extract_l4_granule">extract_l4_granule() (in module podaac_datasource)</a> + </dt> + + </dl></td> +</tr></table> + +<h2 id="F">F</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%" valign="top"><dl> + + <dt><a href="ocw/plotter.html#plotter.fill_US_states_with_color">fill_US_states_with_color() (in module plotter)</a> </dt> </dl></td> @@ -282,12 +335,12 @@ <dt><a href="config/config_writer.html#ocw_config_runner.configuration_writer.generate_evaluation_information">generate_evaluation_information() (in module ocw_config_runner.configuration_writer)</a> </dt> + </dl></td> + <td style="width: 33%" valign="top"><dl> <dt><a href="config/config_writer.html#ocw_config_runner.configuration_writer.generate_metric_information">generate_metric_information() (in module ocw_config_runner.configuration_writer)</a> </dt> - </dl></td> - <td style="width: 33%" valign="top"><dl> <dt><a href="config/config_writer.html#ocw_config_runner.configuration_writer.generate_subregion_information">generate_subregion_information() (in module ocw_config_runner.configuration_writer)</a> </dt> @@ -307,15 +360,15 @@ <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%" valign="top"><dl> - <dt><a href="data_source/data_sources.html#dap.load">load() (in module dap)</a> + <dt><a href="data_source/data_sources.html#podaac_datasource.list_available_extract_granule_dataset_ids">list_available_extract_granule_dataset_ids() (in module podaac_datasource)</a> </dt> - <dt><a href="data_source/data_sources.html#esgf.load_dataset">load_dataset() (in module esgf)</a> + <dt><a href="data_source/data_sources.html#local.load_dataset_from_multiple_netcdf_files">load_dataset_from_multiple_netcdf_files() (in module local)</a> </dt> - <dt><a href="data_source/data_sources.html#local.load_dataset_from_multiple_netcdf_files">load_dataset_from_multiple_netcdf_files() (in module local)</a> + <dt><a href="ocw/dataset_loader.html#dataset_loader.DatasetLoader.load_datasets">load_datasets() (dataset_loader.DatasetLoader method)</a> </dt> @@ -329,6 +382,10 @@ </dl></td> <td style="width: 33%" valign="top"><dl> + <dt><a href="data_source/data_sources.html#local.load_GPM_IMERG_files_with_spatial_filter">load_GPM_IMERG_files_with_spatial_filter() (in module local)</a> + </dt> + + <dt><a href="data_source/data_sources.html#local.load_multiple_files">load_multiple_files() (in module local)</a> </dt> @@ -432,6 +489,10 @@ <dt><a href="ocw/plotter.html#module-plotter">plotter (module)</a> </dt> + + <dt><a href="data_source/data_sources.html#module-podaac_datasource">podaac_datasource (module)</a> + </dt> + </dl></td> </tr></table> @@ -450,8 +511,6 @@ <dt><a href="ocw/evaluation.html#evaluation.Evaluation.results">results (evaluation.Evaluation attribute)</a> </dt> - </dl></td> - <td style="width: 33%" valign="top"><dl> <dt><a href="ocw/metrics.html#metrics.RMSError">RMSError (class in metrics)</a> </dt> @@ -517,16 +576,24 @@ </dt> - <dt><a href="ocw/dataset.html#dataset.Dataset.spatial_boundaries">spatial_boundaries() (dataset.Dataset method)</a> + <dt><a href="ocw/dataset_loader.html#dataset_loader.DatasetLoader.set_loader_opts">set_loader_opts() (dataset_loader.DatasetLoader method)</a> </dt> - <dt><a href="ocw/dataset_processor.html#dataset_processor.spatial_regrid">spatial_regrid() (in module dataset_processor)</a> + <dt><a href="ocw/utils.html#utils.shapefile_boundary">shapefile_boundary() (in module utils)</a> + </dt> + + + <dt><a href="ocw/dataset.html#dataset.Dataset.spatial_boundaries">spatial_boundaries() (dataset.Dataset method)</a> </dt> </dl></td> <td style="width: 33%" valign="top"><dl> + <dt><a href="ocw/dataset_processor.html#dataset_processor.spatial_regrid">spatial_regrid() (in module dataset_processor)</a> + </dt> + + <dt><a href="ocw/dataset.html#dataset.Dataset.spatial_resolution">spatial_resolution() (dataset.Dataset method)</a> </dt> @@ -542,6 +609,10 @@ <dt><a href="ocw/dataset_processor.html#dataset_processor.subset">subset() (in module dataset_processor)</a> </dt> + + <dt><a href="data_source/data_sources.html#podaac_datasource.subset_granule">subset_granule() (in module podaac_datasource)</a> + </dt> + </dl></td> </tr></table> @@ -561,6 +632,10 @@ </dt> + <dt><a href="ocw/dataset.html#dataset.Dataset.temporal_boundaries">temporal_boundaries() (dataset.Dataset method)</a> + </dt> + + <dt><a href="ocw/dataset_processor.html#dataset_processor.temporal_rebin">temporal_rebin() (in module dataset_processor)</a> </dt> @@ -568,12 +643,12 @@ <dt><a href="ocw/dataset_processor.html#dataset_processor.temporal_rebin_with_time_index">temporal_rebin_with_time_index() (in module dataset_processor)</a> </dt> + </dl></td> + <td style="width: 33%" valign="top"><dl> <dt><a href="ocw/dataset.html#dataset.Dataset.temporal_resolution">temporal_resolution() (dataset.Dataset method)</a> </dt> - </dl></td> - <td style="width: 33%" valign="top"><dl> <dt><a href="ocw/dataset_processor.html#dataset_processor.temporal_slice">temporal_slice() (in module dataset_processor)</a> </dt> @@ -594,10 +669,6 @@ <dt><a href="ocw/metrics.html#metrics.TemporalStdDev">TemporalStdDev (class in metrics)</a> </dt> - - <dt><a href="ocw/dataset.html#dataset.Dataset.time_range">time_range() (dataset.Dataset method)</a> - </dt> - </dl></td> </tr></table> @@ -645,6 +716,10 @@ </dl></td> <td style="width: 33%" valign="top"><dl> + <dt><a href="ocw/metrics.html#metrics.wet_spell_analysis">wet_spell_analysis() (in module metrics)</a> + </dt> + + <dt><a href="ocw/dataset_processor.html#dataset_processor.write_netcdf">write_netcdf() (in module dataset_processor)</a> </dt> @@ -662,19 +737,22 @@ <img class="logo" src="_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/> </a></p> - + <div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <form class="search" action="search.html" method="get"> - <input type="text" name="q" /> - <input type="submit" value="Go" /> + <div><input type="text" name="q" /></div> + <div><input type="submit" value="Go" /></div> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> - <p class="searchtip" style="font-size: 90%"> - Enter search terms or a module, class or function name. - </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> @@ -685,8 +763,8 @@ ©2016, Apache Software Foundation. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.4</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a> </div>