add citation information

[LbmBenchmarkKernelsPublic.git] / README

diff --git a/README b/README
index 512bd357520799a5db73f7556e17587d1bc3e9e7..05717faf0f529cf23f93296b9909a8f4f914272e 100644 (file)
--- a/README
+++ b/README
@@ -1,32 +1,59 @@
-# --------------------------------------------------------------------------
-#
-# Copyright
-#   Markus Wittmann, 2016-2017
-#   RRZE, University of Erlangen-Nuremberg, Germany
-#   markus.wittmann -at- fau.de or hpc -at- rrze.fau.de
-#
-#   Viktor Haag, 2016
-#   LSS, University of Erlangen-Nuremberg, Germany
-#
-#  This file is part of the Lattice Boltzmann Benchmark Kernels (LbmBenchKernels).
-#
-#  LbmBenchKernels is free software: you can redistribute it and/or modify
-#  it under the terms of the GNU General Public License as published by
-#  the Free Software Foundation, either version 3 of the License, or
-#  (at your option) any later version.
-#
-#  LbmBenchKernels is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#  GNU General Public License for more details.
-#
-#  You should have received a copy of the GNU General Public License
-#  along with LbmBenchKernels.  If not, see <http://www.gnu.org/licenses/>.
-#
-# --------------------------------------------------------------------------
-
-# 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.
-
-See doc subdirectory for a rudimentary documentation.
+Lattice Boltzmann Benchmark Kernels
+===================================
+
+The lattice Boltzmann (LBM) benchmark kernels are a collection of LBM kernel
+implementations.
+
+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
+----------------
+
+This work was funded by:
+
+  - BMBF, grant no. 01IH15003A (project SKAMPY)
+  - KONWHIR project OMI4PAPS
+
+
+[1] https://hpc.fau.de/
+[2] https://www10.informatik.uni-erlangen.de/en/
+