diff options
Diffstat (limited to 'doc/documentation.tex')
-rw-r--r-- | doc/documentation.tex | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex new file mode 100644 index 0000000..33668ca --- /dev/null +++ b/doc/documentation.tex @@ -0,0 +1,100 @@ +% $Header$ + +\documentclass{article} + +% Use the Cactus ThornGuide style file +% (Automatically used from Cactus distribution, if you have a +% thorn without the Cactus Flesh download this from the Cactus +% homepage at www.cactuscode.org) +\usepackage{../../../../doc/latex/cactus} +\RequirePackage{alltt} +\RequirePackage{fancyvrb} + +\begin{document} + +% The author of the documentation +\author{Steve White \textless swhite@aei.mpg.de\textgreater} + +% The title of the document (not necessarily the name of the Thorn) +\title{ManualTermination\\ + Manual Termination of Cactus Simulations} + +% the date your document was last changed, if your document is in CVS, +% please use: +\date{$ $Date$ $} + +\maketitle + +% Do not delete next line +% START CACTUS THORNGUIDE + +\begin{abstract} +Thorn \textbf{ManualTermination} safely terminates Cactus +simulation jobs, and can be configured to allow other users to +terminate the job. + +The thorn can also be configured to terminate a certain number of minutes +before a given maximum walltime has elapsed. Also, it can be configured +to periodically check the contents of a given file, and terminate based +on the contents of that file. + +In either case, the job should be checkpointed. +\end{abstract} + + + +\section{Requirements} + +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" + +IO::checkpoint_dir = "cpr/" +IO::checkpoint_file = "chain" # Name to taste +IO::checkpoint_on_terminate = "yes" +IO::recover_dir = "cpr/" +IO::recover_file = "chain" # Same name +IO::recover = "autoprobe" +IOHDF5::checkpoint = "yes" + +# # # # # # # # # # # # # # # Termination +ActiveThorns = "ManualTermination" + +ManualTermination::on_remaining_walltime=1400 #minutes before termination +ManualTermination::max_walltime=12 # hours +ManualTermination::termination_from_file=yes +ManualTermination::check_file_every=10 #evolution steps +ManualTermination::output_remtime_every_minutes=2 # how often to remind user + +\end{Verbatim} + +\section{Use} + +\section{Licensing and Support} + +Thorn \textbf{JobChaining} is distributed under the GNU Lesser Public +License. +For details please see the file \texttt{COPYING.LIB} in the top-level +directory of this thorn. + +Please send any suggestions or comments to the maintainer of the thorn. + +% Do not delete next line +% END CACTUS THORNGUIDE + +\end{document} |