Skip to content

Commit

Permalink
#3074: Recorrect order.
Browse files Browse the repository at this point in the history
  • Loading branch information
mo-gill committed May 29, 2024
1 parent 1f0f27e commit b0ea76e
Showing 1 changed file with 32 additions and 51 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,40 @@ Adding a recipe to the Recipe Test Workflow (|RTW|)

cylc stop "a_running_recipe_test_workflow"

#. Run your recipe with ESMValTool on your compute server for your site. You should
be able to find this in your site specific ``.cylc`` file in the site directory.
#. Locate your local <site>.cylc file, found in (recipe_test_workflow/site).

cylc vip -O <your_site_name>
#. Open it in your preferred code editor.

#. If the ``process`` task in the workflow has failed, then follow the next steps::
#. Locate the `COMPUTE` section, it should look something like this::

[[COMPUTE]]
platform = <your_platform_here>
execution time limit = PT2M
[[[directives]]]
--wckey = RTW
--ntasks = {{ MAX_PARALLEL_TASKS }}
--mem = 2G

#. Run your recipe with ESMValTool on your compute server for your site.

#. If the recipe takes less than 10 minutes to run then it should be added as a
"fast" recipe in the ``flow.cylc`` file within the ``[task parameters]`` section.
If it takes longer than ten minutes it should be included in "medium".

#. If either of the memory readings from your run are larger than the
values specified in the `COMPUTE` section, you need to add your recipe as
another `process` similar to::

[[process<fast=recipe_albedolandcover>]]
# Actual: 0m31s, 2.5 GB on 2024-04-08.
execution time limit = PT2M
[[[directives]]]
--mem = 3G

#. Run the recipe test workflow.

#. The ``compare`` task will fail. These next steps should fix it,
and even if the ``compare`` task has passed, they must still be completed.

#. Locate the workflow run folder of the workflow you just completed.

Expand Down Expand Up @@ -42,54 +70,7 @@ Adding a recipe to the Recipe Test Workflow (|RTW|)
cylc vip -O <your_site_name>


#. The ``process`` task should now pass. If the ``compare`` task fails, these next steps should fix it,
and even if the ``compare`` task has passed, they must still be completed.

#. Take note of how long the ``process`` step took to complete on cylc review.
This can be found in the ``job.time`` section of the task listed as ``process_<your_recipe>``.

#. Locate your local <site>.cylc file, found in (recipe_test_workflow/site).

#. Open it in your preferred code editor.

#. Locate the `COMPUTE` section, it should look something like this::

[[COMPUTE]]
platform = <your_platform_here>
execution time limit = PT2M
[[[directives]]]
--wckey = RTW
--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.


#. 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<fast=recipe_albedolandcover>]]
# Actual: 0m31s, 2.5 GB on 2024-04-08.
execution time limit = PT2M
[[[directives]]]
--mem = 3G

#. If the recipe takes less than 10 minutes to run then it should be added as a fast recipe.
If it takes longer than ten minutes it should be included in `medium`.

#. 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.

#. Stop any running workflows.

#. 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.
Expand Down

0 comments on commit b0ea76e

Please sign in to comment.