Changes between Version 2 and Version 3 of ToolsAndUtilities/PpFileTools

Timestamp:

30/04/13 12:46:38 (7 years ago)

Author:

ros

Comment:

—

ToolsAndUtilities/PpFileTools

@@ -28 +28 @@
  
 
-The source code for the tools `pp_merge`, `pp_rdiff`, `pp_qdiff` and `pp_getfields` can be downloaded.  Unpack the tar file and type `make` for instructions.
+The source code for the following tools `pp_merge`, `pp_rdiff`, `pp_qdiff` and `pp_getfields` can be downloaded here: [attachment:PP_tools_src.tar.gz PP Tools Source]
+Unpack the tar file and type `make` for instructions.
+
+== pp_merge ==
+
+Merges (interleaves) PP files to produce a PP file in time order. This is suitable for use with NDdiag, which requires its input to be in time order.
+
+Usage:
+{{{
+pp_merge {PP output file} { List of PP input files }
+}}}
+
+== pp_rdiff ==
+
+This compares two PP files of the same size. It computes the relative difference between corresponding field points according to the formula
+
+Image
+
+Usage:
+{{{
+pp_rdiff {Input PP file 1} {Input PP file 2} [{Threshold}]
+}}}
+where `Threshold` is a positive number. If no threshold is supplied, a value of 10-7 is used. The tool reports whether the files are different to within threshold and the maximum absolute relative difference found.
+
+== pp_qdiff ==
+
+PP quick difference. This simply subtracts the field points of the two input files, which must be the same size, and puts them in the output.
+
+Usage:
+{{{
+pp_qdiff {PP file 1} {PP file 2} {Output PP file}
+}}}
+
+The output file can then be examined by a graphical program like `xconv`.
+
+== pp_getfields ==
+
+This program extracts a list of fields specified by the user.
+
+Usage:
+{{{
+pp_getfield {Input PP} {Output PP} {STASH list}
+}}}
+where the STASH items are separated by spaces.