diff --git a/README.md b/README.md index eb3b4a37a8f3f7bfad6ee268911f791665979d96..24a90cc1f10961d5f149bdad33dbda9626e649f1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # Dns Particles Huawei -This is a temporary repo for source code of NSE solver porting for Kunpeng architecture \ No newline at end of file +This is a temporary repo for source code of NSE solver porting for Kunpeng architecture. + +To build the executable use make, for example on Taishan: +``` +make -B MACHINE=kunpeng COMPILER=gnu +``` +this will create an executable `nsenx`, which then should be run using mpiexec or mpirun: +``` +mpiexec -n 32 nsenx +``` +this will run the code with 32 mpi-processors. By default number of OpenMP threads is set to 1, to change that, change the following line in `model-defines.h`: +``` +#define SET_OPENMP_THREADS 1 // set number of OpenMP threads by hand +``` +or, comment it and use `OMP_NUM_THREADS` enviromental variable instead. + + +Most of the configuration of the model is done by `config.txt` file. Model diagnostics are outputed in `output/nse-data.txt`