Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
Co-authored-by: Hilary James Oliver <hilary.j.oliver@gmail.com>
  • Loading branch information
3 people authored Dec 2, 2024
1 parent 4d9f535 commit 13afa08
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 14 deletions.
15 changes: 6 additions & 9 deletions src/user-guide/running-workflows/workflow-run-modes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,12 @@ Workflow Run Modes
------------------

Cylc can run a workflow without running the real jobs, which may be
long-running and resource-hungry.

This is useful when developing workflows. Tasks submitted
useful when developing workflows. Tasks submitted
using :ref:`workflow-run-modes.dummy` and
:ref:`workflow-run-modes.simulation` can be used while
developing workflows to understand how different outcomes
:ref:`workflow-run-modes.simulation` can be used to understand how different outcomes
and run lengths will affect the workflow.

To apply a run mode to a workflow:
To start a workflow in one of these modes:

.. code-block:: console
Expand Down Expand Up @@ -72,10 +69,10 @@ run length is computed by dividing the
Simulated Failure
^^^^^^^^^^^^^^^^^

Tasks always complete all custom outputs, by default they succeed.
Tasks always complete all custom outputs, and by default they will succeed.

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

You can set some or all instances of a task to fail using
:cylc:conf:`[runtime][<namespace>][simulation]fail cycle points`.
Expand Down
4 changes: 2 additions & 2 deletions src/user-guide/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -309,12 +309,12 @@ logged a file in this directory:

If you need to access files from a remote platform (e.g. 2-stage ``fcm_make``),
ensure that a task has submitted to it before you do so. If needed you can use
a blank "non-functional" task to ensure that remote installation is completed *before*
a blank :ref:`dummy task` task to ensure that remote installation is completed *before*
you run any tasks which require this e.g:

.. code-block:: cylc-graph
non_functional => fetch_files
dummy => fetch_files
Conda / Mamba environment activation fails
Expand Down
5 changes: 2 additions & 3 deletions src/user-guide/writing-workflows/scheduling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1310,9 +1310,8 @@ significantly less memory and CPU to store and evaluate.

.. note::

By setting ``run mode = skip`` the task will be follow the
:ref:`task-run-modes.skip` submission pathway, which
is significantly more efficient than a conventional task.
By setting ``run mode = skip`` the task's execution will be simulated
quickly, with no real job submitted.


.. _InterCyclePointTriggers:
Expand Down

0 comments on commit 13afa08

Please sign in to comment.