Skip to content

Commit b91c44e

Browse files
committed
Add intervention example for triggering pre-startcp tasks after a warm start
1 parent 9a71bd2 commit b91c44e

File tree

3 files changed

+42
-2
lines changed

3 files changed

+42
-2
lines changed

src/dictionaries/words

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,9 +148,9 @@ reconfiguring
148148
refactor
149149
regex
150150
reimplement
151-
reimplements
152151
reimplementation
153152
reimplemented
153+
reimplements
154154
reinstallation
155155
reinstalls
156156
replier

src/glossary.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1030,7 +1030,8 @@ Glossary
10301030
the :term:`initial cycle point`.
10311031

10321032
To satisfy unbounded :term:`intercycle dependence` in the graph, tasks
1033-
prior to the start cycle point are treated as if they have succeeded.
1033+
prior to the start cycle point are treated as if they have succeeded
1034+
(in :term:`flow` 1).
10341035

10351036
.. seealso::
10361037

src/user-guide/interventions/index.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,13 @@ Re-Run Multiple Tasks
122122
> //<cycle-2>/<task-2> \
123123
> ...
124124
125+
.. admonition:: Workflow design tip
126+
:class: tip
127+
128+
If there is a group of tasks that might often need to be re-run together,
129+
consider grouping them into a :term:`family` so that you can easily trigger them
130+
all at once using the family name.
131+
125132

126133
.. _interventions.reflow:
127134

@@ -615,3 +622,35 @@ Remove Tasks
615622
.. code-block:: console
616623
617624
cylc remove <workflow>//<cycle>/<id>
625+
626+
627+
Run tasks at the initial cycle point after a warm start
628+
-------------------------------------------------------
629+
630+
.. versionchanged:: 8.6.2
631+
632+
This did not work properly in prior versions of Cylc 8.
633+
634+
:Example:
635+
I started the workflow using a :term:`start cycle point` greater than
636+
the :term:`initial cycle point` (a.k.a. a :term:`warm start`).
637+
Now I want to run some tasks at a cycle before the start cycle point.
638+
e.g. a family of setup tasks that only exist at the initial cycle point.
639+
640+
:Solution:
641+
Trigger the desired tasks at the earlier cycle point.
642+
See :ref:`interventions.re-run-multiple-tasks`.
643+
All other tasks at cycles before the start cycle point are treated as already complete
644+
(in :term:`flow` 1), so only the triggered tasks will run.
645+
646+
.. tip::
647+
648+
The ``^`` character can be used as a shorthand for the initial cycle point
649+
in the GUI and CLI.
650+
651+
.. note::
652+
653+
If the workflow shuts down while the group of tasks that you triggered
654+
is still in progress, then on restart, Cylc will not remember what tasks
655+
were still left to run in that group. You will need to trigger the remaining
656+
tasks again.

0 commit comments

Comments
 (0)