climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lewi...@apache.org
Subject svn commit: r1830784 [5/12] - in /climate/site/trunk/content/api/current: ./ _sources/ _sources/config/ _sources/data_source/ _sources/ocw/ _sources/ui-backend/ _static/ config/ data_source/ ocw/ ui-backend/
Date Wed, 02 May 2018 18:41:56 GMT
Modified: climate/site/trunk/content/api/current/data_source/data_sources.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/data_source/data_sources.html?rev=1830784&r1=1830783&r2=1830784&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/data_source/data_sources.html (original)
+++ climate/site/trunk/content/api/current/data_source/data_sources.html Wed May  2 18:41:55 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>Data Sources &#8212; Apache Open Climate Workbench 1.2.0 documentation</title>
-    
+    <title>Data Sources &#8212; 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="next" title="Evaluation UI Webservices" href="../ui-backend/backend.html" />
     <link rel="prev" title="Utils Module" href="../ocw/utils.html" />
    
@@ -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">
@@ -56,21 +53,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="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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; (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>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object with the requested variable&#8217;s data from         the HDF file.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object with the requested variable’s data from         the HDF file.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><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">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> &#8211; </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>
@@ -91,17 +88,17 @@
 :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&#8217;s own gridded mask file(a netCDF file name)
+: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    
+: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    
+: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    
+: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&#8217;s MASKED data from         the HDF file.
+: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>
@@ -115,21 +112,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="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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; (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>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object with the requested variable&#8217;s data from         the NetCDF file.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object with the requested variable’s data from         the NetCDF file.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><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">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> &#8211; </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>
@@ -145,21 +142,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="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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; (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>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object with the requested variable&#8217;s data from         the NetCDF file.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object with the requested variable’s data from         the NetCDF file.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><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">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> &#8211; </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>
@@ -175,19 +172,19 @@
 <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="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>) &#8211; 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>) &#8211; 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>) &#8211; (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>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object with the requested variable&#8217;s data from         the NetCDF file.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object with the requested variable’s data from         the NetCDF file.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><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">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> &#8211; </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>
@@ -203,28 +200,28 @@
 <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>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>) &#8211; 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>) &#8211; The variable&#8217;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>) &#8211; (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>) &#8211; (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>) &#8211; (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>) &#8211; (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>) &#8211; 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>) &#8211; 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>) &#8211; Path to the NetCDF file to load.</li>
-<li><strong>mask_file</strong> &#8211; A netcdf file with two-dimensional mask indices</li>
-<li><strong>mask_variable</strong> &#8211; The variable name to load from the mask_file.</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>) &#8211; an index for spatial subsetting a dataset</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="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>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object with the requested variable&#8217;s data from         the NetCDF file.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object with the requested variable’s data from         the NetCDF file.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><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">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> &#8211; </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>
@@ -240,33 +237,33 @@
 <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="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>) &#8211; 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>) &#8211; 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>) &#8211; (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>) &#8211; (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="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>) &#8211; (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>) &#8211; (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="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>) &#8211; (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="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>) &#8211; (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 OCW Dataset object with the requested variable&#8217;s data from
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An OCW Dataset object with the requested variable’s data from
 the NetCDF file.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><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">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> &#8211; 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>
@@ -284,16 +281,16 @@ automatically.</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>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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; (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>) &#8211; (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="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>) &#8211; (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="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>) &#8211; (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>
@@ -301,7 +298,7 @@ dataset.</li>
 <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="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>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">list</span></code></p>
 </td>
 </tr>
 </tbody>
@@ -327,7 +324,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="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 class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">list</span></code> 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>
@@ -342,15 +339,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="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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; 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>) &#8211; (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>
@@ -365,25 +362,109 @@ More information about the RCMED Query S
 </dd></dl>
 
 </div>
