---
name: "tsplash"
section: "1"
platform: "linux"
package: "splash"
version: "2.10.1-1"
release: "Debian 11 (Bullseye)"
platforms: ["linux"]
url: "https://new.carta.tech/tsplash"
---

# tsplash(1)

## NAME

splash -- A visualisation tool for SPH data (c)2004-2020 Daniel Price and contributors

## SYNOPSIS

**splash** *file1 file2 file3*...

## DESCRIPTION

SPLASH: A visualisation tool for SPH data (c)2004-2020 Daniel Price and contributors v2.10.1 \[24th June 2020\]

Usage with flags: splash \[-p fileprefix\] \[-d defaultsfile\] \[-l limitsfile\] \[-ev\] \[-lowmem\] \[-o format\] \[-x col\] \[-y col\] \[-render col\] \[-cont col\] file1 file2 ...

Command line options:

- **-p** fileprefix

  : change prefix to ALL settings files read/written by splash

- **-d** defaultsfile

  : change name of defaults file read/written by splash

- **-l** limitsfile

  : change name of limits file read/written by splash

- **-e**, **-ev**

  : use default options best suited for line plotting (.ev files)

- **-360**

  : set default options suited to 360 video

- **-lm**, **-lowmem**

  : use low memory mode \[applies only to sphNG data read at present\]

- **-o** pixformat

  : dump pixel map in specified format (use just **-o** for list of formats)

Command line plotting mode:

- **-x** column

  : specify x plot on command line (ie. do not prompt for x)

- **-y** column

  : specify y plot on command line (ie. do not prompt for y)

- **-r\[ender\]** column

  : specify rendered quantity on command line (ie. no render prompt) (will take columns 1 and 2 as x and y if **-x** and/or **-y** not specified)

- **-vec\[tor\]** column

  : specify vector plot quantity on command line (ie. no vector prompt)

**-c\[ontour\]** column : specify contoured quantity on command line (ie. no contour prompt)

- **-dev** device

  : specify plotting device on command line (ie. do not prompt)

-

  convert mode ("splash to X dumpfiles"): splash to ascii   : convert SPH data to ascii file dumpfile.ascii

- to binary

  : convert SPH data to simple unformatted binary dumpfile.binary:

- [write(1)](/write/1.md) time,np,ncols

  do i=1,np

- [write(1)](/write/1.md) dat(1:ncols),itype

  enddo

- to stream

  : convert SPH data to streamed binary format dumpfile.binarystream:

-

  t,np,ncols,np\*(dat(1:ncols),itype) \[4,4,4,np\*(ncols\*4,4)\] bytes

-

  to phantom : convert SPH data to binary dump file for PHANTOM to gadget  : convert SPH data to default GADGET snapshot file format

-

  Grid conversion mode ("splash to X dumpfiles"):

- splash to grid

  : interpolate basic SPH data (density, plus velocity if present in data)

-

  to 2D or 3D grid, write grid data to file (using default output=ascii)

- to gridascii

  : as above, grid data written in ascii format

- to gridascii2

  : grid data written in ascii format, all in one file

- to gridbinary

  : as above, grid data in simple unformatted binary format:

- 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 \]

- to gridstream

  : grid data in byte-stream binary format (e.g. for python):

-

  nx,ny,nz,ncolumns,time,xmin,xmax,ymin,ymax,zmin,zmax,rho \[ 4,4,4,4,8\*7,8\*nx\*ny\*nz \]

- allto grid

  : as above, interpolating \*all\* columns to the grid (and output file)

- allto gridascii

  : as above, with ascii output

- allto gridbinary

  : as above, with binary output

-

  Analysis mode ("splash calc X dumpfiles") on a sequence of dump files:

- splash calc energies

  : calculate KE,PE,total energy vs time

-

  output to file called 'energy.out'

- calc massaboverho : mass above a series of density thresholds vs time

  output to file called 'massaboverho.out'

- calc max

  : maximum of each column vs. time

-

  output to file called 'maxvals.out'

- calc min

  : minimum of each column vs. time

-

  output to file called 'minvals.out'

- calc diff

  : (max - min) of each column vs. time

-

  output to file called 'diffvals.out'

- calc amp

  : 0.5\*(max - min) of each column vs. time

-

  output to file called 'ampvals.out'

- calc delta

  : 0.5\*(max - min)/mean of each column vs. time

-

  output to file called 'deltavals.out'

- calc mean

  : mean of each column vs. time

-

  output to file called 'meanvals.out'

- calc rms

  : (mass weighted) root mean square of each column vs. time

-

  output to file called 'rmsvals.out'

- calc tracks

  : track particle data vs time for selected\* particle,

-

  output to file called 'tracks.out'

-

  ( \* select "xy limits relative to particle" in l)imits menu", or

-

  press "t" in interactive mode, and save settings to splash.defaults )

-

  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):

- calc timeaverage

  : time average of \*all\* entries for every particle

-

  output to file called 'time\_average.out'

- calc ratio

  : ratio of \*all\* entries in each file compared to first

