docs for query soil

SchmidtDSE · Feb 16, 2024 · bdfbc96 · bdfbc96
1 parent 79c2cf9
commit bdfbc96
Show file tree

Hide file tree

Showing 13 changed files with 195 additions and 84 deletions.
diff --git a/.sphinx/doctrees/_autosummary/src.lib.query_rap.doctree b/.sphinx/doctrees/_autosummary/src.lib.query_rap.doctree
diff --git a/.sphinx/doctrees/environment.pickle b/.sphinx/doctrees/environment.pickle
diff --git a/.sphinx/doctrees/src.lib.doctree b/.sphinx/doctrees/src.lib.doctree
diff --git a/.sphinx/html/_autosummary/src.lib.html b/.sphinx/html/_autosummary/src.lib.html
@@ -35,19 +35,19 @@
 <p class="rubric">Modules</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="src.lib.burn_severity.html#module-src.lib.burn_severity" title="src.lib.burn_severity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">src.lib.burn_severity</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../src.lib.html#module-src.lib.burn_severity" title="src.lib.burn_severity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">src.lib.burn_severity</span></code></a></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="src.lib.query_rap.html#module-src.lib.query_rap" title="src.lib.query_rap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">src.lib.query_rap</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="../src.lib.html#module-src.lib.query_rap" title="src.lib.query_rap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">src.lib.query_rap</span></code></a></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="src.lib.query_sentinel.html#module-src.lib.query_sentinel" title="src.lib.query_sentinel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">src.lib.query_sentinel</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../src.lib.html#module-src.lib.query_sentinel" title="src.lib.query_sentinel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">src.lib.query_sentinel</span></code></a></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="src.lib.query_soil.html#module-src.lib.query_soil" title="src.lib.query_soil"><code class="xref py py-obj docutils literal notranslate"><span class="pre">src.lib.query_soil</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="../src.lib.html#module-src.lib.query_soil" title="src.lib.query_soil"><code class="xref py py-obj docutils literal notranslate"><span class="pre">src.lib.query_soil</span></code></a></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="src.lib.titiler_algorithms.html#module-src.lib.titiler_algorithms" title="src.lib.titiler_algorithms"><code class="xref py py-obj docutils literal notranslate"><span class="pre">src.lib.titiler_algorithms</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../src.lib.html#module-src.lib.titiler_algorithms" title="src.lib.titiler_algorithms"><code class="xref py py-obj docutils literal notranslate"><span class="pre">src.lib.titiler_algorithms</span></code></a></p></td>
 <td><p></p></td>
 </tr>
 </tbody>

diff --git a/.sphinx/html/_autosummary/src.lib.query_rap.html b/.sphinx/html/_autosummary/src.lib.query_rap.html
@@ -13,8 +13,6 @@
     <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="src.lib.query_sentinel" href="src.lib.query_sentinel.html" />
-    <link rel="prev" title="src.lib.burn_severity" href="src.lib.burn_severity.html" />
 
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
 
@@ -37,8 +35,8 @@
 <p class="rubric">Functions</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
-<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">rap_get_biomass</span></code>(ignition_date, boundary_geojson)</p></td>
-<td><p></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../src.lib.html#src.lib.query_rap.rap_get_biomass" title="src.lib.query_rap.rap_get_biomass"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rap_get_biomass</span></code></a>(ignition_date, boundary_geojson)</p></td>
+<td><p>Retrieves biomass estimates from the Rangeland Analysis Platform for a given ignition year and boundary location.</p></td>
 </tr>
 </tbody>
 </table>
@@ -61,33 +59,11 @@ <h1 class="logo"><a href="../index.html">dse-fire-recovery</a></h1>
 
 
 <h3>Navigation</h3>
-<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="src.html">src</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="src.app.html">src.app</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="src.lib.html">src.lib</a><ul class="current">
-<li class="toctree-l3"><a class="reference internal" href="src.lib.burn_severity.html">src.lib.burn_severity</a></li>
-<li class="toctree-l3 current"><a class="current reference internal" href="#">src.lib.query_rap</a></li>
-<li class="toctree-l3"><a class="reference internal" href="src.lib.query_sentinel.html">src.lib.query_sentinel</a></li>
-<li class="toctree-l3"><a class="reference internal" href="src.lib.query_soil.html">src.lib.query_soil</a></li>
-<li class="toctree-l3"><a class="reference internal" href="src.lib.titiler_algorithms.html">src.lib.titiler_algorithms</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="src.routers.html">src.routers</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.util.html">src.util</a></li>
-</ul>
-</li>
-</ul>
 
 <div class="relations">
 <h3>Related Topics</h3>
 <ul>
   <li><a href="../index.html">Documentation overview</a><ul>
