pySlosh

About

pySlosh is a Python library for simulating sloshing. It has two solvers, a Volume of Fluid (VOF) solver based on Youngs' (1982) VOF algorithm and a simple surface height function solver similar to SOLA_SURF by Hirt, Nichols and Romero (1975).

The author of the code is Tormod Ravnanger Landet.

Useful links:

The pySlosh API documentation
The HCML specification (HCML is used for storing the hydrodynamical coefficients needed to run coupled analysis of ship motions and sloshing)
The hcml API documentation

The code

The code is hosted in Launchpad, a free software hosting and development site. See pySlosh in Launchpad at https://launchpad.net/pyslosh.

The latest development code can be found at http://bazaar.launchpad.net/~pyslosh-dev/pyslosh/trunk/files.

Installing

To build you need the following:

a C++ compiler
cmake
python-dev headers
boost-python headers
boost headers

Build procedure:

enter an empty directory:
```
> mkdir bin
> cd bin
```

generate make files:

> cmake -DCMAKE_INSTALL_PREFIX:PATH=/path/to/python/site-packages /path/to/folder/containing/CMakeLists.txt

compile and link and install:
```
> make install
```
the included unit tests can be run from the make file by running:
```
> make test
```

No files except those in the created directory (bin) and the install directory will be altered if you perform the recommended "out of source tree" build routine above.