Getting started

Installing CaseFOAM

In order to use the Python module you need the PyFoam package.

Run the setup.py.

$ python setup.py install
$ pip install pyfoam

The installation of pyviz is not necessary but we recommended:

$ conda install -c pyviz/label/dev pyviz

Details regarding the installation of pyviz are avaiable here.

User’s Guide

For a full documentation change into doc and build the documentation for example as html.

$ cd doc/
$ make html
$ firefox build/html/index.html