sphinx documentation

docs/_html/_sources/api.rst.txt

@@ -4,5 +4,11 @@ API
 .. autosummary::
    :toctree: generated
 
-   neonutilities.aop_download.by_file_aop
-   neonutilities.aop_download.by_tile_aop
+   neonutilities.by_file_aop
+   neonutilities.by_tile_aop
+   neonutilities.load_by_product
+   neonutilities.zips_by_product
+   neonutilities.stack_by_table
+   neonutilities.read_table_neon
+   neonutilities.get_citation
+   neonutilities.get_issue_log

docs/_html/_sources/generated/neonutilities.by_file_aop.rst.txt

@@ -0,0 +1,6 @@
+neonutilities.by\_file\_aop
+===========================
+
+.. currentmodule:: neonutilities
+
+.. autofunction:: by_file_aop

docs/_html/_sources/generated/neonutilities.by_tile_aop.rst.txt

@@ -0,0 +1,6 @@
+neonutilities.by\_tile\_aop
+===========================
+
+.. currentmodule:: neonutilities
+
+.. autofunction:: by_tile_aop

docs/_html/_sources/generated/neonutilities.get_citation.rst.txt

@@ -0,0 +1,6 @@
+neonutilities.get\_citation
+===========================
+
+.. currentmodule:: neonutilities
+
+.. autofunction:: get_citation

docs/_html/_sources/generated/neonutilities.get_issue_log.rst.txt

@@ -0,0 +1,6 @@
+neonutilities.get\_issue\_log
+=============================
+
+.. currentmodule:: neonutilities
+
+.. autofunction:: get_issue_log

docs/_html/_sources/generated/neonutilities.load_by_product.rst.txt

@@ -0,0 +1,6 @@
+neonutilities.load\_by\_product
+===============================
+
+.. currentmodule:: neonutilities
+
+.. autofunction:: load_by_product

docs/_html/_sources/generated/neonutilities.read_table_neon.rst.txt

@@ -0,0 +1,6 @@
+neonutilities.read\_table\_neon
+===============================
+
+.. currentmodule:: neonutilities
+
+.. autofunction:: read_table_neon

docs/_html/_sources/generated/neonutilities.stack_by_table.rst.txt

@@ -0,0 +1,6 @@
+neonutilities.stack\_by\_table
+==============================
+
+.. currentmodule:: neonutilities
+
+.. autofunction:: stack_by_table

docs/_html/_sources/generated/neonutilities.zips_by_product.rst.txt

@@ -0,0 +1,6 @@
+neonutilities.zips\_by\_product
+===============================
+
+.. currentmodule:: neonutilities
+
+.. autofunction:: zips_by_product

docs/_html/api.html

@@ -14,7 +14,7 @@
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="neonutilities.aop_download.by_file_aop" href="generated/neonutilities.aop_download.by_file_aop.html" />
+    <link rel="next" title="neonutilities.by_file_aop" href="generated/neonutilities.by_file_aop.html" />
     <link rel="prev" title="Tutorials" href="tutorials.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -37,12 +37,30 @@
 <h1>API<a class="headerlink" href="#api" title="Link to this heading">¶</a></h1>
 <table class="autosummary longtable docutils align-default">
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/neonutilities.aop_download.by_file_aop.html#neonutilities.aop_download.by_file_aop" title="neonutilities.aop_download.by_file_aop"><code class="xref py py-obj docutils literal notranslate"><span class="pre">neonutilities.aop_download.by_file_aop</span></code></a>(dpid, ...)</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/neonutilities.by_file_aop.html#neonutilities.by_file_aop" title="neonutilities.by_file_aop"><code class="xref py py-obj docutils literal notranslate"><span class="pre">neonutilities.by_file_aop</span></code></a>(dpid, site, year)</p></td>
 <td><p>This function queries the API for AOP data by site, year, and product, and downloads all  files found, preserving the original folder structure.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/neonutilities.aop_download.by_tile_aop.html#neonutilities.aop_download.by_tile_aop" title="neonutilities.aop_download.by_tile_aop"><code class="xref py py-obj docutils literal notranslate"><span class="pre">neonutilities.aop_download.by_tile_aop</span></code></a>(dpid, ...)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/neonutilities.by_tile_aop.html#neonutilities.by_tile_aop" title="neonutilities.by_tile_aop"><code class="xref py py-obj docutils literal notranslate"><span class="pre">neonutilities.by_tile_aop</span></code></a>(dpid, site, year, ...)</p></td>
 <td><p>This function queries the API for AOP data by site, year, product, and  UTM coordinates, and downloads all files found, preserving the original  folder structure.</p></td>
 </tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/neonutilities.load_by_product.html#neonutilities.load_by_product" title="neonutilities.load_by_product"><code class="xref py py-obj docutils literal notranslate"><span class="pre">neonutilities.load_by_product</span></code></a>(dpid[, site, ...])</p></td>
