From 936368c6501b719e3e13028f6a59acd3ae2a3858 Mon Sep 17 00:00:00 2001 From: Ed Gillett <146008263+mo-gill@users.noreply.github.com> Date: Tue, 28 May 2024 16:02:22 +0100 Subject: [PATCH] #3074: Change unordered to ordered list. --- .../doc/source/user_guide/adding_a_recipe.rst | 91 +++++++++---------- 1 file changed, 43 insertions(+), 48 deletions(-) diff --git a/esmvaltool/utils/recipe_test_workflow/doc/source/user_guide/adding_a_recipe.rst b/esmvaltool/utils/recipe_test_workflow/doc/source/user_guide/adding_a_recipe.rst index 0bc97f0a21..9bd09f3389 100644 --- a/esmvaltool/utils/recipe_test_workflow/doc/source/user_guide/adding_a_recipe.rst +++ b/esmvaltool/utils/recipe_test_workflow/doc/source/user_guide/adding_a_recipe.rst @@ -8,61 +8,56 @@ able to successfully run it on your compute server for your site. You should be able to find this in your site specific ``.cylc`` file in the site directory . -* Run ESMValTool locally with your recipe, make sure to take note of the memory - and time expenditure provided by the terminal output:: +#. Run ESMValTool locally with your recipe, make sure to take note of the memory + and time expenditure provided by the terminal output:: esmvaltool run -* Run the same recipe on JASMIN, again taking note of the memory and time - expenditure printed to the terminal. +#. Run the same recipe on JASMIN, again taking note of the memory and time + expenditure printed to the terminal. -* Stop any running recipe_test_workflow workflows:: +#. Stop any running recipe_test_workflow workflows:: cylc stop "a_running_recipe_test_workflow" -* Add the recipe to the ``[task parameters]`` section of the |RTW| in the ``flow.cylc`` - workflow file, make sure your recipe name fits the formatting of ``recipe_new_ - recipe, \\`` (unless it is the lowest item added in the list, in which case - it should fit the format of ``recipe_new_recipe`` followed by no characters). - -* Run the workflow. The process task for the new recipe should succeed, but its - compare task should fail with an error that the reference data (KGO) does - not exist:: +#. Run the workflow. The process task for the new recipe should succeed, but its + compare task should fail with an error that the reference data (KGO) does + not exist:: cylc vip -O -* Locate the workflow run folder of the workflow you just completed. +#. Locate the workflow run folder of the workflow you just completed. -* Copy the output files from the "cycle" folder (run/share/cycle) of the - workflow you just ran, to your site specific KGO rootpath folder - (this folder should be set as the value for the variable "KGO_ROOT_PATH=" - in your ``rose-suite.conf`` file found in the ``/data/users/esmval - /KGO`` directory):: +#. Copy the output files from the "cycle" folder (run/share/cycle) of the + workflow you just ran, to your site specific KGO rootpath folder + (this folder should be set as the value for the variable "KGO_ROOT_PATH=" + in your ``rose-suite.conf`` file found in the ``/data/users/esmval + /KGO`` directory):: cp -r -* Change directory to the rootpath KGO directory:: +#. Change directory to the rootpath KGO directory:: cd -* Allow write permissions for all users on the directory and it's - subdirectories of the recipe you've added to the KGO folder:: +#. Allow write permissions for all users on the directory and it's + subdirectories of the recipe you've added to the KGO folder:: chmod a+w -* Run the RTW again:: +#. Run the RTW again:: cylc vip -O -* The workflow should now succeed. +#. The workflow should now succeed. -* Take note of how long the run took to complete on cylc. This can be found in the `job.time` section of the task listed as `process_`. +#. Take note of how long the run took to complete on cylc. This can be found in the `job.time` section of the task listed as `process_`. -* Locate your local .cylc file, found in (recipe_test_workflow/site). +#. Locate your local .cylc file, found in (recipe_test_workflow/site). -* Open it in your preferred code editor. +#. Open it in your preferred code editor. -* Locate the `COMPUTE` section, it should look something like this:: +#. Locate the `COMPUTE` section, it should look something like this:: [[COMPUTE]] platform = @@ -72,15 +67,15 @@ be able to find this in your site specific ``.cylc`` file in the site directory --ntasks = {{ MAX_PARALLEL_TASKS }} --mem = 2G -* Compare the `execution time limit` and --mem (memory) units here with the - readings you took locally. If your local readings do not exceed these, then - you have successfully added the recipe to the workflow, and can now commit - and push your changes. +#. Compare the `execution time limit` and --mem (memory) units here with the + readings you took locally. If your local readings do not exceed these, then + you have successfully added the recipe to the workflow, and can now commit + and push your changes. -* If either of the time/memory readings from your local run are larger than the - values specified in the `COMPUTE` section, you need to add your recipe as - another `process` similar to:: +#. If either of the time/memory readings from your local run are larger than the + values specified in the `COMPUTE` section, you need to add your recipe as + another `process` similar to:: [[process]] # Actual: 0m31s, 2.5 GB on 2024-04-08. @@ -88,22 +83,22 @@ be able to find this in your site specific ``.cylc`` file in the site directory [[[directives]]] --mem = 3G -* Variable (fast, medium) must be consistent with flow.cylc. +#. Variable (fast, medium) must be consistent with flow.cylc. -* The commented "Actual" reading should be the time/memory - reading you recorded from cylc review. +#. The commented "Actual" reading should be the time/memory + reading you recorded from cylc review. -* Adjust the values for `execution_time` and `--mem` to be larger than the - values you recorded from cylc review. +#. Adjust the values for `execution_time` and `--mem` to be larger than the + values you recorded from cylc review. -* Stop any running workflows. +#. Stop any running workflows. -* Run the recipe test workflow again. +#. Run the recipe test workflow again. -* If the workflow succeeds then your recipe has successfully been added to the - workflow. You can now commit your changes and push them onto GitHub. +#. If the workflow succeeds then your recipe has successfully been added to the + workflow. You can now commit your changes and push them onto GitHub. -* Add your recipe to the list of "Currently tested recipes" in ``tested_recipes. - rst`` (this file is located within ``recipe_test_workflow/doc/source``) in it's - correct position (the list is ordered alphabetically), this will add it to - the documentation. +#. Add your recipe to the list of "Currently tested recipes" in ``tested_recipes. + rst`` (this file is located within ``recipe_test_workflow/doc/source``) in it's + correct position (the list is ordered alphabetically), this will add it to + the documentation.