From e3017dea955f981aabe187f13a3d0ac5c36f1ddd Mon Sep 17 00:00:00 2001 From: Oliver Hahn Date: Thu, 19 Dec 2019 11:55:56 +0000 Subject: [PATCH] README.md edited online with Bitbucket --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 495a2c6..aac4f55 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,23 @@ Create build directory, configure, and build: make this should create an executable in the build directory. -There is an example parameter file 'example.conf' in the main directory If you run into problems with CMake not being able to find your local FFTW3 or HDF5 installation, it is best to give the path directly as FFTW3_ROOT= HDF5_ROOT= ccmake .. -make sure to delete previous files generated by CMake before reconfiguring like this. \ No newline at end of file +make sure to delete previous files generated by CMake before reconfiguring like this. + +## Running + +There is an example parameter file 'example.conf' in the main directory. Possible options are explained in it, it can be run +as a simple argument, e.g. from within the build directory: + + ./monofonic ../example.conf + +If you want to run with MPI, you need to enable MPI support via ccmake. Then you can launch in hybrid MPI+threads mode by +specifying the desired number of threads per task in the config file, and the number of tasks to be launched via + + mpirun -np 16 ./monofonic + +It will then run with 16 tasks times the number of threads per task specified in the config file. \ No newline at end of file