-<div class="section" id="dap-module">
-<h2>DAP Module<a class="headerlink" href="#dap-module" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="module-dap">
+<span id="dap-module"></span><h2>DAP Module<a class="headerlink" href="#module-dap" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="dap.convert_times_to_datetime">
+<code class="descclassname">dap.</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="#dap.convert_times_to_datetime" title="Permalink to this definition">¶</a></dt>
+<dd><p>Convert the OpenDAP 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>
+<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="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 OpenDAP URL for the dataset of interest.</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>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>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A <a class="reference internal" href="../ocw/dataset.html#dataset.Dataset" title="dataset.Dataset"><code class="xref py py-class docutils literal"><span class="pre">dataset.Dataset</span></code></a> containing the dataset pointed to by
+the OpenDAP URL.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">ServerError</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 </div>
-<div class="section" id="esgf-module">
-<h2>ESGF Module<a class="headerlink" href="#esgf-module" title="Permalink to this headline">¶</a></h2>
+<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>
+<p>A set of functions to wrap downloading ESGF datasets into an OCW dataset object.</p>
+<p><strong>* Note *</strong> The ESGF data source requires that the user have certain credentials downloaded from
+the ESG. The current version of the module should download these automatically.  Older versions of
+the library will not download them. The solution is to use the WGET script from the EGS to download
+a test dataset to get the credentials. The data source should work as expected then.</p>
+<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_name</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><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>
+<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="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 ESGF ID of the dataset 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 to load.</li>
+<li><strong>esgf_username</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>) – ESGF OpenID value to use for authentication.</li>
+<li><strong>esgf_password</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>) – ESGF Password to use for authentication.</li>
+<li><strong>search_url</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 ESGF node to use for searching. Defaults
+to the Jet Propulsion Laboratory node.</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 level to strip out when
+loading the dataset using ocw.data_source.local.</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>save_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) Path to where downloaded files should be saved.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A <code class="xref py py-class docutils literal"><span class="pre">list</span></code> 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">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> – If no dataset can be found for the supplied ID and
+variable, or if the requested dataset is a multi-file dataset.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 </div>
 <div 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&#8217;s values to datetime objects</p>
+<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>) &#8211; The time object&#8217;s values to convert</td>
+<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>
@@ -402,9 +483,9 @@ converted into datetime objects for the
 <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="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>) &#8211; 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>) &#8211; (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>) &#8211; a path on the filesystem to store the granule.</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>
@@ -422,8 +503,8 @@ the OpenDAP URL.</p>
 <dl class="function">
 <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&#8217;s which can be         used in the granule extraction service.
-:returns: a comma-seperated list of granule dataset id&#8217;s.</p>
+<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">
@@ -435,11 +516,11 @@ the OpenDAP URL.</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>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>) &#8211; 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>) &#8211; 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>) &#8211; (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>) &#8211; (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>) &#8211; path to a json file which contains the         the subset request that you want to send to PO.DAAC</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>
@@ -467,8 +548,8 @@ the OpenDAP URL.</p>
 <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="#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-dap">DAP Module</a></li>
+<li><a class="reference internal" href="#module-esgf">ESGF Module</a></li>
 <li><a class="reference internal" href="#module-podaac_datasource">PODAAC Module</a></li>
 </ul>
 </li>
@@ -485,7 +566,7 @@ the OpenDAP URL.</p>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
-      <li><a href="../_sources/data_source/data_sources.txt"
+      <li><a href="../_sources/data_source/data_sources.rst.txt"
             rel="nofollow">Show Source</a></li>
     </ul>
    </div>
@@ -504,14 +585,14 @@ the OpenDAP URL.</p>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2016, Apache Software Foundation.
+      &copy;2017, Apache Software Foundation.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
-      &amp; <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>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
       
       |
-      <a href="../_sources/data_source/data_sources.txt"
+      <a href="../_sources/data_source/data_sources.rst.txt"
           rel="nofollow">Page source</a>
     </div>
 



Mime
View raw message