The library comes bundled with an example program.It runs a simulation using the parameters given and outputs the resutls in the folder specified with frames_folder_prefix.

The results can be viewed using HoudiniFX.

NB : The library and the example program are two separate things. The library itself only deals with the simulation. All input validation, configuration and file IO is done separately.

If you have an AMD card head over to this wiki for instructions.

The oficial compiler for the project is g++ but clang++ also works great.

On Ubuntu this can be installed by running sudo apt-get install ocl-icd-opencl-dev.

1. Clone the repo on your local machine
2. Compile using make
3. Go to bin and run a simulation like this: ./example.out <fluid_name> <simulation_properties_name> <scene_name> <frames_folder_prefix>

Please notice that for {fluid_name,simulation_properties_name,scene_name} you only need to enter the base name of the file and not the path.