diff options
| -rw-r--r-- | Carpet/CarpetIOASCII/doc/documentation.tex | 24 | ||||
| -rw-r--r-- | Carpet/CarpetIOScalar/doc/documentation.tex | 49 |
2 files changed, 48 insertions, 25 deletions
diff --git a/Carpet/CarpetIOASCII/doc/documentation.tex b/Carpet/CarpetIOASCII/doc/documentation.tex index cc16fa456..68b90f270 100644 --- a/Carpet/CarpetIOASCII/doc/documentation.tex +++ b/Carpet/CarpetIOASCII/doc/documentation.tex @@ -138,16 +138,36 @@ are some utilities in the src/util directory. These are \item {\bf Carpet2ygraph.pl} A perl script to convert to a format suitable for the {\it xgraph} or {\it ygraph} packages of P. Walker and D. Pollney. +\item {\bf Carpet2ygraph.pl} An improved version of the previous script. +\item {\bf mergeCarpetIOASCII.pl} A perl script to remove duplicate datasets from file(s). \end{itemize} + The first two, written by Scott Hawley, are C codes that require the Makefile (building using the -utils flag from the main Cactus directory currently does not work). Each output one refinement level, either to standard output or to a file. -The last script writes all refinement levels from a given file in a +The third script writes all refinement levels from a given file in a given direction to a number of different files given a prefix filename, where the number in the output filename is given by the -refinement level. +refinement level. Usage: {\tt Carpet2ygraph.pl direction Inputfile Outputfile}, +where direction is 0, 1, 2, for x,y and z. + +The fourth script is an improved version of the previous one. It reads a 1D .asc file and produces a +single file containing all the data from all levels, writing points that are in more levels only +once. The output filename is the original filename with the suffix .asc changed into .xg. The +direction (x,y or z) of the input file is automatically detected from the filename. It recognizes +and converts also scalar data, like norms and extrema. Usage: {\tt Carpet2ygraphCat.pl Inputfile}. + +The fifth script can be used to merge CarpetIOASCII output written before and after recovery. It +reads one or more files in CarpetIOASCII format and writes their contents to STDOUT, eliminating +duplicate datasets (all but the last occurance are discarded), which may be created when a run died +abruptly without checkpointing at the last output itaration and is recovered from a previous +checkpoint. +Usage: {\tt mergeCarpetIOASCII.pl list of files}. \\ +Example 1: {\tt mergeCarpetIOASCII.pl alp.x.asc > alp.x.asc.merged}.\\ +Example 2: {\tt mergeCarpetIOASCII.pl alp.x.asc.firstCHKPT alp.x.asc.secondCHKPT > alp.x.asc.merged}.\\ +This script was written by Thomas Radke. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% diff --git a/Carpet/CarpetIOScalar/doc/documentation.tex b/Carpet/CarpetIOScalar/doc/documentation.tex index 4800aec75..732b588ab 100644 --- a/Carpet/CarpetIOScalar/doc/documentation.tex +++ b/Carpet/CarpetIOScalar/doc/documentation.tex @@ -102,31 +102,34 @@ \section{Introduction} -\section{Physical System} -\section{Numerical Implementation} -\section{Using This Thorn} - -\subsection{Obtaining This Thorn} - -\subsection{Basic Usage} - -\subsection{Special Behaviour} - -\subsection{Interaction With Other Thorns} - -\subsection{Examples} - -\subsection{Support and Feedback} - -\section{History} - -\subsection{Thorn Source Code} - -\subsection{Thorn Documentation} - -\subsection{Acknowledgements} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\section{Utilities} +\label{sec:utils} + +These scripts may be useful handling CarpetIOASCII data: +\begin{itemize} +\item {\bf Carpet2ygraph.pl} A perl script to convert to a format + suitable for the {\it xgraph} or {\it ygraph} packages of P. Walker + and D. Pollney. +\item {\bf mergeCarpetIOScalar.pl} A perl script to remove duplicate datasets from file(s). +\end{itemize} + +The first script resides in CarpetIOASCII/src/utils and was meant primarily to convert 1D data, +since the CarpetIOScalar data format is easily readable also by ygraph. Anyway, this script converts +also scalar data files to the original 2-column ygraph format. +Usage: {\tt Carpet2ygraphCat.pl Inputfile}. + +The second script can be used to merge CarpetIOScalar output written before and after recovery. It +reads one or more files in CarpetIOScalar format and writes their contents to STDOUT, eliminating +duplicate datasets (all but the last occurance are discarded), which may be created when a run died +abruptly without checkpointing at the last output itaration and is recovered from a previous +checkpoint. +Usage: {\tt mergeCarpetIOScalar.pl list of files}. \\ +Example 1: {\tt mergeCarpetIOScalar.pl alp.norm1.asc > alp.norm1.asc.merged}.\\ +Example 2: {\tt mergeCarpetIOScalar.pl alp.norm1.asc.firstCHKPT alp.norm1.asc.secondCHKPT > alp.norm1.asc.merged}.\\ +This script was written by Thomas Radke. \begin{thebibliography}{9} |