Homec4science
Diffusion lammps (master) Browse

lammps/tools/pymol_asphere/doc/asphere_vis.manpage
f93cd8f7ad83master

Last Change
Raw File

asphere_vis.manpage
View Options

.TH asphere_vis 1 "June 22, 2007" "asphere_vis (Graphics Utilities) 0.1" "Graphics Utilities"
.SH NAME
\fBasphere_vis\fR - Tools for ellipsoid visualization in PyMol of a LAMMPS trajectory.
.PD 2
.SH VERSION
.PD 1
Version 0.1
.PD 2
.SH SYNOPSIS
.PD 1
.TP
\fBasphere_vis\fR input_file dump_file output_py_file [\fB-b\fR] [\fB-c\fR \fIcolor_file\fR] [\fB-d\fR] [\fB-f\fR \fImax_frame\fR] [\fB-h\fR] [\fB-i\fR \fIstart_frame\fR \fIskip\fR \fIend_frame\fR] [\fB-n\fR \fInotice_level\fR] [\fB-r\fR \fIellip_res\fR] [\fB-s\fR]
.br
.PD 2
.SH DESCRIPTION
.PD 1
Tool for ellipsoid visualization in PyMol of a LAMMPS trajectory. The \fIinput_file\fR is a LAMMPS data file with a 'Shapes' section or a LAMMPS input script file with ellipsoid diameters specified using the 'shape' command. The trajectory is input from \fIdump_file\fR that must be generated using a LAMMPS dump_style custom command with the following arguments in order:
.PD 0
.PP
.PD 1
.PD 0
.TP
.PP
.PD 1
\fItag type x y z quatw quati quatj quatk\fR
.PD 0
.PP
.PD 1
.PD 2
.SH PARAMETERS
.PD 1
.TP
\fB-b\fR
When used with \fB-s\fR, the option will number the filenames based on the frame number. By default, they are numbered consequtively from zero.
.TP
\fB-c\fR \fIcolor_file\fR
.PD 0
.TP
.PP
.PD 1
Color the atom_types and set transparency based on the color file. The color file contains a space delimited set sequence of the color for an atom followed by the alpha. The color should be the string name and the alpha should be between 0 and 1.
.TP
\fB-d\fR
Use a LAMMPS input script rather than a data file for extracting atom shape information. The input script is specified as \fIinput_file\fR.
.TP
\fB-f\fR \fImax_frame\fR
.PD 0
.TP
.PP
.PD 1
Do not write more than \fImax_frame\fR frames to the output file.
.TP
\fB-h\fR
Print out the man page for help
.TP
\fB-i\fR \fIstart_frame\fR \fIskip\fR \fIend_frame\fR
.PD 0
.TP
.PP
.PD 1
Render the specified frame interval inclusive between \fIstart_frame\fR and \fIend_frame\fR. \fIskip\fR gives the number of frames to \fIskip\fR between each rendered frame. A value of 0 outputs every frame between \fIstart_frame\fR and \fIend_frame\fR. The first frame in the dump file is frame 0.
.TP
\fB-n\fR \fInotice_level\fR
.PD 0
.TP
.PP
.PD 1
Set the degree of program output. Use:
.PD 0
.PP
.PD 1
.PD 0
.PP
.PD 1
\fB-n\fR 0 No output
.PD 0
.PP
.PD 1
\fB-n\fR 10 Normal program output
.PD 0
.PP
.PD 1
\fB-n\fR 20 Parameters useful for reproducing the results
.PD 0
.PP
.PD 1
\fB-n\fR 30 All output
.TP
\fB-r\fR \fIellip_res\fR
.PD 0
.TP
.PP
.PD 1
Resolution of ellipsoids in PyMol. The number of triangles per ellipsoid is equal to 2*(\fIellip_res\fR^2). Default is 10.
.TP
\fB-s\fR
Output the results into separate .py files. The filename and extension for the output files is taken from \fIoutput_py_file\fR.
.PD 2
.SH AVAILABLE COLORS
.PD 1
.PD 0
.PP
.PD 1
black
.PD 0
.PP
.PD 1
blue
.PD 0
.PP
.PD 1
brown
.PD 0
.PP
.PD 1
cmyk_blue
.PD 0
.PP
.PD 1
cmyk_marine
.PD 0
.PP
.PD 1
deep
.PD 0
.PP
.PD 1
forest
.PD 0
.PP
.PD 1
green
.PD 0
.PP
.PD 1
grey
.PD 0
.PP
.PD 1
hotpink
.PD 0
.PP
.PD 1
magenta
.PD 0
.PP
.PD 1
marine
.PD 0
.PP
.PD 1
orange
.PD 0
.PP
.PD 1
purple
.PD 0
.PP
.PD 1
red
.PD 0
.PP
.PD 1
slate
.PD 0
.PP
.PD 1
teal
.PD 0
.PP
.PD 1
wheat
.PD 0
.PP
.PD 1
white
.PD 0
.PP
.PD 1
yellow
.PD 0
.PP
.PD 1
.PD 2
.SH KNOWN BUGS
.PD 1
Comments are not allowed at any point between a section header and the end of the contents for a section in either the data file or the input file.
.PD 2
.SH AUTHORS
.PD 1
W. Michael Brown
c4science · Help