deploy: 4f27b98

cedadev · Jan 25, 2024 · 5570b76 · 5570b76
1 parent 37b094b
commit 5570b76
Show file tree

Hide file tree

Showing 27 changed files with 1,454 additions and 34 deletions.
diff --git a/_sources/assess-overview.rst.txt b/_sources/assess-overview.rst.txt
@@ -0,0 +1,2 @@
+Assessor Tool
+=============
diff --git a/_sources/assess.rst.txt b/_sources/assess.rst.txt
@@ -0,0 +1,6 @@
+Assess Module
+=============
+
+.. automodule:: assess
+    :members:
+
diff --git a/_sources/compute.rst.txt b/_sources/compute.rst.txt
@@ -0,0 +1,8 @@
+Initialisation Module
+================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Processors:
+
+   Serial Process <serial-process>
diff --git a/_sources/examples.rst.txt b/_sources/examples.rst.txt
diff --git a/_sources/execution.rst.txt b/_sources/execution.rst.txt
@@ -0,0 +1,8 @@
+Pipeline Execution
+==================
+
+.. automodule:: group_run
+    :members:
+
+.. automodule:: single_run
+    :members:
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -12,8 +12,20 @@ Welcome to kerchunk-builder's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   Assessor Tool <assessor>
-   Serial Process <serial-process>
+   Pipeline Overview <pipeline-overview>
+   Execution <execution>
+   Worked Examples <examples>
+   Assessor Tool Overview <assess-overview>
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Advanced:
+
+   Init Source <init>
+   Scan Source <scan>
+   Compute Source <compute>
+   Validate Source <validate>
+   Assess Source <assess>
 
 
 

diff --git a/_sources/init.rst.txt b/_sources/init.rst.txt
@@ -0,0 +1,5 @@
+Initialisation Module
+================
+
+.. automodule:: pipeline.init
+    :members:
diff --git a/_sources/pipeline-overview.rst.txt b/_sources/pipeline-overview.rst.txt
diff --git a/_sources/scan.rst.txt b/_sources/scan.rst.txt
@@ -0,0 +1,5 @@
+Scanner Module
+================
+
+.. automodule:: pipeline.scan
+    :members:
diff --git a/_sources/validate.rst.txt b/_sources/validate.rst.txt
@@ -0,0 +1,5 @@
+Validation Module
+================
+
+.. automodule:: pipeline.validate
+    :members:
diff --git a/assess-overview.html b/assess-overview.html
@@ -0,0 +1,113 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Assessor Tool &mdash; Kerchunk Pipeline v1.1 documentation</title>
+      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/jquery.js"></script>
+        <script src="_static/underscore.js"></script>
+        <script src="_static/doctools.js"></script>
+    <script src="_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Initialisation Module" href="init.html" />
+    <link rel="prev" title="&lt;no title&gt;" href="examples.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+            <a href="index.html" class="icon icon-home"> Kerchunk Pipeline
+            <img src="_static/ceda.png" class="logo" alt="Logo"/>
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="execution.html">Execution</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Assessor Tool Overview</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Advanced:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="init.html">Init Source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="scan.html">Scan Source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="compute.html">Compute Source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="validate.html">Validate Source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assess.html">Assess Source</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">Kerchunk Pipeline</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
+      <li>Assessor Tool</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/assess-overview.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <div class="section" id="assessor-tool">
+<h1>Assessor Tool<a class="headerlink" href="#assessor-tool" title="Permalink to this headline"></a></h1>
+</div>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="examples.html" class="btn btn-neutral float-left" title="&lt;no title&gt;" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="init.html" class="btn btn-neutral float-right" title="Initialisation Module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Daniel Westwood.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/assess.html b/assess.html
@@ -0,0 +1,123 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Assess Module &mdash; Kerchunk Pipeline v1.1 documentation</title>
+      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/jquery.js"></script>
+        <script src="_static/underscore.js"></script>
+        <script src="_static/doctools.js"></script>
+    <script src="_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="Validation Module" href="validate.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+            <a href="index.html" class="icon icon-home"> Kerchunk Pipeline
+            <img src="_static/ceda.png" class="logo" alt="Logo"/>
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="execution.html">Execution</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assess-overview.html">Assessor Tool Overview</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Advanced:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="init.html">Init Source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="scan.html">Scan Source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="compute.html">Compute Source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="validate.html">Validate Source</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Assess Source</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">Kerchunk Pipeline</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
+      <li>Assess Module</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/assess.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <div class="section" id="module-assess">
+<span id="assess-module"></span><h1>Assess Module<a class="headerlink" href="#module-assess" title="Permalink to this headline"></a></h1>
+<dl class="py function">
+<dt class="sig sig-object py" id="assess.get_attribute">
+<span class="sig-prename descclassname"><span class="pre">assess.</span></span><span class="sig-name descname"><span class="pre">get_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">var</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#assess.get_attribute" title="Permalink to this definition"></a></dt>
+<dd><p>Assemble environment variable or take from passed argument.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="assess.init_logger">
+<span class="sig-prename descclassname"><span class="pre">assess.</span></span><span class="sig-name descname"><span class="pre">init_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">verbose</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#assess.init_logger" title="Permalink to this definition"></a></dt>
+<dd><p>Logger object init and configure with formatting</p>
+</dd></dl>
+
+</div>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="validate.html" class="btn btn-neutral float-left" title="Validation Module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Daniel Westwood.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/assessor.html b/assessor.html
@@ -16,9 +16,7 @@
         <script src="_static/doctools.js"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Serial Processor" href="serial-process.html" />
-    <link rel="prev" title="Welcome to kerchunk-builder’s documentation!" href="index.html" /> 
+    <link rel="search" title="Search" href="search.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -38,9 +36,17 @@
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
-<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Assessor Tool</a></li>
-<li class="toctree-l1"><a class="reference internal" href="serial-process.html">Serial Process</a></li>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="execution.html">Execution</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assess-overview.html">Assessor Tool Overview</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Advanced:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="init.html">Init Source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="scan.html">Scan Source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="compute.html">Compute Source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="validate.html">Validate Source</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assess.html">Assess Source</a></li>
 </ul>
 
         </div>
@@ -86,10 +92,7 @@
 
            </div>
           </div>
-          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="index.html" class="btn btn-neutral float-left" title="Welcome to kerchunk-builder’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="serial-process.html" class="btn btn-neutral float-right" title="Serial Processor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
-    </div>
+          <footer>
 
   <hr/>