.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
.TH SPLASH: "1" "June 2020" "SPLASH: A visualisation tool for SPH data (c)2004-2020 Daniel Price and contributors" "User Commands"
.SH NAME
splash -- A visualisation tool for SPH data (c)2004-2020 Daniel Price and contributors
.SH SYNOPSIS
.B splash
\fI\,file1 file2 file3\/\fR...
.SH DESCRIPTION
SPLASH: A visualisation tool for SPH data (c)2004\-2020 Daniel Price and contributors
v2.10.1 [24th June 2020]
.PP
Usage with flags: splash [\-p fileprefix] [\-d defaultsfile] [\-l limitsfile] [\-ev]
[\-lowmem] [\-o format] [\-x col] [\-y col] [\-render col] [\-cont col] file1 file2 ...
.PP
Command line options:
.TP
\fB\-p\fR fileprefix
: change prefix to ALL settings files read/written by splash
.TP
\fB\-d\fR defaultsfile
: change name of defaults file read/written by splash
.TP
\fB\-l\fR limitsfile
: change name of limits file read/written by splash
.TP
\fB\-e\fR, \fB\-ev\fR
: use default options best suited for line plotting (.ev files)
.TP
\fB\-360\fR
: set default options suited to 360 video
.TP
\fB\-lm\fR, \fB\-lowmem\fR
: use low memory mode [applies only to sphNG data read at present]
.TP
\fB\-o\fR pixformat
: dump pixel map in specified format (use just \fB\-o\fR for list of formats)
.PP
Command line plotting mode:
.TP
\fB\-x\fR column
: specify x plot on command line (ie. do not prompt for x)
.TP
\fB\-y\fR column
: specify y plot on command line (ie. do not prompt for y)
.TP
\fB\-r[ender]\fR column
: specify rendered quantity on command line (ie. no render prompt)
(will take columns 1 and 2 as x and y if \fB\-x\fR and/or \fB\-y\fR not specified)
.TP
\fB\-vec[tor]\fR column
: specify vector plot quantity on command line (ie. no vector prompt)
.HP
\fB\-c[ontour]\fR column : specify contoured quantity on command line (ie. no contour prompt)
.TP
\fB\-dev\fR device
: specify plotting device on command line (ie. do not prompt)
.IP
convert mode ("splash to X dumpfiles"):
splash to ascii   : convert SPH data to ascii file dumpfile.ascii
.TP
to binary
: convert SPH data to simple unformatted binary dumpfile.binary:
.TP
write(1) time,np,ncols
do i=1,np
.TP
write(1) dat(1:ncols),itype
enddo
.TP
to stream
: convert SPH data to streamed binary format dumpfile.binarystream:
.IP
t,np,ncols,np*(dat(1:ncols),itype) [4,4,4,np*(ncols*4,4)] bytes
.IP
to phantom : convert SPH data to binary dump file for PHANTOM
to gadget  : convert SPH data to default GADGET snapshot file format
.IP
Grid conversion mode ("splash to X dumpfiles"):
.TP
splash to grid
: interpolate basic SPH data (density, plus velocity if present in data)
.IP
to 2D or 3D grid, write grid data to file (using default output=ascii)
.TP
to gridascii
: as above, grid data written in ascii format
.TP
to gridascii2
: grid data written in ascii format, all in one file
.TP
to gridbinary
: as above, grid data in simple unformatted binary format:
.TP
write(unit) nx,ny,nz,ncolumns,time,xmin,xmax,ymin,ymax,zmin,zmax [ 4x4,7x8 bytes ]
write(unit) (((rho(i,j,k),i=1,nx),j=1,ny),k=1,nz)  [ 8 bytes each ]
write(unit) (((vx(i,j,k), i=1,nx),j=1,ny),k=1,nz)  [ 8 bytes each ]
write(unit) (((vy(i,j,k), i=1,nx),j=1,ny),k=1,nz)  [ 8 bytes each ]
write(unit) (((...(i,j,k),i=1,nx),j=1,ny),k=1,nz)  [ 8 bytes each ]
.TP
to gridstream
: grid data in byte\-stream binary format (e.g. for python):
.IP
nx,ny,nz,ncolumns,time,xmin,xmax,ymin,ymax,zmin,zmax,rho [ 4,4,4,4,8*7,8*nx*ny*nz ]
.TP
allto grid
: as above, interpolating *all* columns to the grid (and output file)
.TP
allto gridascii
: as above, with ascii output
.TP
allto gridbinary
: as above, with binary output
.IP
Analysis mode ("splash calc X dumpfiles") on a sequence of dump files:
.TP
splash calc energies
: calculate KE,PE,total energy vs time
.IP
output to file called 'energy.out'
.TP
calc massaboverho : mass above a series of density thresholds vs time
output to file called 'massaboverho.out'
.TP
calc max
: maximum of each column vs. time
.IP
output to file called 'maxvals.out'
.TP
calc min
: minimum of each column vs. time
.IP
output to file called 'minvals.out'
.TP
calc diff
: (max \- min) of each column vs. time
.IP
output to file called 'diffvals.out'
.TP
calc amp
: 0.5*(max \- min) of each column vs. time
.IP
output to file called 'ampvals.out'
.TP
calc delta
: 0.5*(max \- min)/mean of each column vs. time
.IP
output to file called 'deltavals.out'
.TP
calc mean
: mean of each column vs. time
.IP
output to file called 'meanvals.out'
.TP
calc rms
: (mass weighted) root mean square of each column vs. time
.IP
output to file called 'rmsvals.out'
.TP
calc tracks
: track particle data vs time for selected* particle,
.IP
output to file called 'tracks.out'
.IP
( * select "xy limits relative to particle" in l)imits menu", or
.IP
press "t" in interactive mode, and save settings to splash.defaults )
.IP
the above options all produce a small ascii file with one row per input file.
the following option produces a file equivalent in size to one input file (in ascii format):
.TP
calc timeaverage
: time average of *all* entries for every particle
.IP
output to file called 'time_average.out'
.TP
calc ratio
: ratio of *all* entries in each file compared to first
.IP
output to file called 'ratio.out'
.IP
Basic splash usage is explained in the userguide,
.IP
located in the directory splash/docs/splash.pdf
.PP
v2.10.1 [24th June 2020]
.PP
Usage: splash file1 file2 file3...
.PP
Usage with flags: splash [\-p fileprefix] [\-d defaultsfile] [\-l limitsfile] [\-ev]
[\-lowmem] [\-o format] [\-x col] [\-y col] [\-render col] [\-cont col] file1 file2 ...
.PP
Command line options:
.TP
\fB\-p\fR fileprefix
: change prefix to ALL settings files read/written by splash
.TP
\fB\-d\fR defaultsfile
: change name of defaults file read/written by splash
.TP
\fB\-l\fR limitsfile
: change name of limits file read/written by splash
.TP
\fB\-e\fR, \fB\-ev\fR
: use default options best suited for line plotting (.ev files)
.TP
\fB\-360\fR
: set default options suited to 360 video
.TP
\fB\-lm\fR, \fB\-lowmem\fR
: use low memory mode [applies only to sphNG data read at present]
.TP
\fB\-o\fR pixformat
: dump pixel map in specified format (use just \fB\-o\fR for list of formats)
.PP
Command line plotting mode:
.TP
\fB\-x\fR column
: specify x plot on command line (ie. do not prompt for x)
.TP
\fB\-y\fR column
: specify y plot on command line (ie. do not prompt for y)
.TP
\fB\-r[ender]\fR column
: specify rendered quantity on command line (ie. no render prompt)
(will take columns 1 and 2 as x and y if \fB\-x\fR and/or \fB\-y\fR not specified)
.TP
\fB\-vec[tor]\fR column
: specify vector plot quantity on command line (ie. no vector prompt)
.HP
\fB\-c[ontour]\fR column : specify contoured quantity on command line (ie. no contour prompt)
.TP
\fB\-dev\fR device
: specify plotting device on command line (ie. do not prompt)
.IP
convert mode ("splash to X dumpfiles"):
splash to ascii   : convert SPH data to ascii file dumpfile.ascii
.TP
to binary
: convert SPH data to simple unformatted binary dumpfile.binary:
.TP
write(1) time,np,ncols
do i=1,np
.TP
write(1) dat(1:ncols),itype
enddo
.TP
to stream
: convert SPH data to streamed binary format dumpfile.binarystream:
.IP
t,np,ncols,np*(dat(1:ncols),itype) [4,4,4,np*(ncols*4,4)] bytes
.IP
to phantom : convert SPH data to binary dump file for PHANTOM
to gadget  : convert SPH data to default GADGET snapshot file format
.IP
Grid conversion mode ("splash to X dumpfiles"):
.TP
splash to grid
: interpolate basic SPH data (density, plus velocity if present in data)
.IP
to 2D or 3D grid, write grid data to file (using default output=ascii)
.TP
to gridascii
: as above, grid data written in ascii format
.TP
to gridascii2
: grid data written in ascii format, all in one file
.TP
to gridbinary
: as above, grid data in simple unformatted binary format:
.TP
write(unit) nx,ny,nz,ncolumns,time,xmin,xmax,ymin,ymax,zmin,zmax [ 4x4,7x8 bytes ]
write(unit) (((rho(i,j,k),i=1,nx),j=1,ny),k=1,nz)  [ 8 bytes each ]
write(unit) (((vx(i,j,k), i=1,nx),j=1,ny),k=1,nz)  [ 8 bytes each ]
write(unit) (((vy(i,j,k), i=1,nx),j=1,ny),k=1,nz)  [ 8 bytes each ]
write(unit) (((...(i,j,k),i=1,nx),j=1,ny),k=1,nz)  [ 8 bytes each ]
.TP
to gridstream
: grid data in byte\-stream binary format (e.g. for python):
.IP
nx,ny,nz,ncolumns,time,xmin,xmax,ymin,ymax,zmin,zmax,rho [ 4,4,4,4,8*7,8*nx*ny*nz ]
.TP
allto grid
: as above, interpolating *all* columns to the grid (and output file)
.TP
allto gridascii
: as above, with ascii output
.TP
allto gridbinary
: as above, with binary output
.IP
Analysis mode ("splash calc X dumpfiles") on a sequence of dump files:
.TP
splash calc energies
: calculate KE,PE,total energy vs time
.IP
output to file called 'energy.out'
.TP
calc massaboverho : mass above a series of density thresholds vs time
output to file called 'massaboverho.out'
.TP
calc max
: maximum of each column vs. time
.IP
output to file called 'maxvals.out'
.TP
calc min
: minimum of each column vs. time
.IP
output to file called 'minvals.out'
.TP
calc diff
: (max \- min) of each column vs. time
.IP
output to file called 'diffvals.out'
.TP
calc amp
: 0.5*(max \- min) of each column vs. time
.IP
output to file called 'ampvals.out'
.TP
calc delta
: 0.5*(max \- min)/mean of each column vs. time
.IP
output to file called 'deltavals.out'
.TP
calc mean
: mean of each column vs. time
.IP
output to file called 'meanvals.out'
.TP
calc rms
: (mass weighted) root mean square of each column vs. time
.IP
output to file called 'rmsvals.out'
.TP
calc tracks
: track particle data vs time for selected* particle,
.IP
output to file called 'tracks.out'
.IP
( * select "xy limits relative to particle" in l)imits menu", or
.IP
press "t" in interactive mode, and save settings to splash.defaults )
.IP
the above options all produce a small ascii file with one row per input file.
the following option produces a file equivalent in size to one input file (in ascii format):
.TP
calc timeaverage
: time average of *all* entries for every particle
.IP
output to file called 'time_average.out'
.TP
calc ratio
: ratio of *all* entries in each file compared to first
.IP
output to file called 'ratio.out'
.PP
unknown command line argument '\-\-version'
.SH "SEE ALSO"
The full documentation for
.B SPLASH:
is maintained as a Texinfo manual.  If the
.B info
and
.B SPLASH:
programs are properly installed at your site, the command
.IP
.B info SPLASH:
.PP
should give you access to the complete manual.