+<td><p>Download product-site-month data package files from NEON, stack, and load to the environment.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/neonutilities.zips_by_product.html#neonutilities.zips_by_product" title="neonutilities.zips_by_product"><code class="xref py py-obj docutils literal notranslate"><span class="pre">neonutilities.zips_by_product</span></code></a>(dpid[, site, ...])</p></td>
+<td><p>Download product-site-month data package files from NEON.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/neonutilities.stack_by_table.html#neonutilities.stack_by_table" title="neonutilities.stack_by_table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">neonutilities.stack_by_table</span></code></a>(filepath[, ...])</p></td>
+<td><p>Join data files in a zipped or unzipped NEON data package by table type.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/neonutilities.read_table_neon.html#neonutilities.read_table_neon" title="neonutilities.read_table_neon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">neonutilities.read_table_neon</span></code></a>(data_file, ...)</p></td>
+<td><p>Read a NEON data table with correct data types for each variable.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/neonutilities.get_citation.html#neonutilities.get_citation" title="neonutilities.get_citation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">neonutilities.get_citation</span></code></a>(dpid, release)</p></td>
+<td><p>Use the DOI Foundation API to get BibTex-formatted citations for NEON data,  or use a template to generate a BibTex citation for provisional data.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/neonutilities.get_issue_log.html#neonutilities.get_issue_log" title="neonutilities.get_issue_log"><code class="xref py py-obj docutils literal notranslate"><span class="pre">neonutilities.get_issue_log</span></code></a>(dpid[, token])</p></td>
+<td><p>Retrieves the issue log for any NEON data products.</p></td>
+</tr>
 </tbody>
 </table>
 </section>
@@ -78,8 +96,14 @@ <h1 class="logo"><a href="index.html">neonutilities</a></h1>
 <li class="toctree-l1"><a class="reference internal" href="getting-started.html">Get started with neonutilities</a></li>
 <li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">API</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="generated/neonutilities.aop_download.by_file_aop.html">neonutilities.aop_download.by_file_aop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/neonutilities.aop_download.by_tile_aop.html">neonutilities.aop_download.by_tile_aop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="generated/neonutilities.by_file_aop.html">neonutilities.by_file_aop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="generated/neonutilities.by_tile_aop.html">neonutilities.by_tile_aop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="generated/neonutilities.load_by_product.html">neonutilities.load_by_product</a></li>
+<li class="toctree-l2"><a class="reference internal" href="generated/neonutilities.zips_by_product.html">neonutilities.zips_by_product</a></li>
+<li class="toctree-l2"><a class="reference internal" href="generated/neonutilities.stack_by_table.html">neonutilities.stack_by_table</a></li>
+<li class="toctree-l2"><a class="reference internal" href="generated/neonutilities.read_table_neon.html">neonutilities.read_table_neon</a></li>
+<li class="toctree-l2"><a class="reference internal" href="generated/neonutilities.get_citation.html">neonutilities.get_citation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="generated/neonutilities.get_issue_log.html">neonutilities.get_issue_log</a></li>
 </ul>
 </li>
 </ul>
@@ -89,7 +113,7 @@ <h3>Related Topics</h3>
 <ul>
   <li><a href="index.html">Documentation overview</a><ul>
       <li>Previous: <a href="tutorials.html" title="previous chapter">Tutorials</a></li>
