From 13afa08fa7a172d410fd08d59b50bced2e258d1b Mon Sep 17 00:00:00 2001 From: Tim Pillinger <26465611+wxtim@users.noreply.github.com> Date: Mon, 2 Dec 2024 16:29:34 +0000 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com> Co-authored-by: Hilary James Oliver --- .../running-workflows/workflow-run-modes.rst | 15 ++++++--------- src/user-guide/troubleshooting.rst | 4 ++-- src/user-guide/writing-workflows/scheduling.rst | 5 ++--- 3 files changed, 10 insertions(+), 14 deletions(-) diff --git a/src/user-guide/running-workflows/workflow-run-modes.rst b/src/user-guide/running-workflows/workflow-run-modes.rst index 3b0e7a29493..5381aa6889b 100644 --- a/src/user-guide/running-workflows/workflow-run-modes.rst +++ b/src/user-guide/running-workflows/workflow-run-modes.rst @@ -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 @@ -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 `. +If you want to test individual workflow pathways, use +:ref:`skip mode `. You can set some or all instances of a task to fail using :cylc:conf:`[runtime][][simulation]fail cycle points`. diff --git a/src/user-guide/troubleshooting.rst b/src/user-guide/troubleshooting.rst index 3968880973a..ca4b3d99cd4 100644 --- a/src/user-guide/troubleshooting.rst +++ b/src/user-guide/troubleshooting.rst @@ -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 diff --git a/src/user-guide/writing-workflows/scheduling.rst b/src/user-guide/writing-workflows/scheduling.rst index 0a5970b90fe..fb8c9083fdf 100644 --- a/src/user-guide/writing-workflows/scheduling.rst +++ b/src/user-guide/writing-workflows/scheduling.rst @@ -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: