From 235b6b32deadfb497a4c1bf58fca86bf5fb0c3bc Mon Sep 17 00:00:00 2001 From: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com> Date: Thu, 4 Apr 2024 11:31:16 +0100 Subject: [PATCH 1/3] Improvements to runtime configuration tutorial --- .../runtime/runtime-configuration.rst | 54 ++++++++++++------- 1 file changed, 34 insertions(+), 20 deletions(-) diff --git a/src/tutorial/runtime/runtime-configuration.rst b/src/tutorial/runtime/runtime-configuration.rst index 3fdc5b300c..7aeac8d75b 100644 --- a/src/tutorial/runtime/runtime-configuration.rst +++ b/src/tutorial/runtime/runtime-configuration.rst @@ -378,14 +378,22 @@ Start, Stop, Restart cylc install Open a user interface (:ref:`tutorial.tui` or :ref:`tutorial.gui`) to view - your workflow. + your workflow. Run the workflow either from the UI or command line. - Run the workflow either by pressing the play button in the Cylc UI or by - running the command: + .. spoiler:: Hint hint - .. code-block:: bash + .. code-block:: bash + + cylc tui runtime-tutorial + # or + cylc gui # If you haven't already got an instance running. - cylc play runtime-tutorial + Run the workflow either by: + + * GUI: selecting the runtime-tutorial workflow in the sidebar and + pressing the play button. + * Tui: pressing enter on the workflow and selecting "play". + * Command line: running ``cylc play runtime-tutorial``. If all goes well the workflow will startup and the tasks will run and succeed. Note that the tasks which do not have a ``[runtime]`` section @@ -430,34 +438,40 @@ Start, Stop, Restart :term:`run directory`. Copy the code in the ``runtime`` file to the bottom of the :cylc:conf:`flow.cylc` file. + Now that all the tasks have runtime sections, remove + :cylc:conf:`[scheduler]allow implicit tasks`: + + .. code-block:: diff + + [scheduler] + UTC mode = True + - allow implicit tasks = True # TODO: remove at end of exercise + + Removing this ensures that any tasks in the graph without a corresponding + runtime section will cause validation to fail (e.g. due to a typo). + Check the :cylc:conf:`flow.cylc` file is valid by running the command: .. code-block:: bash cylc validate . - cylc install - .. TODO: Add advice on what to do if the command fails. + Now install a new run of the workflow: - #. **Run The Workflow.** + .. code-block:: bash - Open a user interface (:ref:`tutorial.tui` or :ref:`tutorial.gui`) to view - your workflow. + cylc install - .. spoiler:: Hint hint + .. TODO: Add advice on what to do if the command fails. - .. code-block:: bash + #. **Run The Workflow.** - cylc tui runtime-tutorial - # or - cylc gui # If you haven't already got an instance running. + Open a user interface (:ref:`tutorial.tui` or :ref:`tutorial.gui`) and + run the workflow. - Run the workflow either by: + .. tip:: - * Pressing the play button in the Cylc GUI. Then, ensuring that - "Cold Start" is selected within the dialogue window, pressing the - "Start" button. - * Running the command ``cylc play runtime-tutorial``. + Make sure you play the latest run that was newly installed. #. **View The Forecast Summary.** From ebc6133dd40550b5b046496e9752f08543adc0b6 Mon Sep 17 00:00:00 2001 From: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com> Date: Thu, 4 Apr 2024 11:32:15 +0100 Subject: [PATCH 2/3] Update outdated info about log files --- src/user-guide/running-workflows/scheduler-log-files.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/user-guide/running-workflows/scheduler-log-files.rst b/src/user-guide/running-workflows/scheduler-log-files.rst index a04d87ef55..62ebc190b1 100644 --- a/src/user-guide/running-workflows/scheduler-log-files.rst +++ b/src/user-guide/running-workflows/scheduler-log-files.rst @@ -11,7 +11,7 @@ The information logged here includes: - Event timestamps, at the start of each line - Workflow server host, port and process ID - Workflow initial and final cycle points -- Workflow start type (i.e. cold start, warn start, restart) +- Workflow (re)start number (1 for the first play, 2 or more for restarts) - Task events (task started, succeeded, failed, etc.) - Workflow stalled warnings. - Client commands (e.g. ``cylc hold``) From b12adac423f96d55b09f130cefabe241f0537202 Mon Sep 17 00:00:00 2001 From: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com> Date: Thu, 4 Apr 2024 12:07:19 +0100 Subject: [PATCH 3/3] Placate spellcheck --- src/dictionaries/words | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/dictionaries/words b/src/dictionaries/words index 13f17b63e5..40289e8a77 100644 --- a/src/dictionaries/words +++ b/src/dictionaries/words @@ -93,6 +93,7 @@ packjob parameterization parameterize parameterized +parentless passX passphrase passwordless @@ -167,6 +168,7 @@ subcommands subdir subdirectories subdirectory +subprocess subprocesses subshell subshelled