-

  output to file called 'ratio.out'

-

  Basic splash usage is explained in the userguide,

-

  located in the directory splash/docs/splash.pdf

v2.10.1 \[24th June 2020\]

Usage: splash file1 file2 file3...

Usage with flags: splash \[-p fileprefix\] \[-d defaultsfile\] \[-l limitsfile\] \[-ev\] \[-lowmem\] \[-o format\] \[-x col\] \[-y col\] \[-render col\] \[-cont col\] file1 file2 ...

Command line options:

- **-p** fileprefix

  : change prefix to ALL settings files read/written by splash

- **-d** defaultsfile

  : change name of defaults file read/written by splash

- **-l** limitsfile

  : change name of limits file read/written by splash

- **-e**, **-ev**

  : use default options best suited for line plotting (.ev files)

- **-360**

  : set default options suited to 360 video

- **-lm**, **-lowmem**

  : use low memory mode \[applies only to sphNG data read at present\]

- **-o** pixformat

  : dump pixel map in specified format (use just **-o** for list of formats)

Command line plotting mode:

- **-x** column

  : specify x plot on command line (ie. do not prompt for x)

- **-y** column

  : specify y plot on command line (ie. do not prompt for y)

- **-r\[ender\]** column

  : specify rendered quantity on command line (ie. no render prompt) (will take columns 1 and 2 as x and y if **-x** and/or **-y** not specified)

- **-vec\[tor\]** column

  : specify vector plot quantity on command line (ie. no vector prompt)

**-c\[ontour\]** column : specify contoured quantity on command line (ie. no contour prompt)

- **-dev** device

  : specify plotting device on command line (ie. do not prompt)

-

  convert mode ("splash to X dumpfiles"): splash to ascii   : convert SPH data to ascii file dumpfile.ascii

- to binary

  : convert SPH data to simple unformatted binary dumpfile.binary:

- [write(1)](/write/1.md) time,np,ncols

  do i=1,np

- [write(1)](/write/1.md) dat(1:ncols),itype

  enddo

- to stream

  : convert SPH data to streamed binary format dumpfile.binarystream:

-

  t,np,ncols,np\*(dat(1:ncols),itype) \[4,4,4,np\*(ncols\*4,4)\] bytes

-

  to phantom : convert SPH data to binary dump file for PHANTOM to gadget  : convert SPH data to default GADGET snapshot file format

-

  Grid conversion mode ("splash to X dumpfiles"):

- splash to grid

  : interpolate basic SPH data (density, plus velocity if present in data)

-

  to 2D or 3D grid, write grid data to file (using default output=ascii)

- to gridascii

  : as above, grid data written in ascii format

- to gridascii2

  : grid data written in ascii format, all in one file

- to gridbinary

  : as above, grid data in simple unformatted binary format:

- 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 \]

- to gridstream

  : grid data in byte-stream binary format (e.g. for python):

-

  nx,ny,nz,ncolumns,time,xmin,xmax,ymin,ymax,zmin,zmax,rho \[ 4,4,4,4,8\*7,8\*nx\*ny\*nz \]

- allto grid

  : as above, interpolating \*all\* columns to the grid (and output file)

- allto gridascii

  : as above, with ascii output

- allto gridbinary

  : as above, with binary output

-

  Analysis mode ("splash calc X dumpfiles") on a sequence of dump files:

- splash calc energies

  : calculate KE,PE,total energy vs time

-

  output to file called 'energy.out'

- calc massaboverho : mass above a series of density thresholds vs time

  output to file called 'massaboverho.out'

- calc max

  : maximum of each column vs. time

-

  output to file called 'maxvals.out'

- calc min

  : minimum of each column vs. time

-

  output to file called 'minvals.out'

- calc diff

  : (max - min) of each column vs. time

-

  output to file called 'diffvals.out'

- calc amp

  : 0.5\*(max - min) of each column vs. time

-

  output to file called 'ampvals.out'

- calc delta

  : 0.5\*(max - min)/mean of each column vs. time

-

  output to file called 'deltavals.out'

- calc mean

  : mean of each column vs. time

-

  output to file called 'meanvals.out'

- calc rms

  : (mass weighted) root mean square of each column vs. time

-

  output to file called 'rmsvals.out'

- calc tracks

  : track particle data vs time for selected\* particle,

-

  output to file called 'tracks.out'

-

  ( \* select "xy limits relative to particle" in l)imits menu", or

-

  press "t" in interactive mode, and save settings to splash.defaults )

-

  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):

- calc timeaverage

  : time average of \*all\* entries for every particle

-

  output to file called 'time\_average.out'

- calc ratio

  : ratio of \*all\* entries in each file compared to first

-

  output to file called 'ratio.out'

unknown command line argument '--version'

## SEE ALSO

The full documentation for **SPLASH:** is maintained as a Texinfo manual.  If the **info** and **SPLASH:** programs are properly installed at your site, the command

-

  **info SPLASH:**

should give you access to the complete manual.