.TH "VIPER" 1

.SH NAME
Viper - the simple FEniCS run-time plotter

.SH SYNOPSIS
.B viper
[\fIOPTIONS\fR]

.SH DESCRIPTION
Viper is a minimalistic scientific plotter and run-time visualization
module. Some its the features includes:
.br

.br
* Light-weight and minimalistic
.br
* Extended keybindings
.br
* Interactive
.br
* Save as png, VTK
.br
* 2D and 3D
.br
* Scalar, vector, and displacement fields
.br
* Multiple input formats
.br
* In PyCC mode; direct plotting of NumPy arrays over DOLFIN meshes
.br
* Can be used as standalone plotting application, or used as part of
  PyDOLFIN 
.br

.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Display help text and exit.
.TP
\fB\-i\fR file, \fB\-\-input\fR file
Specify input file.
.TP
\fB\-o\fR file, \fB\-\-output\fR file
Specify output file.
.TP
\fB\-l\fR lut file, \fB\-\-lut\fR lut file
Specify lookup table (LUT) file.
.TP
\fB\-d\fR data file, \fB\-\-data\fR data file
Specify data file.

.SH EXAMPLE
Viper has support for visualizing meshes and solutions in DOLFIN:
.br

.br
	from dolfin import *
.br

.br
	# Plot a mesh
.br
	mesh = UnitCube(16, 16, 16)
.br
	plot(mesh)
.br

.br
	# Plot a scalar function
.br
	u = Function("poisson.xml")
.br
	plot(u)
.br

.br
	# Plot a vector function as a displacement field
.br
	d = Function("elasticity.xml")
.br
	plot(d, mode="displacement")
.br

.br
	# Save as png
.br
	p = plot(mesh)
.br
	p.write_png("mesh.png")
.br

.br
	# Save as VTK
.br
	p = plot(u)
.br
	p.write_vtk("poisson.vtk")
.br

.br

.SH BUGS
.TP
Send comments, questions, bug reports etc. to fenics-viper@lists.launchpad.net.

.SH LICENSE
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

.SH AUTHOR
Ola Skavhaug <skavhaug@simula.no>

This manual page was written by Johannes Ring <johannr@simula.no>.