Skip to content

Commit

Permalink
tui: document recent enhancements
Browse files Browse the repository at this point in the history
  • Loading branch information
oliver-sanders committed Oct 12, 2023
1 parent 7f6a81f commit 4cc168d
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 32 deletions.
28 changes: 1 addition & 27 deletions src/7-to-8/caveats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Installing Workflows
At present there is no way to view or install
:term:`source workflows <source directory>` in the UI.
Rose Edit
Rose Edit is awaiting reimplementation in the UI.
Rose Edit is awaiting reimplementation.
Xtrigger Visibility
Xtriggers are not yet visible in the UI.

Expand All @@ -49,32 +49,6 @@ Documentation / Orientation Guide
* https://github.com/cylc/cylc-ui/issues/155


Terminal User Interface
-----------------------

The ``cylc tui`` command (Tui) replaces the old ``cylc monitor``. It provides a
tree view that is very similar to the Cylc UI and supports some control
functionality.

Performance
TUI currently refreshes its display every second. Large workflows which
change rapidly may evolve faster than TUI is able to keep pace with which
will cause TUI to freeze.

A more performant implementation which does not rely on a scheduled global
update will follow in due course.

* https://github.com/cylc/cylc-flow/issues/3527
GScan
The old ``cylc gscan`` GUI has been removed. You can now find the gscan
display on the left-hand side of the Cylc UI.

In a future release ``cylc tui`` will be able to list workflows in a similar
way.

* https://github.com/cylc/cylc-flow/issues/3464


UI Server
---------

Expand Down
6 changes: 2 additions & 4 deletions src/7-to-8/major-changes/ui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@ There are two UI options available to monitor and control workflows at Cylc 8.
Cylc TUI
--------

Cylc TUI is a text based UI, available on the command line with
``cylc tui <workflow_id>``.
Cylc TUI is a text based UI, available on the command line with ``cylc tui``.

It remains in development, with smooth running with large workflows soon to be
resolved.
You can use it to browse, view and control your workflows.

.. figure:: ../../img/cylc-tui.png
:figwidth: 80%
Expand Down
2 changes: 1 addition & 1 deletion src/7-to-8/summary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ At Cylc 8, there are two UIs available to monitor and control your workflows:

.. code-block:: bash
cylc tui <workflow_id>
cylc tui
- a web based UI application (requires `Cylc UI Server`_)

Expand Down
14 changes: 14 additions & 0 deletions src/reference/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,20 @@ Cylc 8.3.0
:cylc-rose: `1.4 <https://github.com/cylc/cylc-rose/blob/1.4.x/CHANGES.md>`__


Tui
^^^

The Tui (terminal user interface) is a command line version of the Gui.
You can use it to monitor and control your workflows.

There has been a major updade to Tui at Cylc 8.3.0, you can now use Tui to
browse your installed workflows. Tui is now able to keep up with larger
workflows which would previously have caused it to time out.

.. image:: changes/tui-1.gif
:width: 100%


Upgrade To The Latest Jupyter Releases
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
Binary file added src/reference/changes/tui-1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4cc168d

Please sign in to comment.