Update documentation

Open-EO · Nov 13, 2024 · 03fe168 · 03fe168
commit 03fe168
Show file tree

Hide file tree

Showing 220 changed files with 85,477 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 679ccd4493083ab184125e8a170530d7
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/api-processbuilder.doctree b/.doctrees/api-processbuilder.doctree
diff --git a/.doctrees/api-processes.doctree b/.doctrees/api-processes.doctree
diff --git a/.doctrees/api.doctree b/.doctrees/api.doctree
diff --git a/.doctrees/auth.doctree b/.doctrees/auth.doctree
diff --git a/.doctrees/basics.doctree b/.doctrees/basics.doctree
diff --git a/.doctrees/batch_jobs.doctree b/.doctrees/batch_jobs.doctree
diff --git a/.doctrees/best_practices.doctree b/.doctrees/best_practices.doctree
diff --git a/.doctrees/changelog.doctree b/.doctrees/changelog.doctree
diff --git a/.doctrees/configuration.doctree b/.doctrees/configuration.doctree
diff --git a/.doctrees/cookbook/ard.doctree b/.doctrees/cookbook/ard.doctree
diff --git a/.doctrees/cookbook/index.doctree b/.doctrees/cookbook/index.doctree
diff --git a/.doctrees/cookbook/job_manager.doctree b/.doctrees/cookbook/job_manager.doctree
diff --git a/.doctrees/cookbook/localprocessing.doctree b/.doctrees/cookbook/localprocessing.doctree
diff --git a/.doctrees/cookbook/sampling.doctree b/.doctrees/cookbook/sampling.doctree
diff --git a/.doctrees/cookbook/spectral_indices.doctree b/.doctrees/cookbook/spectral_indices.doctree
diff --git a/.doctrees/cookbook/tricks.doctree b/.doctrees/cookbook/tricks.doctree
diff --git a/.doctrees/cookbook/udp_sharing.doctree b/.doctrees/cookbook/udp_sharing.doctree
diff --git a/.doctrees/data_access.doctree b/.doctrees/data_access.doctree
diff --git a/.doctrees/datacube_construction.doctree b/.doctrees/datacube_construction.doctree
diff --git a/.doctrees/development.doctree b/.doctrees/development.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/installation.doctree b/.doctrees/installation.doctree
diff --git a/.doctrees/machine_learning.doctree b/.doctrees/machine_learning.doctree
diff --git a/.doctrees/process_mapping.doctree b/.doctrees/process_mapping.doctree
diff --git a/.doctrees/processes.doctree b/.doctrees/processes.doctree
diff --git a/.doctrees/udf.doctree b/.doctrees/udf.doctree
diff --git a/.doctrees/udp.doctree b/.doctrees/udp.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/apply-rescaled-histogram.png b/_images/apply-rescaled-histogram.png
diff --git a/_images/batchjobs-jupyter-created.png b/_images/batchjobs-jupyter-created.png
diff --git a/_images/batchjobs-jupyter-listing.png b/_images/batchjobs-jupyter-listing.png
diff --git a/_images/batchjobs-jupyter-logs.png b/_images/batchjobs-jupyter-logs.png
diff --git a/_images/batchjobs-webeditor-listing.png b/_images/batchjobs-webeditor-listing.png
diff --git a/_images/evi-composite.png b/_images/evi-composite.png
diff --git a/_images/evi-masked-composite.png b/_images/evi-masked-composite.png
diff --git a/_images/evi-timeseries.png b/_images/evi-timeseries.png
diff --git a/_images/local_ndvi.jpg b/_images/local_ndvi.jpg
diff --git a/_images/logging_arrayshape.png b/_images/logging_arrayshape.png
diff --git a/_images/welcome.png b/_images/welcome.png
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,149 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Overview: module code &#8212; openEO Python Client 0.35.0a1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=ad3dbffd" />
+    <script src="../_static/documentation_options.js?v=c054dfdc"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
+    <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="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="openeo/api/logs.html">openeo.api.logs</a></li>
+<li><a href="openeo/api/process.html">openeo.api.process</a></li>
+<li><a href="openeo/extra/job_management.html">openeo.extra.job_management</a></li>
+<li><a href="openeo/extra/spectral_indices/spectral_indices.html">openeo.extra.spectral_indices.spectral_indices</a></li>
+<li><a href="openeo/internal/graph_building.html">openeo.internal.graph_building</a></li>
+<li><a href="openeo/metadata.html">openeo.metadata</a></li>
+<li><a href="openeo/processes.html">openeo.processes</a></li>
+<li><a href="openeo/rest/_datacube.html">openeo.rest._datacube</a></li>
+<li><a href="openeo/rest/connection.html">openeo.rest.connection</a></li>
+<li><a href="openeo/rest/conversions.html">openeo.rest.conversions</a></li>
+<li><a href="openeo/rest/datacube.html">openeo.rest.datacube</a></li>
+<li><a href="openeo/rest/graph_building.html">openeo.rest.graph_building</a></li>
+<li><a href="openeo/rest/job.html">openeo.rest.job</a></li>
+<li><a href="openeo/rest/mlmodel.html">openeo.rest.mlmodel</a></li>
+<li><a href="openeo/rest/multiresult.html">openeo.rest.multiresult</a></li>
+<li><a href="openeo/rest/udp.html">openeo.rest.udp</a></li>
+<li><a href="openeo/rest/userfile.html">openeo.rest.userfile</a></li>
+<li><a href="openeo/rest/vectorcube.html">openeo.rest.vectorcube</a></li>
+<li><a href="openeo/testing.html">openeo.testing</a></li>
+<ul><li><a href="openeo/testing/results.html">openeo.testing.results</a></li>
+</ul><li><a href="openeo/udf/debug.html">openeo.udf.debug</a></li>
+<li><a href="openeo/udf/run_code.html">openeo.udf.run_code</a></li>
+<li><a href="openeo/udf/structured_data.html">openeo.udf.structured_data</a></li>
+<li><a href="openeo/udf/udf_data.html">openeo.udf.udf_data</a></li>
+<li><a href="openeo/udf/udf_signatures.html">openeo.udf.udf_signatures</a></li>
+<li><a href="openeo/udf/xarraydatacube.html">openeo.udf.xarraydatacube</a></li>
+<li><a href="openeo/util.html">openeo.util</a></li>
+</ul>
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">openEO Python Client</a></h1>
+
+
+
+
+
+
+<p>
+<iframe src="https://ghbtns.com/github-btn.html?user=Open-EO&repo=openeo-python-client&type=watch&count=true&size=large&v=2"
+  allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
+</p>
+
+
+
+
+
+
+<h3><a href="../index.html">Table of Contents</a></h3>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../index.html">openEO Python Client</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../basics.html">Getting Started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data_access.html">Finding and loading data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../processes.html">Working with processes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../batch_jobs.html">Batch Jobs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../udp.html">User-Defined Processes (UDP)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../auth.html">Authentication and Account Management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../udf.html">User-Defined Functions (UDF) explained</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../datacube_construction.html">DataCube construction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../machine_learning.html">Machine Learning</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../configuration.html">Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../cookbook/index.html">openEO CookBook</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">API (General)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api-processes.html">API: <code class="docutils literal notranslate"><span class="pre">openeo.processes</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="../process_mapping.html">openEO Process Mapping</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../development.html">Development and maintenance</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../best_practices.html">Best practices, coding style and general tips</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
+<search id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script><!-- Alabaster (krTheme++) Hacks -->
+
+<div class="sidebar-meta">
+<h3>Meta</h3>
+<div>Docs for openEO Python Client</div>
+<div>Version: <code>0.35.0a1</code></div>
+<div>Last updated: 2024/11/13</div>
+</div>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2017 - 2024, Jeroen Dries.
+
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
+
+    </div>
+
+
+
+
+  </body>
+</html>