OilfieldToolsNet/LBPM
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added basic build instructions to README.md

Browse Source
This commit is contained in:
James E McClure 2016-09-01 14:30:25 -04:00
parent b34d1f1f29
commit e2312da4ec
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -4,3 +4,21 @@ LBPM-WIA
Lattice Boltzmann Methods for Porous Media with Integrated Averaging Lattice Boltzmann Methods for Porous Media with Integrated Averaging
======== ========
Notes on installation
* example configure scripts for cmake are in the sample_scripts directory
* required dependencies - MPI, C++ 11
* optional dependencies - NetCDF, CUDA, TimerUtility
Configure, build & install procedure
1) create an empty directory to install (do not build in source!)
mkdir /path/to/my/install
cd /path/to/my/install
2) edit configure script from sample_scripts directory and configure (e.g.)
/path/to/LBPM-WIA/sample_scripts/configure_desktop
3) compile and install
make -j4 && make install
4) run the unit tests to make sure it works
ctest