From 07d78043f87449f7ce884d597ad8e50e57fa8ee0 Mon Sep 17 00:00:00 2001 From: samuel-denton Date: Wed, 4 Feb 2026 13:21:11 +0000 Subject: [PATCH 1/6] Adding tabs to the introduction page showing each UI type. Spotted/fixed a mistake on the interventions page causing tabs to not sync properly. --- src/tutorial/introduction.rst | 19 +++++++++++++++++++ src/user-guide/interventions/index.rst | 2 +- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/src/tutorial/introduction.rst b/src/tutorial/introduction.rst index ebaada27d8..6e5e53749c 100644 --- a/src/tutorial/introduction.rst +++ b/src/tutorial/introduction.rst @@ -93,6 +93,25 @@ User Interface), web GUI, and ``cylc scan`` (bottom left) are shown below. .. image:: /tutorial/img/cylc-tools.png :alt: A screenshot of several Cylc tools. +.. tab-set:: + + .. tab-item:: GUI - Placeholders + + .. image:: re-run-a-task.gui.gif + :width: 75% + + .. tab-item:: Tui - Placeholders + + .. image:: re-run-a-task.tui.gif + :width: 75% + + .. tab-item:: CLI - Placeholders + + .. code-block:: console + + $ cylc trigger // + + .. nextslide:: .. ifslides:: diff --git a/src/user-guide/interventions/index.rst b/src/user-guide/interventions/index.rst index d36b094862..e516fe23ec 100644 --- a/src/user-guide/interventions/index.rst +++ b/src/user-guide/interventions/index.rst @@ -113,7 +113,7 @@ Re-Run Multiple Tasks :width: 75% .. tab-item:: CLI - :sync: gui + :sync: cli .. code-block:: console From 819e91b1c9c0df7a761c599f7dc952236fa10c68 Mon Sep 17 00:00:00 2001 From: samuel-denton Date: Wed, 4 Feb 2026 13:51:03 +0000 Subject: [PATCH 2/6] Added tabs to the into and found some placeholder images to work on formatting. --- src/tutorial/introduction.rst | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/src/tutorial/introduction.rst b/src/tutorial/introduction.rst index 6e5e53749c..4b8bb1b68b 100644 --- a/src/tutorial/introduction.rst +++ b/src/tutorial/introduction.rst @@ -88,28 +88,38 @@ Cylc can automatically: Cylc provides a variety of command line and GUI tools for visualising, monitoring, and controlling workflows. The Cylc TUI (Terminal -User Interface), web GUI, and ``cylc scan`` (bottom left) are shown below. +User Interface), web GUI, and ``cylc scan`` are shown below. -.. image:: /tutorial/img/cylc-tools.png - :alt: A screenshot of several Cylc tools. +**Placeholder Images Currently Used** .. tab-set:: - .. tab-item:: GUI - Placeholders + .. tab-item:: GUI - .. image:: re-run-a-task.gui.gif + .. image:: ../../src/img/cylc-ui-dash.png + :alt: A screenshot of the Cylc GUI dashboard. :width: 75% - .. tab-item:: Tui - Placeholders + .. tab-item:: Tui - .. image:: re-run-a-task.tui.gif + .. image:: ../../src/img/tui-1.png + :alt: A screenshot of the Cylc TUI. :width: 75% - .. tab-item:: CLI - Placeholders + .. tab-item:: Cylc Scan + + .. image:: /tutorial/img/cylc-tools.png + :alt: A screenshot of the Cylc TUI. + :width: 75% + + .. tab-item:: CLI .. code-block:: console - $ cylc trigger // + $ cylc trigger // \ + > /// \ + > /// \ + > ... .. nextslide:: From 2a72285c789bfa7a326357555e0181c4535dab02 Mon Sep 17 00:00:00 2001 From: samuel-denton Date: Wed, 4 Feb 2026 16:49:06 +0000 Subject: [PATCH 3/6] Added a note explaining why R1 was swapped for P1 here. --- src/tutorial/scheduling/integer-cycling.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/tutorial/scheduling/integer-cycling.rst b/src/tutorial/scheduling/integer-cycling.rst index 26d0af6c1d..9949dd2495 100644 --- a/src/tutorial/scheduling/integer-cycling.rst +++ b/src/tutorial/scheduling/integer-cycling.rst @@ -71,7 +71,16 @@ To make a workflow repeat we must tell Cylc three things: * ``initial cycle point = 1`` tells Cylc to start counting cycle points from 1. * ``P1`` is the :term:`recurrence`; a ``P1`` :term:`graph string` - repeats at every integer :term:`cycle point`. + tells Cylc to repeat at every integer :term:`cycle point`. + + .. note:: + + The recurrence term tells Cylc *how often* to repeat the tasks and + dependencies in that block. ``R1`` means *run once* (no cycling), + ``P1`` means *repeat every cycle*, ``P2`` means *repeat every other cycle*, + and so on. + Other terms are configurable and are introduced in the next section. + The first three :term:`cycles` look like this, with the entire workflow repeated at each cycle point: From f78908c916e6443922e8289ac07af5f4a6a4c412 Mon Sep 17 00:00:00 2001 From: samuel-denton Date: Tue, 17 Mar 2026 11:24:27 +0000 Subject: [PATCH 4/6] This tip no longer applies due to conda adopting the Libmamba dependency resolver --- src/installation.rst | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/src/installation.rst b/src/installation.rst index 66f5060e18..92893b4270 100644 --- a/src/installation.rst +++ b/src/installation.rst @@ -19,19 +19,6 @@ Cylc runs on Unix-like systems including Linux and Mac OS. Via Conda (recommended) ^^^^^^^^^^^^^^^^^^^^^^^ -.. tip:: - - We recommend using Mamba to install Cylc. - Mamba (or Micromamba) can be used as - `a faster, drop-in replacement for the conda command - `_. - If using Conda, make sure to use the libmamba-solver by updating to - Conda 23.10 or using the `conda-libmamba-solver plugin for conda - `_. - The classic conda environment solver may be too slow for a complex package - like Cylc. - - .. code-block:: sub $ conda install -c conda-forge cylc-flow @@ -294,8 +281,8 @@ can be found: :ref:`UI_Server_config`. Bash Profile ^^^^^^^^^^^^ -Cylc :term:`job scripts ` are bash scripts, which is good for -manipulating files and processes, They invoke ``bash -l`` to allow environment +Cylc :term:`job scripts ` are bash scripts, which are good for +manipulating files and processes. They invoke ``bash -l`` to allow environment configuration in login scripts. .. warning:: From 7eb4924fdd212bd4e12093ad870afc387946caa0 Mon Sep 17 00:00:00 2001 From: samuel-denton Date: Tue, 17 Mar 2026 15:47:18 +0000 Subject: [PATCH 5/6] Slight wording changes on the install instructions. Added sleep 5 to a tutorial and added a description of why wallclock triggers are required to run tasks in real time. --- src/installation.rst | 4 ++-- src/tutorial/furthertopics/clock-triggered-tasks.rst | 8 ++++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src/installation.rst b/src/installation.rst index 92893b4270..80b536ff4e 100644 --- a/src/installation.rst +++ b/src/installation.rst @@ -54,7 +54,7 @@ Via Pip (+npm) $ pip install cylc-rose metomi-rose There are also certain optional extra requirements which you may choose to -install: +install (already included if installing via Conda): .. code-block:: sub @@ -87,7 +87,7 @@ These dependencies are not installed by Conda or pip: * ``rsync`` * ``mail`` (optional - for automated email functionality) -These dependencies are installed by Conda but not by pip: +The following dependencies are installed automatically by Conda but not by pip: * `Graphviz`_ (optional - used by ``cylc graph`` for displaying workflow graphs) diff --git a/src/tutorial/furthertopics/clock-triggered-tasks.rst b/src/tutorial/furthertopics/clock-triggered-tasks.rst index 0da5e7ec92..bda4426e7a 100644 --- a/src/tutorial/furthertopics/clock-triggered-tasks.rst +++ b/src/tutorial/furthertopics/clock-triggered-tasks.rst @@ -60,7 +60,7 @@ Paste the following code into a ``flow.cylc`` file: [[[events]]] mail events = failed [[bell]] - script = printf 'bong%.02d\n' $(seq 1 $(cylc cyclepoint --print-hour)) + script = printf 'bong%.02d\n' $(seq 1 $(cylc cyclepoint --print-hour)); sleep 5 Change the initial cycle point to 00:00 this morning (e.g. if it was the first of January 2000 we would write ``2000-01-01T00Z``). @@ -77,7 +77,11 @@ Run your workflow using:: Stop the workflow after a few cycles using ``cylc stop --now --now clock-trigger``. Notice how the tasks run as soon as possible rather than waiting for the actual time to be equal to the cycle point. - +If we didn't have the ``sleep 5`` in the task script, +the tasks would run so quickly that we would not be able to see this behaviour. +In some scenarios, such as climate modelling, this is the desired behaviour as +it allows the workflow to run faster than real-time, what you might call simulation time. +However, below we describe how to make the workflow run in real-time using clock triggers. Clock-Triggering Tasks ---------------------- From d06a82cd991d2ef519a0223b3118e7512ee965fc Mon Sep 17 00:00:00 2001 From: samuel-denton Date: Tue, 17 Mar 2026 16:47:07 +0000 Subject: [PATCH 6/6] Fixed the order of 'The Three Approaches' in Consolidating Configuration so the 2 places they are listed match. --- .../runtime/configuration-consolidation/index.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/tutorial/runtime/configuration-consolidation/index.rst b/src/tutorial/runtime/configuration-consolidation/index.rst index 7ad00b8f9c..0c8b9c0ebf 100644 --- a/src/tutorial/runtime/configuration-consolidation/index.rst +++ b/src/tutorial/runtime/configuration-consolidation/index.rst @@ -139,10 +139,12 @@ The Three Approaches could use them to simplify the workflow from the previous tutorial. *Work through them in order!* -* :ref:`families ` -* :ref:`jinja2 ` -* :ref:`parameters ` +.. toctree:: + :maxdepth: 1 + jinja2 + families + parameters .. _cylc-tutorial-consolidation-conclusion: