X-Git-Url: http://git.rrze.uni-erlangen.de/gitweb/?p=LbmBenchmarkKernelsPublic.git;a=blobdiff_plain;f=README;h=05717faf0f529cf23f93296b9909a8f4f914272e;hp=d548b38022e94bd3fa4cfd5dd9035cea16c89e86;hb=HEAD;hpb=0095f461c30075a883df0265a7b831061ee7ebee

diff --git a/README b/README
index d548b38..05717fa 100644
--- a/README
+++ b/README
@@ -1,23 +1,48 @@
 Lattice Boltzmann Benchmark Kernels
 ===================================
 
-Simple benchmark suite for LBM kernels and performance experiments from the HPC
-group of Erlangen Regional Computing Center (RRZE/HPC) [1] and the Chair for
-System Simulation of FAU (LSS) [2].
+The lattice Boltzmann (LBM) benchmark kernels are a collection of LBM kernel
+implementations.
 
-See doc/main.rst or doc/html/main.html subdirectories for rudimentary
+AS SUCH THE LBM BENCHMARK KERNELS ARE NO FULLY EQUIPPED CFD SOLVER AND SOLELY
+SERVE THE PURPOSE OF STUDYING POSSIBLE PERFORMANCE OPTIMIZATIONS AND/OR
+EXPERIMENTS.
+
+The benchmark suite was created by the HPC group of Erlangen Regional Computing
+Center (RRZE/HPC) [1] and the Chair for System Simulation of FAU (LSS) [2].
+
+See doc/main.rst or doc/main.html subdirectories for rudimentary
 documentation.
 
 
 
 LICENCE
 -------
+
 LBM benchmark kernels are licensed under GPLv3.
 
 See licence of src/BoostJoin.h in the top of src/BoostJoin.h, which stems from
 the boost projects and is licenced under the Boost licence.
 
+CITE US
+-------
+
+If you use the benchmark kernels you can cite us:
+
+M. Wittmann, V. Haag, T. Zeiser, H. Köstler, and G. Wellein: Lattice Boltzmann
+Benchmark Kernels as a Testbed for Performance Analysis, (2018), Computer &
+Fluids, Special Issue DSFD2017. doi:10.1016/j.compfluid.2018.03.030. 
+
+Bibtex entry:
 
+@article{wittmann-2018,
+    author  = {M. Wittmann and V. Haag and T. Zeiser and H. K\"ostler and G. Wellein},
+    title   = {Lattice {B}oltzmann benchmark kernels as a testbed for performance analysis},
+    journal = {Computers \& Fluids},
+    year    = {2018},
+    issn    = {0045-7930},
+    doi     = {10.1016/j.compfluid.2018.03.030},
+}
 
 ACKNOWLEDGEMENTS
 ----------------