Merge pull request #1171 from esm-tools/sprint/workflow_manager_docum…

…entation Sprint/workflow manager documentation
esm-tools · Apr 30, 2024 · e49eac8 · e49eac8
2 parents ff0724c + 7395a9b
commit e49eac8
Show file tree

Hide file tree

Showing 5 changed files with 289 additions and 87 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -162,7 +162,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

diff --git a/docs/esm_runscripts.rst b/docs/esm_runscripts.rst
@@ -9,7 +9,7 @@ Usage
 
     esm_runscripts [-h] [-d] [-v] [-e EXPID] [-c] [-P] [-j LAST_JOBTYPE]
                       [-t TASK] [-p PID] [-x EXCLUDE] [-o ONLY]
-                      [-r RESUME_FROM] [-U]
+                      [-r RESUME_FROM] [-U] [-i INSPECT]
                       runscript
 
 Arguments

diff --git a/docs/glossary.rst b/docs/glossary.rst
@@ -0,0 +1,16 @@
+========
+Glossary
+========
+
+.. glossary::
+
+    chunk
+        A chunk is a set of runs.
+    experiment
+        The whole simulation.
+    phase
+        A phase is a part of a workflow that is executed during a run.
+    run
+        A run is the period until a restart is performed.
+    workflow
+        A workflow is a series of phases that are executed during a run.
diff --git a/docs/index.rst b/docs/index.rst
@@ -22,6 +22,7 @@ Welcome to ESM Tools's documentation!
    esm_tests
    motd
    cookbook
+   glossary
    faq
    packages
    API