diff options
Diffstat (limited to 'doc/documentation.tex')
| -rw-r--r-- | doc/documentation.tex | 34 |
1 files changed, 24 insertions, 10 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index 33668ca..4efbd95 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -49,18 +49,10 @@ The program must be set up for checkpointing. (It can be argued that checkpointing functionality is common sense and good etiquette for long-running programs in a multi-user environment.) -For termination from a file, the PBS batch system is used. - \section{Setup} \begin{Verbatim}[commandchars=\\\{\},frame=single] -cmd="mpirun \textsl{command...}" -/opt/NumRelScript/chain\_job "$0" "$cmd" -\end{Verbatim} - - -\begin{Verbatim}[commandchars=\\\{\},frame=single] # # # # # # # # # # # # # # # Checkpointing / Recovery ActiveThorns = "IOHDF5Util IOHDF5" @@ -75,8 +67,11 @@ IOHDF5::checkpoint = "yes" # # # # # # # # # # # # # # # Termination ActiveThorns = "ManualTermination" + # termination by wall time ManualTermination::on_remaining_walltime=1400 #minutes before termination ManualTermination::max_walltime=12 # hours + + # termination from a file ManualTermination::termination_from_file=yes ManualTermination::check_file_every=10 #evolution steps ManualTermination::output_remtime_every_minutes=2 # how often to remind user @@ -85,11 +80,30 @@ ManualTermination::output_remtime_every_minutes=2 # how often to remind user \section{Use} +The two modes, termination by wall time and termination from file, are +meant to be independent and can be used together or separately. + +The default file checked is +\texttt{/tmp//cactus\_terminate.\textit{job\_id}}, +where by default, \texttt{\textit{job\_id}} is gotten from the \texttt{PBS\_JOBID} +environment variable. If the environment variable +\texttt{MANUAL\_TERMINATION\_JOB\_ID} is set, that will be used instead +as the \texttt{\textit{job\_id}}. + +In this configuration, any user may terminate the run by putting a '1' into +the specified file. + +The the termination file is removed when the run shuts down. + +It should be possible to use thorn \textbf{ManualTermination} with thorn +\textbf{JobChaining}. If a job is terminated by \textbf{ManualTermination}, +\textbf{JobChaining} will not attempt to re-queue the simulation. + \section{Licensing and Support} -Thorn \textbf{JobChaining} is distributed under the GNU Lesser Public +Thorn \textbf{ManualTermination} is distributed under the GNU Lesser Public License. -For details please see the file \texttt{COPYING.LIB} in the top-level +For details please see the file \texttt{README} in the top-level directory of this thorn. Please send any suggestions or comments to the maintainer of the thorn. |