Skip to content
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
aa2399d
Adding tabs to the introduction page showing each UI type. Spotted/f…
samuel-denton Feb 4, 2026
465f46e
Added tabs to the into and found some placeholder images to work on f…
samuel-denton Feb 4, 2026
13b6832
Added a note explaining why R1 was swapped for P1 here.
samuel-denton Feb 4, 2026
4016765
This tip no longer applies due to conda adopting the Libmamba depende…
samuel-denton Mar 17, 2026
f41651c
Slight wording changes on the install instructions.
samuel-denton Mar 17, 2026
af9a92c
Fixed the order of 'The Three Approaches' in Consolidating Configurat…
samuel-denton Mar 17, 2026
7c2e36f
Further reorder of approaches on consolidation to match toc.
samuel-denton Mar 17, 2026
fb49049
Added proper images for the introduction page tabs showing GUI, TUI a…
samuel-denton Mar 18, 2026
609cff9
Trying to clarify what packages need installing depending on method.
samuel-denton Mar 18, 2026
a8572f0
Apply suggestion from @oliver-sanders
samuel-denton Apr 27, 2026
c9d07d0
Apply suggestion from @samuel-denton
samuel-denton Apr 27, 2026
3a5972d
Started re-organizing tutorials so they make sense in order.
samuel-denton Apr 28, 2026
e7ad72c
small layout improvements to tutorial diffs
samuel-denton Apr 30, 2026
9a16acf
Update jinja2.rst
samuel-denton May 6, 2026
f6affb5
Altered the jinja2 tutorial so the variable is used more than once.
samuel-denton May 6, 2026
5f29081
Wording change to tutorial
samuel-denton May 6, 2026
d0af77a
Update src/tutorial/introduction.rst
samuel-denton May 11, 2026
9b6a004
Re-worked the consolidation tutorials.
samuel-denton May 13, 2026
7f25cfb
Removed extra quote
samuel-denton May 22, 2026
ec2f4df
Reverted help text.
samuel-denton May 22, 2026
fd8f02b
Delete cylc-tools.png
samuel-denton May 22, 2026
24fd350
Increased image width in introduction.
samuel-denton May 22, 2026
9cd0717
Update introduction.rst
samuel-denton May 22, 2026
2b6a4e9
new cylc-cli image.
samuel-denton May 22, 2026
33eea11
Added comment to example
samuel-denton May 27, 2026
9c2d534
Changed order of some diff text
samuel-denton May 27, 2026
e91c81b
Removed redundant example
samuel-denton May 27, 2026
be7c9ad
Improved wording on recurrence terms
samuel-denton May 27, 2026
9a71138
Removed Jinja2 from comments in diff text
samuel-denton May 27, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added src/img/cylc-cli.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 6 additions & 18 deletions src/installation.rst
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lots of small wording changes to clarify what is and is not installed via pip vs conda.

Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://mamba.readthedocs.io/en/latest/index.html>`_.
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
<https://conda.github.io/conda-libmamba-solver/getting-started/>`_.
The classic conda environment solver may be too slow for a complex package
like Cylc.
Comment on lines -22 to -32
Copy link
Copy Markdown
Contributor Author

@samuel-denton samuel-denton Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#916 (comment)

This tip is no longer relevant thanks to conda adopting the Libmamba dependency resolver



.. code-block:: sub

$ conda install -c conda-forge cylc-flow
Expand Down Expand Up @@ -67,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

Expand All @@ -92,15 +79,16 @@ Non-Python Requirements
.. _Graphviz: https://graphviz.org/download/
.. _configurable-http-proxy: https://anaconda.org/conda-forge/configurable-http-proxy

These dependencies are not installed by Conda or pip:
These dependencies are not installed by Conda or pip and may not be available on your
system by default:

* ``bash``
* GNU `coreutils`_
* ``ssh``
* ``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)
Expand Down Expand Up @@ -290,8 +278,8 @@ can be found: :ref:`UI_Server_config`.
Bash Profile
^^^^^^^^^^^^

Cylc :term:`job scripts <job script>` are bash scripts, which is good for
manipulating files and processes, They invoke ``bash -l`` to allow environment
Cylc :term:`job scripts <job script>` are bash scripts, which are good for
manipulating files and processes. They invoke ``bash -l`` to allow environment
configuration in login scripts.

.. warning::
Expand Down
8 changes: 6 additions & 2 deletions src/tutorial/furthertopics/clock-triggered-tasks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Copy Markdown
Contributor Author

