Deploying to gh-pages from @ a693dce 🚀

cedadev · Jan 8, 2025 · 6f3a3a6 · 6f3a3a6
1 parent f203c17
commit 6f3a3a6
Show file tree

Hide file tree

Showing 23 changed files with 568 additions and 301 deletions.
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -56,6 +56,7 @@ The ingestion/cataloging phase is not currently implemented for public use but m
 
    Projects <project_source>
    Groups <group_source>
+   Phases <phase_source>
    Filehandlers, Logs, and Utilities <misc_source>
 
 Indices and Tables

diff --git a/_sources/phase_source.rst.txt b/_sources/phase_source.rst.txt
@@ -0,0 +1,35 @@
+================
+Phased Operators
+================
+
+Scan Operations
+---------------
+
+.. automodule:: padocc.phases.scan
+    :members:
+    :show-inheritance:
+
+Compute Operations
+---------------
+
+.. automodule:: padocc.phases.compute
+    :members:
+    :show-inheritance:
+
+Validate Operations
+---------------
+
+.. automodule:: padocc.phases.validate
+    :members:
+    :show-inheritance:
+
+Ingest Operations
+---------------
+
+.. note::
+
+    Not featured in this development, the ingest operations are still being planned and scoped.
+
+.. automodule:: padocc.phases.ingest
+    :members:
+    :show-inheritance:
diff --git a/_sources/phases.rst.txt b/_sources/phases.rst.txt
@@ -40,8 +40,6 @@ The scan phase can be activated with the following:
 
     mygroup.run('scan',mode='kerchunk')
 
-.. automodule:: padocc.phases.scan
-    :members:
 
 Compute
 -------
@@ -74,10 +72,6 @@ Computation can be executed in serial for a group with the following:
 
     mygroup.run('compute',mode='kerchunk')
 
-.. automodule:: padocc.phases.compute
-    :members:
-    :show-inheritance:
-
 Validate
 --------
 
@@ -108,9 +102,6 @@ validator which checks the Xarray representations and identifies differences in
     # The validation reports will be saved to the filesystem for each project in this group
     # as 'data_report.json' and 'metadata_report.json'
 
-.. automodule:: padocc.phases.validate
-    :members:
-
 Next Steps
 ----------
 

diff --git a/cci_water.html b/cci_water.html
@@ -68,6 +68,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="project_source.html">Projects</a></li>
 <li class="toctree-l1"><a class="reference internal" href="group_source.html">Groups</a></li>
+<li class="toctree-l1"><a class="reference internal" href="phase_source.html">Phases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="misc_source.html">Filehandlers, Logs, and Utilities</a></li>
 </ul>
 

diff --git a/deep_dive.html b/deep_dive.html
@@ -106,6 +106,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="project_source.html">Projects</a></li>
 <li class="toctree-l1"><a class="reference internal" href="group_source.html">Groups</a></li>
+<li class="toctree-l1"><a class="reference internal" href="phase_source.html">Phases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="misc_source.html">Filehandlers, Logs, and Utilities</a></li>
 </ul>
 

diff --git a/dev-guide.html b/dev-guide.html
@@ -68,6 +68,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="project_source.html">Projects</a></li>
 <li class="toctree-l1"><a class="reference internal" href="group_source.html">Groups</a></li>
+<li class="toctree-l1"><a class="reference internal" href="phase_source.html">Phases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="misc_source.html">Filehandlers, Logs, and Utilities</a></li>
 </ul>
 

diff --git a/genindex.html b/genindex.html
diff --git a/group_source.html b/group_source.html
@@ -23,7 +23,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="Padocc Filehandlers" href="misc_source.html" />
+    <link rel="next" title="Phased Operators" href="phase_source.html" />
     <link rel="prev" title="ProjectOperation Core and Mixin Behaviours" href="project_source.html" /> 
 </head>
 
@@ -86,6 +86,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="phase_source.html">Phases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="misc_source.html">Filehandlers, Logs, and Utilities</a></li>
 </ul>
 
@@ -206,7 +207,7 @@ <h1>GroupOperation Core and Mixin Behaviours<a class="headerlink" href="#groupop
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="project_source.html" class="btn btn-neutral float-left" title="ProjectOperation Core and Mixin Behaviours" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="misc_source.html" class="btn btn-neutral float-right" title="Padocc Filehandlers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="phase_source.html" class="btn btn-neutral float-right" title="Phased Operators" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/groups.html b/groups.html
@@ -74,6 +74,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="project_source.html">Projects</a></li>
 <li class="toctree-l1"><a class="reference internal" href="group_source.html">Groups</a></li>
+<li class="toctree-l1"><a class="reference internal" href="phase_source.html">Phases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="misc_source.html">Filehandlers, Logs, and Utilities</a></li>
 </ul>
 

diff --git a/index.html b/index.html
@@ -67,6 +67,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="project_source.html">Projects</a></li>
 <li class="toctree-l1"><a class="reference internal" href="group_source.html">Groups</a></li>
+<li class="toctree-l1"><a class="reference internal" href="phase_source.html">Phases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="misc_source.html">Filehandlers, Logs, and Utilities</a></li>
 </ul>
 
@@ -142,6 +143,7 @@ <h1>PADOCC - User Documentation<a class="headerlink" href="#padocc-user-document
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="project_source.html">Projects</a></li>
 <li class="toctree-l1"><a class="reference internal" href="group_source.html">Groups</a></li>
+<li class="toctree-l1"><a class="reference internal" href="phase_source.html">Phases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="misc_source.html">Filehandlers, Logs, and Utilities</a></li>
 </ul>
 </div>

diff --git a/inspiration.html b/inspiration.html
@@ -73,6 +73,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="project_source.html">Projects</a></li>
 <li class="toctree-l1"><a class="reference internal" href="group_source.html">Groups</a></li>
+<li class="toctree-l1"><a class="reference internal" href="phase_source.html">Phases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="misc_source.html">Filehandlers, Logs, and Utilities</a></li>
 </ul>
 

diff --git a/misc_source.html b/misc_source.html
@@ -23,7 +23,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="prev" title="GroupOperation Core and Mixin Behaviours" href="group_source.html" /> 
+    <link rel="prev" title="Phased Operators" href="phase_source.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -67,6 +67,7 @@
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="project_source.html">Projects</a></li>
 <li class="toctree-l1"><a class="reference internal" href="group_source.html">Groups</a></li>
+<li class="toctree-l1"><a class="reference internal" href="phase_source.html">Phases</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Filehandlers, Logs, and Utilities</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#padocc.core.filehandlers.CSVFileHandler"><code class="docutils literal notranslate"><span class="pre">CSVFileHandler</span></code></a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#padocc.core.filehandlers.CSVFileHandler.update_status"><code class="docutils literal notranslate"><span class="pre">CSVFileHandler.update_status()</span></code></a></li>
@@ -543,7 +544,7 @@ <h2>Identical behaviour<a class="headerlink" href="#identical-behaviour" title="
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="group_source.html" class="btn btn-neutral float-left" title="GroupOperation Core and Mixin Behaviours" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="phase_source.html" class="btn btn-neutral float-left" title="Phased Operators" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>
 
   <hr/>

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