From d4a07707256ee4a306f9b9b839f2c0247bf40a59 Mon Sep 17 00:00:00 2001 From: Hilary James Oliver Date: Thu, 2 Jun 2022 16:17:51 +1200 Subject: [PATCH] Remove outdated sub-workflow documentation. --- .../running-workflows/dynamic-behaviour.rst | 32 +------------------ 1 file changed, 1 insertion(+), 31 deletions(-) diff --git a/src/user-guide/running-workflows/dynamic-behaviour.rst b/src/user-guide/running-workflows/dynamic-behaviour.rst index 4f351e60af..24636d0ca8 100644 --- a/src/user-guide/running-workflows/dynamic-behaviour.rst +++ b/src/user-guide/running-workflows/dynamic-behaviour.rst @@ -14,34 +14,4 @@ Broadcast settings targeting a specific cycle point expire as the workflow moves on. Otherwise they persist for lifetime of the run, and across restarts, unless cleared with another invocation of the command. - -.. _Sub-Workflows: - -Sub-Workflows -------------- - -A single Cylc workflow can have multiple cycling sequences in the graph, -but cycles can't be nested. If you need *cycles within cycles* - e.g. to -iterate over many files generated by each run of a cycling task - options are: - -- Parameterize the sub-cycles - - - This is easy but it makes more tasks-per-cycle, which is the primary - determinant of workflow size and scheduler efficiency (this has a much - smaller impact on Cylc 8, however) - -- Use a separate sub-workflow inside a main-workflow task, to run the sub-cycle - tasks at each main-workflow cycle point - - - This is very efficient, but monitoring and run-directory housekeeping are - be more complicated because it creates multiple workflows and run directories - -Sub-workflows must be started with ``--no-detach`` so that the containing task -does not finish until the sub-workflow does, and they should be non-cycling -or have a ``final cycle point`` so they don't keep on running indefinitely. - -Sub-workflow names should normally incorporate the main-workflow cycle point -so that successive sub-workflows can run concurrently if necessary and do not -compete for the same workflow run directory. This generates a new sub-workflow -run directory for every main-workflow cycle point, so you may need housekeeping -tasks to extract outputs from each sub-workflow run and tidy up its directories. +.. TODO: document sub-workflows