From 9aacab283b7a0bbcaeda4d79dad2a81d035afab8 Mon Sep 17 00:00:00 2001
From: Debolskiy Andrey <and.debol@gmail.com>
Date: Tue, 16 Mar 2021 10:33:31 +0300
Subject: [PATCH] Update README.md

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index eb3b4a3..24a90cc 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`
-- 
GitLab