Added phase summary titles

cedadev · Jan 25, 2024 · 05ebbfa · 05ebbfa
1 parent 0bc9776
commit 05ebbfa
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/docs/source/execution.rst b/docs/source/execution.rst
@@ -6,6 +6,7 @@ Running for a single dataset
 ============================
 
 Run all single-dataset processes with the ```single-run.py``` script.
+
 ```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```
 
 positional arguments:

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,12 +8,33 @@ Welcome to kerchunk-builder's documentation!
 
 **kerchunk-builder** is a Python package for creating sets of Kerchunk files from an archive of NetCDF/HDF/Tiff files. The pipeline makes it easy to create multiple Kerchunk files for different datasets in parallel with validation steps to ensure the outputs are correct.
 
+The pipeline consists of four central phases, with an additional phase for ingesting/cataloging the produced Kerchunk files. This is not part of the code-base of the pipeline currently but could be added in a future update.
+
+**Init (Initialisation) Phase**
+
+Some stuff here about Initialisation
+
+**Scan Phase**
+
+Scanning things
+
+**Compute Phase**
+
+Computing in serial
+
+**Validation Phase**
+
+Validate files
+
+**Next Steps**
+
+Ingest/Catalog files
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   Pipeline Overview <pipeline-overview>
-   Execution <execution>
+   Running the Pipeline <execution>
    Worked Examples <examples>
    Assessor Tool Overview <assess-overview>
 

diff --git a/docs/source/pipeline-overview.rst b/docs/source/pipeline-overview.rst