diff --git a/doc/scheduler-scripting.tex b/doc/scheduler-scripting.tex index 99f9f33..cab1f4d 100644 --- a/doc/scheduler-scripting.tex +++ b/doc/scheduler-scripting.tex @@ -260,6 +260,37 @@ \subsection{Common Job Management Commands Summary} default format in the \api{SACCT\_FORMAT} environment variable in your \texttt{.cshrc} or \texttt{.bashrc} files. +\item +\texttt{seff [job-ID]}: reports on the efficiency of a job's cpu and memory utilization. +Don't execute it on RUNNING jobs (only on completed/finished jobs), efficiency statistics may be misleading. + +If you define the following directives in your batch script, you will receive seff output in your email when your job is finished. +\small +\begin{verbatim} +#SBATCH --mail-type=ALL +#SBATCH --mail-user=USER_NAME@encs.concordia.ca +## Replace USER_NAME with your encs username. +\end{verbatim} +\normalsize + +Output example: +\small +\begin{verbatim} +Job ID: XXXXX +Cluster: speed +User/Group: user1/user1 +State: COMPLETED (exit code 0) +Nodes: 1 +Cores per node: 4 +CPU Utilized: 00:04:29 +CPU Efficiency: 0.35% of 21:32:20 core-walltime +Job Wall-clock time: 05:23:05 +Memory Utilized: 2.90 GB +Memory Efficiency: 2.90% of 100.00 GB +\end{verbatim} +\normalsize + + \end{itemize} diff --git a/doc/speed-manual.pdf b/doc/speed-manual.pdf index 968017e..3b9010b 100644 Binary files a/doc/speed-manual.pdf and b/doc/speed-manual.pdf differ