deploy: 34c18c3

cedadev · Jan 25, 2024 · e711b6d · e711b6d
1 parent 106bd0d
commit e711b6d
Show file tree

Hide file tree

Showing 20 changed files with 329 additions and 133 deletions.
diff --git a/_sources/execution-source.rst.txt b/_sources/execution-source.rst.txt
@@ -0,0 +1,8 @@
+Pipeline Execution
+==================
+
+.. automodule:: group_run
+    :members:
+
+.. automodule:: single_run
+    :members:
diff --git a/_sources/execution.rst.txt b/_sources/execution.rst.txt
@@ -1,8 +1,17 @@
-Pipeline Execution
-==================
-
-.. automodule:: group_run
-    :members:
-
-.. automodule:: single_run
-    :members:
+Running the Pipeline
+====================
+
+Running for a single dataset
+============================
+
+```
+usage: single_run.py [-h] [-w WORKDIR] [-g GROUPDIR] [-G GROUPID] [-p PROJ_DIR] [-n NEW_VERSION] [-m MODE] [-t TIME_ALLOWED] [-b] [-s SUBSET] [-r REPEAT_ID] [-f] [-v] [-d] [-Q] phase proj_code
+```
+
+Required Parameters:
+ - phase: Pipeline phase to execute
+ - proj_code: Project code or ID for this dataset execution
+
+
+Running for a group of datasets
+===============================
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -26,6 +26,7 @@ Welcome to kerchunk-builder's documentation!
    Compute Source <compute>
    Validate Source <validate>
    Assess Source <assess>
+   Execution Source <execution-source>
 
 
 

diff --git a/assess-overview.html b/assess-overview.html
@@ -39,7 +39,9 @@
         </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"><a class="reference internal" href="execution.html">Running the Pipeline</a></li>
+<li class="toctree-l1"><a class="reference internal" href="execution.html#running-for-a-single-dataset">Running for a single dataset</a></li>
+<li class="toctree-l1"><a class="reference internal" href="execution.html#running-for-a-group-of-datasets">Running for a group of datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Worked Examples</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Assessor Tool Overview</a></li>
 </ul>
@@ -50,6 +52,7 @@
 <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>
+<li class="toctree-l1"><a class="reference internal" href="execution-source.html">Execution Source</a></li>
 </ul>
 
         </div>

diff --git a/assess.html b/assess.html
@@ -17,6 +17,7 @@
     <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="Pipeline Execution" href="execution-source.html" />
     <link rel="prev" title="Validation Module" href="validate.html" /> 
 </head>
 
@@ -38,7 +39,9 @@
         </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="execution.html">Running the Pipeline</a></li>
+<li class="toctree-l1"><a class="reference internal" href="execution.html#running-for-a-single-dataset">Running for a single dataset</a></li>
+<li class="toctree-l1"><a class="reference internal" href="execution.html#running-for-a-group-of-datasets">Running for a group of datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Worked Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="assess-overview.html">Assessor Tool Overview</a></li>
 </ul>
@@ -49,6 +52,7 @@
 <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>
+<li class="toctree-l1"><a class="reference internal" href="execution-source.html">Execution Source</a></li>
 </ul>
 
         </div>
@@ -159,6 +163,7 @@
           </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>
+        <a href="execution-source.html" class="btn btn-neutral float-right" title="Pipeline Execution" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/compute.html b/compute.html
@@ -39,7 +39,9 @@
         </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="execution.html">Running the Pipeline</a></li>
+<li class="toctree-l1"><a class="reference internal" href="execution.html#running-for-a-single-dataset">Running for a single dataset</a></li>
+<li class="toctree-l1"><a class="reference internal" href="execution.html#running-for-a-group-of-datasets">Running for a group of datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Worked Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="assess-overview.html">Assessor Tool Overview</a></li>
 </ul>
@@ -53,6 +55,7 @@
 </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>
+<li class="toctree-l1"><a class="reference internal" href="execution-source.html">Execution Source</a></li>
 </ul>
 
         </div>

diff --git a/examples.html b/examples.html
@@ -18,7 +18,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Assessor Tool" href="assess-overview.html" />
-    <link rel="prev" title="Pipeline Execution" href="execution.html" /> 
+    <link rel="prev" title="Running the Pipeline" href="execution.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -39,7 +39,9 @@
         </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"><a class="reference internal" href="execution.html">Running the Pipeline</a></li>
+<li class="toctree-l1"><a class="reference internal" href="execution.html#running-for-a-single-dataset">Running for a single dataset</a></li>
+<li class="toctree-l1"><a class="reference internal" href="execution.html#running-for-a-group-of-datasets">Running for a group of datasets</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Worked Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="assess-overview.html">Assessor Tool Overview</a></li>
 </ul>
@@ -50,6 +52,7 @@
 <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>
+<li class="toctree-l1"><a class="reference internal" href="execution-source.html">Execution Source</a></li>
 </ul>
 
         </div>
@@ -84,7 +87,7 @@ <h1>Worked Examples<a class="headerlink" href="#worked-examples" title="Permalin
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="execution.html" class="btn btn-neutral float-left" title="Pipeline Execution" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="execution.html" class="btn btn-neutral float-left" title="Running the Pipeline" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="assess-overview.html" class="btn btn-neutral float-right" title="Assessor Tool" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>