From 4624a0ac22b9e9dcca07843ded4e711d22f23183 Mon Sep 17 00:00:00 2001 From: Tim Pillinger <26465611+wxtim@users.noreply.github.com> Date: Thu, 20 Jun 2024 13:23:52 +0100 Subject: [PATCH 1/3] don't display bad practice --- src/user-guide/task-implementation/job-submission.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/user-guide/task-implementation/job-submission.rst b/src/user-guide/task-implementation/job-submission.rst index ba0ec69324..6be9e25c29 100644 --- a/src/user-guide/task-implementation/job-submission.rst +++ b/src/user-guide/task-implementation/job-submission.rst @@ -70,7 +70,7 @@ line: .. code-block:: none - -l=select=28:ncpus=36:mpiprocs=18:ompthreads=2:walltime=12:00:00 + -l=select=28:ncpus=36:mpiprocs=18:ompthreads=2 (Left hand side is ``-l``. A second ``-l=...`` line will override the first.) @@ -82,7 +82,6 @@ Or separate the items: -l ncpus=36 -l mpiprocs=18 -l ompthreads=2 - -l walltime=12:00:00 .. note:: From 549da791feade9261ded89a93c6b9365d5b4b73b Mon Sep 17 00:00:00 2001 From: WXTIM <26465611+wxtim@users.noreply.github.com> Date: Fri, 21 Jun 2024 09:55:15 +0100 Subject: [PATCH 2/3] add warning about using directives equivelent to ETL --- src/user-guide/task-implementation/job-submission.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/user-guide/task-implementation/job-submission.rst b/src/user-guide/task-implementation/job-submission.rst index 6be9e25c29..170a743c03 100644 --- a/src/user-guide/task-implementation/job-submission.rst +++ b/src/user-guide/task-implementation/job-submission.rst @@ -59,6 +59,15 @@ characters using Directives Section Quirks (PBS, SGE, ...) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. warning:: + + Use :cylc:conf:`[runtime][]execution time limit` rather + than directives. + + This makes Cylc aware of execution time limits so that execution + time out can be identified even if the :term:`job runner` cannot be + contacted. + To specify an option with no argument, such as ``-V`` in PBS or ``-cwd`` in SGE you must give a null string as the directive value in the :cylc:conf:`flow.cylc` file. From 9ffb2b6c786b68f9a45ee301f8e6d6fad1536328 Mon Sep 17 00:00:00 2001 From: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com> Date: Fri, 21 Jun 2024 12:26:46 +0100 Subject: [PATCH 3/3] Rearrange execution time limit admonition --- .../task-implementation/job-submission.rst | 21 +++++++++++-------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/src/user-guide/task-implementation/job-submission.rst b/src/user-guide/task-implementation/job-submission.rst index 170a743c03..07a3bbe2e7 100644 --- a/src/user-guide/task-implementation/job-submission.rst +++ b/src/user-guide/task-implementation/job-submission.rst @@ -47,6 +47,16 @@ For :term:`job runners ` that use job file directives (PBS, Loadleve etc.) default directives are provided to set the job name, stdout and stderr file paths, and the execution time limit (if specified). +.. tip:: + + Use :cylc:conf:`[runtime][]execution time limit` to set + time limits, rather than setting this as a directive yourself. + + This allows Cylc to identify execution timeout even if the + job runner cannot be contacted. + + See :ref:`ExecutionTimeLimit` + Cylc constructs the job name string using a combination of the task ID and the workflow name. PBS fails a job submit if the job name in ``-N name`` is too long. For version 12 or below, this is 15 characters. For version 13, this @@ -59,15 +69,6 @@ characters using Directives Section Quirks (PBS, SGE, ...) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. warning:: - - Use :cylc:conf:`[runtime][]execution time limit` rather - than directives. - - This makes Cylc aware of execution time limits so that execution - time out can be identified even if the :term:`job runner` cannot be - contacted. - To specify an option with no argument, such as ``-V`` in PBS or ``-cwd`` in SGE you must give a null string as the directive value in the :cylc:conf:`flow.cylc` file. @@ -255,6 +256,8 @@ according to its job runner. Tasks can be killed on demand by using the ``cylc kill`` command. +.. _ExecutionTimeLimit: + Execution Time Limit --------------------