← Back to branch summary

~pyslosh-dev/pyslosh/trunk

« back to all changes in this revision

Viewing changes to doc/index.txt

  • Committer: Tormod Ravnanger Landet
  • Date: 2008-07-27 16:53:42 UTC
  • Revision ID: tormod@landet.net-20080727165342-ur618db04xggipvv
Documentation update for thesis delivery

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/index.txt
8
8
 
9
9
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).
10
10
 
11
 
The main author is `Tormod Ravnanger Landet <http://tormod.landet.net/>`_.
 
11
The author of the code is `Tormod Ravnanger Landet <http://tormod.landet.net/>`_.
12
12
 
13
13
Useful links:
14
14
 
51
51
 
52
52
    > make install
53
53
 
54
 
No files except those in the created directory (bin) and the install directory will be altered
 
54
- the included unit tests can be run from the make file by running::
 
55
 
 
56
   > make test 
 
57
 
 
58
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.
55
59