diff --git a/doc/sphinx/source/utils/RTW/source/about.rst b/doc/sphinx/source/utils/RTW/source/about.rst deleted file mode 100644 index 4f95a6fa57..0000000000 --- a/doc/sphinx/source/utils/RTW/source/about.rst +++ /dev/null @@ -1,12 +0,0 @@ -***** -About -***** - -.. include:: common.txt - -The Recipe Test Workflow (|RTW|) is a workflow that is used to regularly run -recipes so issues can be discovered during the development process sooner -rather than later. - -|Cylc| v8 and |Rose| v2 are used as the workflow engine and application -configuration system for the |RTW|, respectively. diff --git a/doc/sphinx/source/utils/RTW/source/add_a_recipe.rst b/doc/sphinx/source/utils/RTW/source/add_a_recipe.rst deleted file mode 100644 index affbb87c2c..0000000000 --- a/doc/sphinx/source/utils/RTW/source/add_a_recipe.rst +++ /dev/null @@ -1,122 +0,0 @@ -How to add a recipe to the |RTW| -================================ - -.. include:: common.txt - -.. note:: - Before you follow these steps to add your recipe, you must be able to - successfully run the recipe with the latest version of ESMValTool on the - compute server you use at your site, as detailed by the ``platform`` option - in the ``[[COMPUTE]]`` section in the site-specific ``.cylc`` file in the - ``esmvaltool/utils/recipe_test_workflow/recipe_test_workflow/site/`` - directory. - -#. Open a `new ESMValTool issue`_ on GitHub, assign yourself to the issue, and - add the ``Recipe Test Workflow (RTW)`` label to the issue, see - `ESMValTool issue #3663`_ for an example. - -#. Create a branch. - -#. Obtain the duration and memory usage of the recipe from the messages printed - to screen, or at the end of the ``run/main_log.txt`` file in the recipe - output directory after running your recipe on the compute cluster you use at - your site; these messages will look something like:: - - YYYY-MM-DD HH:MM:SS:sss UTC [12345] INFO Time for running the recipe was: 0:02:13.334742 - YYYY-MM-DD HH:MM:SS:sss UTC [12345] INFO Maximum memory used (estimate): 2.4 GB - [...] - YYYY-MM-DD HH:MM:SS:sss UTC [12345] INFO Run was successful - -#. Add the recipe to the ``[task parameters]`` section in the - ``esmvaltool/utils/recipe_test_workflow/recipe_test_workflow/flow.cylc`` - file. - - .. hint:: - If the recipe takes less than 10 minutes to run then it should be added - to the ``fast`` option. Recipes that take longer than ten minutes should - be added to the ``medium`` option. - - .. hint:: - The line added should follow the format of ``recipe_new_recipe, \``, - unless the line is the last one in the list, in which case the line added - should follow the format of ``recipe_new_recipe``. - -#. If the duration of the recipe is larger than the value specified by the - ``execution time limit`` option in the ``[[COMPUTE]]`` section in the - aforementioned site-specific ``.cylc`` file, and / or the memory usage of - the recipe is larger than the value specified by the ``--mem`` option in the - ``[[[directives]]]`` section in the ``[[COMPUTE]]`` section, add a section - (in alphabetical order) to this file as shown below (round the duration to - the nearest second):: - - [[process]] - # Actual: 0m31s, 2.5 GB on 2024-04-08. - execution time limit = PT2M - [[[directives]]] - --mem = 3G - - .. hint:: - The ``fast`` key in the example task definition above - (``[[process]]``) should match name of the - option the recipe was added to in the ``[task parameters]`` section in - the - ``esmvaltool/utils/recipe_test_workflow/recipe_test_workflow/flow.cylc`` - file - - .. hint:: - Set the ``execution time limit`` to 10-20% more than the actual duration. - For actual durations of up to ``1m45s``, set the ``execution time limit`` - to ``PT2M`` (2 minutes). - - .. hint:: - Try not to regularly waste more than 500 MiB in memory usage. Typically, - rounding the actual memory usage up to the nearest integer is acceptable. - -#. Stop any running ``recipe_test_workflow`` workflows:: - - cylc stop recipe_test_workflow/* - -#. Run the |RTW|, as detailed in the - :doc:`Quick Start Guide `; it is expected that the - ``compare`` task will fail. - -#. Update the Known Good Outputs (|KGOs|): - - * Recursively copy the recipe output directory (i.e. - ``recipe___