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 b7667ca commit 6723e28
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 30 deletions.
12 changes: 2 additions & 10 deletions src/user-guide/running-workflows/simulation-modes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Run Modes
---------

The run modes described in :ref:`task-run-modes` can
be applied to the entire workflow.
The "live", "simulation" and "dummy" modes described in
:ref:`task-run-modes` can be applied to the entire workflow.

This is useful when developing workflows. Tasks submitted
using :ref:`task-run-modes.dummy` and
Expand All @@ -19,14 +19,6 @@ To apply a run mode to a workflow:
$ cylc play --mode=dummy <workflow-id>
$ cylc play --mode=simulation <workflow-id>
.. note::

If a task has a run-mode set using
:cylc:conf:`[runtime][<namespace>]run mode`
this will override any run mode set for the workflow
on the command line.


Limitations
^^^^^^^^^^^

Expand Down
33 changes: 13 additions & 20 deletions src/user-guide/task-implementation/run-modes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ Task Run Modes
>>>>>>> 76e6d437 (wip)

As well as the default task implementation ("live" mode)
other implementations can be selected by setting the
scheduler run mode as an argument to the ``cylc play``
command, or for each task using
:cylc:conf:`[runtime][<namespace>]run mode`.
other implementations can be selected:

* By setting the scheduler run mode as an argument to the
``cylc play --mode`` command ("simulation" and "dummy" modes).
* By setting :cylc:conf:`[runtime][<namespace>]run mode` for
"skip" mode.

.. note::

Expand All @@ -35,23 +37,20 @@ command, or for each task using
the workflow scripts with dummy scripts and returns
to the default ("live") submission pathway.
#. :ref:`task-run-modes.skip`: Intended to allow more control of the workflow,
the scheduler marks the task as completed.
the scheduler marks task outputs as completed.

.. _task-run-modes.dummy:

Dummy Mode
----------

**Dummy mode** replaces real jobs with background ``sleep`` jobs on the
scheduler host. This avoids :term:`job runner` directives that request compute
**Dummy mode** replaces real jobs with background jobs on the
scheduler host which use ``sleep`` to simulate the run length according to
the settings described for simulation mode.
This avoids :term:`job runner` directives that request compute
resources for real workflow tasks, and it allows any workflow configuration to
be run locally in dummy mode.

.. note::

Dummy mode follows the rules for simulated run length
and simulated failure set out in the simulation mode section.

Limitations
^^^^^^^^^^^

Expand Down Expand Up @@ -92,13 +91,7 @@ run length is computed by dividing the time limit by the speedup factor.
Simulated Failure
^^^^^^^^^^^^^^^^^

Tasks always complete custom outputs, by default they succeed.

.. warning::

In simulation mode a succeeded output may not imply that
submitted and/or started outputs are generated - so you will not
be able to test graph pathways such as ``task:started => do_something``.
Tasks always complete all custom outputs, by default they succeed.

<<<<<<< HEAD
If you want to test individual pathways, use
Expand Down Expand Up @@ -230,5 +223,5 @@ succeeds without running anything:
[runtime]
[[post parcel<house_number>]]
script = send letter
[[post parcel_13]]
[[post parcel<house_number=13>]]
run mode = skip

0 comments on commit 6723e28

Please sign in to comment.