From d7ccc0d64ddaa045f91c2df079f3eb5ea8fb25a2 Mon Sep 17 00:00:00 2001 From: Tim Pillinger Date: Wed, 8 Jan 2025 14:03:19 +0000 Subject: [PATCH 1/3] titles --- src/reference/changes.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/reference/changes.rst b/src/reference/changes.rst index 2339651cda..4aae3fe243 100644 --- a/src/reference/changes.rst +++ b/src/reference/changes.rst @@ -35,6 +35,18 @@ Cylc 8.4 :cylc-rose: `1.5 `__ :rose: `2.4 `__ +Cylc Remove +^^^^^^^^^^^ + + +Skip Mode +^^^^^^^^^ + +Trigger When Paused +^^^^^^^^^^^^^^^^^^^ + + + EmPy Support Removed ^^^^^^^^^^^^^^^^^^^^ From 1f533a27bb5539fecd69561e12441196b5a62d0d Mon Sep 17 00:00:00 2001 From: Tim Pillinger Date: Thu, 9 Jan 2025 10:39:38 +0000 Subject: [PATCH 2/3] updated the changes guide --- src/reference/changes.rst | 45 +++++++++++++++++++ src/user-guide/interventions/index.rst | 5 +++ .../task-implementation/skip-mode.rst | 4 ++ 3 files changed, 54 insertions(+) diff --git a/src/reference/changes.rst b/src/reference/changes.rst index 4aae3fe243..15370ed370 100644 --- a/src/reference/changes.rst +++ b/src/reference/changes.rst @@ -38,13 +38,58 @@ Cylc 8.4 Cylc Remove ^^^^^^^^^^^ +Cylc Remove now allows removing tasks which are not longer active, making +it look like they never ran. Removing a running task will now kill that task. + +The ``cylc remove`` command now has the ``--flow`` option, allowing removal +of a task from specific flows. + +Tasks Removed from all flows are retained in the workflow database with +``flow=none`` for provenance. + +.. image:: ../user-guide/interventions/remove.gif + :width: 60% + +.. seealso:: + + See :ref:`interventions.remove_tasks` to see an example of this feature in + action. Skip Mode ^^^^^^^^^ +Tasks can be configured to run in skip mode, either from the configuration +or by broadcasting. + +.. image:: ../user-guide/interventions/skip-cycle.gui.gif + :width: 60% + +``cylc set --out skip`` will set outputs for a task as if the task has run +in skip mode. The task outputs delivered by skip mode can be customized using +:cylc:conf:`[runtime][][skip]outputs` or defaults to behaviour +described in :ref:`skip_mode.task_outputs`. + +This can be used to skip a cycle or a task (for a full example see + :ref:`interventions.skip_cycle`). + +It may also be useful for :ref:`EfficientInterFamilyTriggering` and +for :ref:`skip_mode.parameter_exclusion`. + +.. seealso:: + + :ref:`task-run-modes.skip` + Trigger When Paused ^^^^^^^^^^^^^^^^^^^ +Tasks can now be triggered and will run immediately while the workflow +is paused. + + +.. image:: ../user-guide/interventions/trigger-while-paused.gif + :width: 60% + +See :ref:`interventions.trigger_while_paused` for an example of this feature. EmPy Support Removed diff --git a/src/user-guide/interventions/index.rst b/src/user-guide/interventions/index.rst index c07366dced..3de007fe5d 100644 --- a/src/user-guide/interventions/index.rst +++ b/src/user-guide/interventions/index.rst @@ -441,6 +441,8 @@ but specify the "failed" output rather than "succeeded". +.. _interventions.trigger_while_paused: + Pause The Workflow And Trigger Tasks One By One ----------------------------------------------- @@ -489,6 +491,7 @@ Pause The Workflow And Trigger Tasks One By One submit) until released. If you hold a running task its job will not be affected, but it will not submit any :term:`retries ` until released. +.. _interventions.skip_cycle: I want to Skip a cycle of tasks and allow the workflow to continue ------------------------------------------------------------------ @@ -525,6 +528,8 @@ I want to Skip a cycle of tasks and allow the workflow to continue multiple named tasks. +.. _interventions.remove_tasks: + Remove Tasks ------------ diff --git a/src/user-guide/task-implementation/skip-mode.rst b/src/user-guide/task-implementation/skip-mode.rst index 328ca45932..35fb615162 100644 --- a/src/user-guide/task-implementation/skip-mode.rst +++ b/src/user-guide/task-implementation/skip-mode.rst @@ -29,6 +29,8 @@ Skip mode is designed as an aid to workflow control: If you are using skip mode deliberately then this can be ignored. +.. _skip_mode.task_outputs: + Task Outputs ------------ @@ -97,6 +99,8 @@ families improves the efficiency of the Cylc scheduler. This scenario is explained in detail in :ref:`EfficientInterFamilyTriggering` +.. _skip_mode.parameter_exclusion: + Parameter Exclusion ^^^^^^^^^^^^^^^^^^^ From 8dc295758034ea684c63cd5082167520c2ccefcf Mon Sep 17 00:00:00 2001 From: Tim Pillinger Date: Thu, 9 Jan 2025 14:37:31 +0000 Subject: [PATCH 3/3] small fix, update intersphinx --- src/conf.py | 2 +- src/reference/changes.rst | 15 +++++++++------ 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/src/conf.py b/src/conf.py index a3129a0e65..e9363633b8 100644 --- a/src/conf.py +++ b/src/conf.py @@ -120,7 +120,7 @@ # $ python -m sphinx.ext.intersphinx /objects.inv | less intersphinx_mapping = { 'rose': ( - 'http://metomi.github.io/rose/2.3.0/html', None + 'http://metomi.github.io/rose/2.4.0/html', None ), 'python': ( 'https://docs.python.org/3/', None diff --git a/src/reference/changes.rst b/src/reference/changes.rst index 15370ed370..18875eb30c 100644 --- a/src/reference/changes.rst +++ b/src/reference/changes.rst @@ -38,13 +38,13 @@ Cylc 8.4 Cylc Remove ^^^^^^^^^^^ -Cylc Remove now allows removing tasks which are not longer active, making +Cylc Remove now allows removing tasks which are no longer active, making it look like they never ran. Removing a running task will now kill that task. The ``cylc remove`` command now has the ``--flow`` option, allowing removal of a task from specific flows. -Tasks Removed from all flows are retained in the workflow database with +Tasks removed from all flows are retained in the workflow database with ``flow=none`` for provenance. .. image:: ../user-guide/interventions/remove.gif @@ -58,7 +58,9 @@ Tasks Removed from all flows are retained in the workflow database with Skip Mode ^^^^^^^^^ -Tasks can be configured to run in skip mode, either from the configuration +Tasks can now be run in "skip" mode where they complete +their required outputs instantly. +Tasks can be configured to run in skip mode either in the workflow configuration or by broadcasting. .. image:: ../user-guide/interventions/skip-cycle.gui.gif @@ -69,8 +71,7 @@ in skip mode. The task outputs delivered by skip mode can be customized using :cylc:conf:`[runtime][][skip]outputs` or defaults to behaviour described in :ref:`skip_mode.task_outputs`. -This can be used to skip a cycle or a task (for a full example see - :ref:`interventions.skip_cycle`). +This can be used to skip a cycle or a task (for a full example see :ref:`interventions.skip_cycle`). It may also be useful for :ref:`EfficientInterFamilyTriggering` and for :ref:`skip_mode.parameter_exclusion`. @@ -89,7 +90,9 @@ is paused. .. image:: ../user-guide/interventions/trigger-while-paused.gif :width: 60% -See :ref:`interventions.trigger_while_paused` for an example of this feature. +.. seealso:: + + :ref:`interventions.trigger_while_paused` for an example of this feature. EmPy Support Removed