gettslice is now a command line tool.
authorAndras Laszlo <laszlo.andras@wigner.mta.hu>
Thu, 27 Aug 2015 15:50:09 +0000 (17:50 +0200)
committerAndras Laszlo <laszlo.andras@wigner.mta.hu>
Thu, 27 Aug 2015 15:50:09 +0000 (17:50 +0200)
man/gridripperapp.man

index 6ff6636..947e0f7 100644 (file)
@@ -23,6 +23,15 @@ To use the PDE solver application, use the following command:
 
 .B gridripper your_inputfile
 
+The produced binary output files are stored under name scheme *.bdata, 
+and can be converted to an easy-to-visualize ASCII format using the 
+command line tool:
+
+.B gettslice
+
+In order to get help on the usage of this conversion tool, just start 
+it on the command line without arguments.
+
 .SH DESCRIPTION
 The GridRipperApp is an application library for the GridRipper PDE 
 solver core library, written in C++ language. 
@@ -39,6 +48,13 @@ to its core library, generating the binary
 .B gridripper
 which is the actual PDE solver program.
 
+The tool
+.B gettslice
+is shipped with the gridripper+gridripperapp package and can be used to 
+pick certain time slices of the output binary files, called .bdata 
+files. This tool converts the time slices to an easy-to-visualize ASCII 
+format.
+
 .SH REQUIREMENTS
 GridRipperApp requires the GridRipper core library to be installed.
 
@@ -51,6 +67,11 @@ actual PDE plus its initial conditions. This is described in detail
 on the GridRipper homepage (see below). One can find example input files 
 under the directory reported by the following command:
 
+The binary-to-ASCII converter program
+.B gettslice
+must be started with proper command line arguments. For a help on 
+these, just start it on the command line without arguments.
+
 .B pkg-config gridripperapp --variable=inputsdir
 
 .SH ENVIRONMENT