.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.46.4.
.TH PYSPH_VIEWER "1" "December 2014" "pysph_viewer Usage:" "User Commands"
.SH NAME
pysph_viewer \- viewer to view the output of results. Usage:
.SH DESCRIPTION
Usage:
pysph_viewer [\-v] <trait1=value> <trait2=value> [files.npz]
.PP
If *.npz files are not supplied it will connect to a running solver, if not it
will display the given files.
.PP
The arguments <trait1=value> are optional settings like host, port and authkey
etc.  The following traits are available:
.TP
host
\fB\-\-\fR hostname/IP address to connect to.
.TP
port
\fB\-\-\fR Port to connect to
.TP
authkey
\fB\-\-\fR authorization key to use.
.TP
interval
\fB\-\-\fR time interval to refresh display
.TP
pause_solver
\fB\-\-\fR Set True/False, will pause running solver
.TP
movie_directory \fB\-\-\fR directory to dump movie files (automatically set if not
supplied)
.TP
record
\fB\-\-\fR True/False: record movie, i.e. store screenshots of display.
.TP
play
\fB\-\-\fR True/False: Play all stored data files.
.TP
loop
\fB\-\-\fR True/False: Loop over data files.
.SH OPTIONS
\fB\-\-\-\-\-\-\-\-\fR
.TP
\fB\-h\fR/\-\-help
prints this message.
.TP
\fB\-v\fR
sets verbose mode which will print solver connection
status failures on stdout.
.PP
Examples::
\fB\-\-\-\-\-\-\-\-\-\-\fR
.IP
\f(CW$ pysph_viewer interval=10 host=localhost port=8900\fR
.br
\f(CW$ pysph_viewer foo.npz\fR
.br
\f(CW$ pysph_viewer *.npz play=True loop=True\fR
.PP
pysph_viewer [\-v] <trait1=value> <trait2=value> [files.npz]
.PP
If *.npz files are not supplied it will connect to a running solver, if not it
will display the given files.
.PP
The arguments <trait1=value> are optional settings like host, port and authkey
etc.  The following traits are available:
.TP
host
\fB\-\-\fR hostname/IP address to connect to.
.TP
port
\fB\-\-\fR Port to connect to
.TP
authkey
\fB\-\-\fR authorization key to use.
.TP
interval
\fB\-\-\fR time interval to refresh display
.TP
pause_solver
\fB\-\-\fR Set True/False, will pause running solver
.TP
movie_directory \fB\-\-\fR directory to dump movie files (automatically set if not
supplied)
.TP
record
\fB\-\-\fR True/False: record movie, i.e. store screenshots of display.
.TP
play
\fB\-\-\fR True/False: Play all stored data files.
.TP
loop
\fB\-\-\fR True/False: Loop over data files.
.PP
\fB\-\-\-\-\-\-\-\-\fR
.TP
\fB\-h\fR/\-\-help
prints this message.
.TP
\fB\-v\fR
sets verbose mode which will print solver connection
status failures on stdout.
.PP
Examples::
\fB\-\-\-\-\-\-\-\-\-\-\fR
.IP
\f(CW$ pysph_viewer interval=10 host=localhost port=8900\fR
.br
\f(CW$ pysph_viewer foo.npz\fR
.br
\f(CW$ pysph_viewer *.npz play=True loop=True\fR
.SH "SEE ALSO"
The full documentation for
.B pysph_viewer
is maintained as a Texinfo manual.  If the
.B info
and
.B pysph_viewer
programs are properly installed at your site, the command
.IP
.B info pysph_viewer
.PP
should give you access to the complete manual.