Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
wxtim committed Sep 24, 2024
1 parent 736d010 commit b7667ca
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions src/user-guide/task-implementation/run-modes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,16 @@ Task Run Modes

.. versionadded:: 8.4.0

<<<<<<< HEAD
* Before 8.4.0 run modes could only be set for the workflow, not
for individual tasks.
* New run mode, "skip", added.
=======
Before 8.4.0 run modes could only be set for the workflow, not
for individual tasks.

Skip mode is new at 8.4.0.
>>>>>>> 76e6d437 (wip)

As well as the default task implementation ("live" mode)
other implementations can be selected by setting the
Expand Down Expand Up @@ -58,7 +65,11 @@ simple ``sleep 10`` tasks that submit to a remote platform.
Simulation Mode
---------------

<<<<<<< HEAD
**Simulation mode** does not run real jobs, and does not generate job
=======
**Simulation mode** does not run real jobs at all, and does not generate job
>>>>>>> 76e6d437 (wip)
log files.


Expand All @@ -70,9 +81,13 @@ changed with :cylc:conf:`[runtime][<namespace>][simulation]default run length`.

If :cylc:conf:`[runtime][<namespace>]execution time limit` and
:cylc:conf:`[runtime][<namespace>][simulation]speedup factor` are both set,
<<<<<<< HEAD
run length is computed by dividing the
:cylc:conf:`[runtime][<namespace>]execution time limit` by
:cylc:conf:`[runtime][<namespace>][simulation]` speedup factor.
=======
run length is computed by dividing the time limit by the speedup factor.
>>>>>>> 76e6d437 (wip)

Simulated Failure
^^^^^^^^^^^^^^^^^
Expand All @@ -85,9 +100,12 @@ Tasks always complete custom outputs, by default they succeed.
submitted and/or started outputs are generated - so you will not
be able to test graph pathways such as ``task:started => do_something``.

<<<<<<< HEAD
If you want to test individual pathways, use
:ref:`skip mode <task-run-modes.skip>`.

=======
>>>>>>> 76e6d437 (wip)
You can set some or all instances of a task to fail using
:cylc:conf:`[runtime][<namespace>][simulation]fail cycle points`.
``fail cycle points`` takes either a list of cycle point strings or "all".
Expand Down Expand Up @@ -132,20 +150,18 @@ artificially completed in dummy mode and in simulation mode.
Skip Mode
---------

<<<<<<< HEAD
Skip mode is designed as an aid to workflow control:

* Allows creation of dummy tasks as part of workflow design.
* Allows skipping of tasks in a running workflow.
=======
Skip mode is designed as an aid to workflow control.
>>>>>>> 76e6d437 (wip)

Skip mode allows the user to specify which task outputs
will be emitted using :cylc:conf:`[runtime][<namespace>][skip]outputs`.

By default started, submitted, succeeded and all
required outputs will be emitted.

If outputs are specified, but neither succeeded or
failed are specified, succeeded will automatically be emitted.

By default task event handlers are disabled by skip mode, but they
can be enabled using
:cylc:conf:`[runtime][<namespace>][skip]disable task event handlers`.
Expand Down

0 comments on commit b7667ca

Please sign in to comment.