Skip to content

Commit

Permalink
Fix execution time limit related docs
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewrmshin committed Jul 25, 2016
1 parent 99d05ef commit 5b6e963
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 21 deletions.
39 changes: 23 additions & 16 deletions doc/cug.tex
Original file line number Diff line number Diff line change
Expand Up @@ -5065,7 +5065,9 @@ \subsubsection{loadleveler}
\lstinline=wall_clock_limit= directive. The setting is assumed to be the soft
limit. The hard limit will be set by adding an extra minute to the soft limit.
Do not specify the \lstinline=wall_clock_limit= directive explicitly if
\lstinline=execution time limit= is specified, or it will cause confusion.
\lstinline=execution time limit= is specified. Otherwise, the execution time
limit known by the suite may be out of sync with what is submitted to the batch
system.

\subsubsection{lsf}

Expand Down Expand Up @@ -5093,8 +5095,9 @@ \subsubsection{lsf}

If \lstinline=execution time limit= is specified, it is used to generate the
\lstinline=-W= directive. Do not specify the \lstinline=-W= directive
explicitly if \lstinline=execution time limit= is specified, or it will cause
confusion.
explicitly if \lstinline=execution time limit= is specified. Otherwise, the
execution time limit known by the suite may be out of sync with what is
submitted to the batch system.

\subsubsection{pbs}

Expand Down Expand Up @@ -5125,8 +5128,9 @@ \subsubsection{pbs}

If \lstinline=execution time limit= is specified, it is used to generate the
\lstinline=-l walltime= directive. Do not specify the \lstinline=-l walltime=
directive explicitly if \lstinline=execution time limit= is specified, or it
will cause confusion.
directive explicitly if \lstinline=execution time limit= is specified.
Otherwise, the execution time limit known by the suite may be out of sync with
what is submitted to the batch system.

\subsubsection{moab}

Expand Down Expand Up @@ -5159,8 +5163,9 @@ \subsubsection{moab}

If \lstinline=execution time limit= is specified, it is used to generate the
\lstinline=-l walltime= directive. Do not specify the \lstinline=-l walltime=
directive explicitly if \lstinline=execution time limit= is specified, or it
will cause confusion.
directive explicitly if \lstinline=execution time limit= is specified.
Otherwise, the execution time limit known by the suite may be out of sync with
what is submitted to the batch system.

\subsubsection{sge}

Expand Down Expand Up @@ -5192,8 +5197,9 @@ \subsubsection{sge}

If \lstinline=execution time limit= is specified, it is used to generate the
\lstinline=-l h_rt= directive. Do not specify the \lstinline=-l h_rt=
directive explicitly if \lstinline=execution time limit= is specified, or it
will cause confusion.
directive explicitly if \lstinline=execution time limit= is specified.
Otherwise, the execution time limit known by the suite may be out of sync with
what is submitted to the batch system.

\subsubsection{slurm}

Expand Down Expand Up @@ -5223,14 +5229,15 @@ \subsubsection{slurm}

If \lstinline=execution time limit= is specified, it is used to generate the
\lstinline=--time= directive. Do not specify the \lstinline=--time=
directive explicitly if \lstinline=execution time limit= is specified, or it
will cause confusion.
directive explicitly if \lstinline=execution time limit= is specified.
Otherwise, the execution time limit known by the suite may be out of sync with
what is submitted to the batch system.

\subsubsection{Default Directives Provided}

For job submission methods that use job file directives (PBS, Loadlevler, etc.)
default directives are provided to set the job name, stdout and stderr file
paths, and the execution time limit (if specified).
For job submission methods that use job file directives (PBS, Loadleveler,
etc.) default directives are provided to set the job name, stdout and stderr
file paths, and the execution time limit (if specified).

Cylc constructs the job name string using a combination of the task ID and the
suite name. PBS fails a job submit if the job name in \lstinline=-N name= is
Expand Down Expand Up @@ -5402,8 +5409,8 @@ \subsection{Execution Time Limit}
The \lstinline=execution time limit= setting will also inform the suite when a
a task job should complete by. If a task job has not reported completing within
the specified time, the suite will poll the task job. (The default
setting is PT1M, PT2M, PT7M. The accumulated times (in minutes) for these
intervals will be roughly 1, 1 + 2 = 3 and 1 + 2 + 7 = 10 after a task job
setting is PT1M, PT2M, PT7M. The accumulated times for these intervals will be
roughly 1 minute, 1 + 2 = 3 minutes and 1 + 2 + 7 = 10 minutes after a task job
exceeds its execution time limit.)

\subsubsection{Execution Time Limit and Execution Timeout}
Expand Down
10 changes: 5 additions & 5 deletions doc/suiterc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1252,7 +1252,7 @@ \subsection{[runtime]}
A list of ISO 8601 time duration/intervals after which to resubmit the task
if it fails. The variable \lstinline=$CYLC_TASK_TRY_NUMBER= in the task
execution environment is incremented each time, starting from 1 for the
first try - this can be used to vary task behavior by try number.
first try - this can be used to vary task behaviour by try number.

\begin{myitemize}
\item {\em type:} Comma-separated list of ISO 8601 duration/interval representations,
Expand All @@ -1270,9 +1270,9 @@ \subsection{[runtime]}
multipliers, after which cylc will poll for status while the task is in the
submitted state.

For the polling task communications method this overrides the default
For the polling task communication method this overrides the default
submission polling interval in the site/user config files
(\ref{SiteAndUserConfiguration}). For pyro and ssh task communications
(\ref{SiteAndUserConfiguration}). For pyro and ssh task communications,
polling is not done by default but it can still be configured here as a
regular check on the health of submitted tasks.

Expand All @@ -1296,9 +1296,9 @@ \subsection{[runtime]}
multipliers, after which cylc will poll for status while the task is in the
running state.

For the polling task communications method this overrides the default
For the polling task communication method this overrides the default
execution polling interval in the site/user config files
(\ref{SiteAndUserConfiguration}). For pyro and ssh task communications
(\ref{SiteAndUserConfiguration}). For pyro and ssh task communications,
polling is not done by default but it can still be configured here as a
regular check on the health of submitted tasks.

Expand Down

0 comments on commit 5b6e963

Please sign in to comment.