-  <li><a href="src.html">src</a><ul>
-  <li><a href="src.lib.html">src.lib</a><ul>
-      <li>Previous: <a href="src.lib.burn_severity.html" title="previous chapter">src.lib.burn_severity</a></li>
-      <li>Next: <a href="src.lib.query_sentinel.html" title="next chapter">src.lib.query_sentinel</a></li>
-  </ul></li>
-  </ul></li>
   </ul></li>
 </ul>
 </div>

diff --git a/.sphinx/html/_autosummary/src.lib.query_sentinel.html b/.sphinx/html/_autosummary/src.lib.query_sentinel.html
@@ -13,8 +13,6 @@
     <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="src.lib.query_soil" href="src.lib.query_soil.html" />
-    <link rel="prev" title="src.lib.query_rap" href="src.lib.query_rap.html" />
 
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
 
@@ -37,7 +35,7 @@
 <p class="rubric">Classes</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
-<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Sentinel2Client</span></code>(geojson_boundary[, ...])</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../src.lib.html#src.lib.query_sentinel.Sentinel2Client" title="src.lib.query_sentinel.Sentinel2Client"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Sentinel2Client</span></code></a>(geojson_boundary[, ...])</p></td>
 <td><p></p></td>
 </tr>
 </tbody>
@@ -61,33 +59,11 @@ <h1 class="logo"><a href="../index.html">dse-fire-recovery</a></h1>
 
 
 <h3>Navigation</h3>
-<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="src.html">src</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="src.app.html">src.app</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="src.lib.html">src.lib</a><ul class="current">
-<li class="toctree-l3"><a class="reference internal" href="src.lib.burn_severity.html">src.lib.burn_severity</a></li>
-<li class="toctree-l3"><a class="reference internal" href="src.lib.query_rap.html">src.lib.query_rap</a></li>
-<li class="toctree-l3 current"><a class="current reference internal" href="#">src.lib.query_sentinel</a></li>
-<li class="toctree-l3"><a class="reference internal" href="src.lib.query_soil.html">src.lib.query_soil</a></li>
-<li class="toctree-l3"><a class="reference internal" href="src.lib.titiler_algorithms.html">src.lib.titiler_algorithms</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="src.routers.html">src.routers</a></li>
-<li class="toctree-l2"><a class="reference internal" href="src.util.html">src.util</a></li>
-</ul>
-</li>
-</ul>
 
 <div class="relations">
 <h3>Related Topics</h3>
 <ul>
   <li><a href="../index.html">Documentation overview</a><ul>
-  <li><a href="src.html">src</a><ul>
-  <li><a href="src.lib.html">src.lib</a><ul>
-      <li>Previous: <a href="src.lib.query_rap.html" title="previous chapter">src.lib.query_rap</a></li>
-      <li>Next: <a href="src.lib.query_soil.html" title="next chapter">src.lib.query_soil</a></li>
-  </ul></li>
-  </ul></li>
   </ul></li>
 </ul>
 </div>

diff --git a/.sphinx/html/genindex.html b/.sphinx/html/genindex.html
@@ -88,8 +88,6 @@ <h2 id="C">C</h2>
       <li><a href="src.lib.html#src.lib.query_sentinel.Sentinel2Client.classify">classify() (src.lib.query_sentinel.Sentinel2Client method)</a>
 </li>
       <li><a href="src.lib.html#src.lib.burn_severity.classify_burn">classify_burn() (in module src.lib.burn_severity)</a>
-</li>
-      <li><a href="src.lib.html#src.lib.query_sentinel.Sentinel2Client.clip_metrics_stack_to_boundary">clip_metrics_stack_to_boundary() (src.lib.query_sentinel.Sentinel2Client method)</a>
 </li>
       <li><a href="src.util.html#src.util.cloud_static_io.CloudStaticIOClient">CloudStaticIOClient (class in src.util.cloud_static_io)</a>
 </li>

diff --git a/.sphinx/html/objects.inv b/.sphinx/html/objects.inv