@samuel-denton samuel-denton Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added sleep 5 to tutorial to allow users time to see the workflow running. A previous update to cylc sped up the running of this workflow significantly.


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``).
Expand All @@ -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.
Comment thread
samuel-denton marked this conversation as resolved.
Outdated
Comment thread
samuel-denton marked this conversation as resolved.
Outdated

Clock-Triggering Tasks
----------------------
Expand Down
25 changes: 22 additions & 3 deletions src/tutorial/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,29 @@ 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**

Comment thread
samuel-denton marked this conversation as resolved.
Outdated
.. tab-set::

.. tab-item:: GUI

.. image:: ../../src/img/cylc-ui-dash.png
:alt: A screenshot of the Cylc GUI dashboard.
:width: 75%

.. tab-item:: Tui

.. image:: ../../src/img/tui-1.png
:alt: A screenshot of the Cylc TUI.
:width: 75%

.. tab-item:: CLI

.. image:: ../../src/img/cylc-cli.png
:alt: A screenshot of the Cylc CLI.
:width: 75%
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these tabs are a little clearer and less intimidating than the combined image used before.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cylc-tools.png can be deleted as it is no longer used.

Also, can you remove the width directive as it makes the images smaller and harder to see properly?

The text above mentions cylc scan but it is not present in the CLI screenshot. Also the CLI screenshot text is rather small even with the width directive removed.

Sorry that was a bunch of alsos 😄


.. nextslide::

Expand Down
18 changes: 10 additions & 8 deletions src/tutorial/runtime/configuration-consolidation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <tutorial-cylc-families>`
* :ref:`jinja2 <tutorial-cylc-jinja2>`
* :ref:`parameters <tutorial-cylc-parameterization>`
.. toctree::
:maxdepth: 1

jinja2
families
parameters
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changes the order in which the tutorials are attempted.

Does this work?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this is just correcting the order in this sub-list so it matches the order elsewhere. This is section 3 in the image:

Image

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try attempting the Jinja2 tutorial without first attempting the Families tutorial. There's a dependency between them.

The step numbers in the practicals outline the intended order:

  • Families 1 & 2.
  • Jinja2 3.
  • Parameters 4.

The previous order was correct, i.e, it's the bit above which needs to change for consistency.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok, I'll have another look.
If that is the case, and I think you are right, we are going to need to alter the toctree in a few places as currently, both the contents page and the menu go JinJa2 > Fam > Params. Currently, going page by page from the start will be JinJa2 > Fam.
Let me confirm the order 100% and I'll make that change.


.. _cylc-tutorial-consolidation-conclusion:

Expand All @@ -154,12 +156,12 @@ Which Approach To Use
Each approach has its uses. Cylc permits mixing approaches, allowing us to
use what works best for us. As a rule of thumb:

* :term:`Families <family>` work best consolidating runtime configuration by
collecting tasks into broad groups, e.g. groups of tasks which run on a
particular machine or groups of tasks belonging to a particular system.
* `Jinja2`_ is good at configuring settings which apply to the entire workflow
rather than just a single task, as we can define variables then use them
throughout the workflow.
* :term:`Families <family>` work best consolidating runtime configuration by
collecting tasks into broad groups, e.g. groups of tasks which run on a
particular machine or groups of tasks belonging to a particular system.
* :term:`Parameterization <parameterization>` works best for describing tasks
which are very similar but which have subtly different configurations
(e.g. different arguments or environment variables).
Comment on lines -157 to 167
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reorder to match toc tree

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GH should be showing this as outdated as the change is reverted in a following commit.

Expand All @@ -168,10 +170,10 @@ Which Approach To Use

As a rule of thumb each method works best for:

Families
Collecting tasks into broad groups.
Jinja2
Configuration settings which apply to the entire workflow.
Families
Collecting tasks into broad groups.
Parameterization
Tasks which are similar.

Expand Down
11 changes: 10 additions & 1 deletion src/tutorial/scheduling/integer-cycling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor change to keep consistency with other bullets.


.. 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.
Comment thread
samuel-denton marked this conversation as resolved.
Outdated

Comment thread
samuel-denton marked this conversation as resolved.
Outdated

The first three :term:`cycles<cycle>` look like this, with the entire
workflow repeated at each cycle point:
Expand Down
2 changes: 1 addition & 1 deletion src/user-guide/interventions/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Re-Run Multiple Tasks
:width: 75%

.. tab-item:: CLI
:sync: gui
:sync: cli
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small mistake here caused tabs to sync incorrectly.


.. code-block:: console

Expand Down
Loading