LBPM/README.md
2020-06-23 13:51:14 +02:00

35 lines
748 B
Markdown

LBPM
========
Lattice Boltzmann Methods for Porous Media
========
Notes on installation
* example configure scripts for cmake are in the sample_scripts directory
* required dependencies - MPI, HDF5, SILO, C++14
* optional dependencies - NetCDF, CUDA, TimerUtility
Build dependencies (zlib, hdf5, silo) OR point to an existing installation
Configure, build & install procedure
* create an empty directory to install (do not build in source!)
`mkdir /path/to/my/install`
`cd /path/to/my/install`
* edit configure script from sample_scripts directory and configure (e.g.)
`/path/to/LBPM/sample_scripts/configure_desktop`
* compile and install
`make -j4 && make install`
* run the unit tests to make sure it works
`ctest`