-      <li>Next: <a href="generated/neonutilities.aop_download.by_file_aop.html" title="next chapter">neonutilities.aop_download.by_file_aop</a></li>
+      <li>Next: <a href="generated/neonutilities.by_file_aop.html" title="next chapter">neonutilities.by_file_aop</a></li>
   </ul></li>
 </ul>
 </div>

docs/_html/generated/neonutilities.aop_download.by_file_aop.html → docs/_html/generated/neonutilities.by_file_aop.html

@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>neonutilities.aop_download.by_file_aop &#8212; neonutilities 1.0.1 documentation</title>
+    <title>neonutilities.by_file_aop &#8212; neonutilities 1.0.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
@@ -14,7 +14,7 @@
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="neonutilities.aop_download.by_tile_aop" href="neonutilities.aop_download.by_tile_aop.html" />
+    <link rel="next" title="neonutilities.by_tile_aop" href="neonutilities.by_tile_aop.html" />
     <link rel="prev" title="API" href="../api.html" />
 
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@@ -33,11 +33,11 @@
 
           <div class="body" role="main">
 
-  <section id="neonutilities-aop-download-by-file-aop">
-<h1>neonutilities.aop_download.by_file_aop<a class="headerlink" href="#neonutilities-aop-download-by-file-aop" title="Link to this heading">¶</a></h1>
+  <section id="neonutilities-by-file-aop">
+<h1>neonutilities.by_file_aop<a class="headerlink" href="#neonutilities-by-file-aop" title="Link to this heading">¶</a></h1>
 <dl class="py function">
-<dt class="sig sig-object py" id="neonutilities.aop_download.by_file_aop">
-<span class="sig-prename descclassname"><span class="pre">neonutilities.aop_download.</span></span><span class="sig-name descname"><span class="pre">by_file_aop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dpid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_provisional</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">savepath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chunk_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1024</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#neonutilities.aop_download.by_file_aop" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py" id="neonutilities.by_file_aop">
+<span class="sig-prename descclassname"><span class="pre">neonutilities.</span></span><span class="sig-name descname"><span class="pre">by_file_aop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dpid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_provisional</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">savepath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chunk_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1024</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#neonutilities.by_file_aop" title="Link to this definition">¶</a></dt>
 <dd><p>This function queries the API for AOP data by site, year, and product, and downloads all 
 files found, preserving the original folder structure. It downloads files serially to 
 avoid API rate-limit overload, which may take a long time.</p>
@@ -124,8 +124,8 @@ <h1 class="logo"><a href="../index.html">neonutilities</a></h1>
 <li class="toctree-l1"><a class="reference internal" href="../getting-started.html">Get started with neonutilities</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Tutorials</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="#">neonutilities.aop_download.by_file_aop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="neonutilities.aop_download.by_tile_aop.html">neonutilities.aop_download.by_tile_aop</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">neonutilities.by_file_aop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="neonutilities.by_tile_aop.html">neonutilities.by_tile_aop</a></li>
 </ul>
 </li>
 </ul>
@@ -136,7 +136,7 @@ <h3>Related Topics</h3>
   <li><a href="../index.html">Documentation overview</a><ul>
   <li><a href="../api.html">API</a><ul>
       <li>Previous: <a href="../api.html" title="previous chapter">API</a></li>
-      <li>Next: <a href="neonutilities.aop_download.by_tile_aop.html" title="next chapter">neonutilities.aop_download.by_tile_aop</a></li>
+      <li>Next: <a href="neonutilities.by_tile_aop.html" title="next chapter">neonutilities.by_tile_aop</a></li>
   </ul></li>
   </ul></li>
 </ul>
@@ -161,7 +161,7 @@ <h3>Related Topics</h3>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
 
       |
-      <a href="../_sources/generated/neonutilities.aop_download.by_file_aop.rst.txt"
+      <a href="../_sources/generated/neonutilities.by_file_aop.rst.txt"
           rel="nofollow">Page source</a>
     </div>