Skip to content

Commit e730343

Browse files
changes: document the cylc set command
1 parent 9f22a6c commit e730343

File tree

3 files changed

+68
-15
lines changed

3 files changed

+68
-15
lines changed

src/reference/changes.rst

Lines changed: 68 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,74 @@ For more detail see the component changelogs:
2222

2323
----------
2424

25+
Cylc 8.3
26+
--------
27+
28+
.. admonition:: Cylc Components
29+
:class: hint
30+
31+
TODO
32+
33+
Manually setting task outputs / prerequisites
34+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
35+
36+
At Cylc 8.3.0, the ``cylc set-outputs`` command has been replaced by the new
37+
``cylc set`` command.
38+
39+
The ``cylc set-outputs`` command made it look like an output had been generated
40+
to downstream tasks, but did not update the task status to match. As a result,
41+
it was often necessary to use ``cylc remove`` in combination with ``cylc
42+
set-outputs``.
43+
44+
The new ``cylc set`` command is able to directly set task outputs as if they
45+
had completed naturally, making the command more intuitive and avoiding the
46+
need for ``cylc remove``.
47+
48+
For example, say there's a failed task holding up your workflow and you want
49+
Cylc to continue as if the task had succeeded. Here are the interventions
50+
you would need to perform with Cylc 8.2 and 8.3 side-by-side.
51+
52+
.. list-table::
53+
:class: grid-table
54+
55+
* - **Cylc 8.2** (set-outputs)
56+
- **Cylc 8.3** (set)
57+
* - .. code-block:: bash
58+
59+
# let downstream tasks run:
60+
cylc set-outputs <task>
61+
# remove the failed task:
62+
cylc remove <task>
63+
64+
- .. code-block:: bash
65+
66+
# tell Cylc that the task succeeded:
67+
cylc set <task>
68+
69+
* - .. image:: changes/cylc-set-outputs.gif
70+
:align: center
71+
:width: 100%
72+
73+
- .. image:: changes/cylc-set.gif
74+
:align: center
75+
:width: 100%
76+
77+
78+
Tui
79+
^^^
80+
81+
The Tui (terminal user interface) is a command line version of the Gui.
82+
You can use it to monitor and control your workflows.
83+
84+
There has been a major update to Tui at Cylc 8.3.0, you can now use Tui to
85+
browse your installed workflows. Tui is also able to keep up with larger
86+
workflows which would previously have caused it to time out.
87+
88+
.. image:: changes/tui-1.gif
89+
:width: 100%
90+
91+
----------
92+
2593
Cylc 8.2
2694
--------
2795

@@ -52,21 +120,6 @@ environments which set this value. If you want to add to the Cylc
52120
environment itself, e.g. to install a Cylc extension,
53121
use a custom xtrigger, or event handler use ``$CYLC_PYTHONPATH``.
54122

55-
56-
Tui
57-
^^^
58-
59-
The Tui (terminal user interface) is a command line version of the Gui.
60-
You can use it to monitor and control your workflows.
61-
62-
There has been a major update to Tui at Cylc 8.3.0, you can now use Tui to
63-
browse your installed workflows. Tui is now able to keep up with larger
64-
workflows which would previously have caused it to time out.
65-
66-
.. image:: changes/tui-1.gif
67-
:width: 100%
68-
69-
70123
Upgrade To The Latest Jupyter Releases
71124
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
72125

1.51 MB
Loading

src/reference/changes/cylc-set.gif

525 KB
Loading

0 commit comments

Comments
 (0)