Merge branch 'Dev' into 'master'

Add Authors to lbmpy

See merge request !88

.gitlab-ci.yml

 stages:
+  - pretest
   - test
   - deploy
 
 
-# --------------------------  Tests ------------------------------------------------------------------------------------
+# --------------------------  Pre Tests --------------------------------------------------------------------------------
 
 # Normal test - runs on every commit all but "long run" tests
 tests-and-coverage:
-  stage: test
+  stage: pretest
   except:
     variables:
       - $ENABLE_NIGHTLY_BUILDS
@@ -36,6 +37,33 @@ tests-and-coverage:
       cobertura: coverage.xml
       junit: report.xml
 
+minimal-conda:
+  stage: pretest
+  except:
+    variables:
+      - $ENABLE_NIGHTLY_BUILDS
+  image: i10git.cs.fau.de:5005/pycodegen/pycodegen/minimal_conda
+  script:
+    - pip install git+https://gitlab-ci-token:${CI_JOB_TOKEN}@i10git.cs.fau.de/pycodegen/pystencils.git@master#egg=pystencils
+    - python setup.py quicktest
+  tags:
+    - docker
+
+# Linter for code formatting
+flake8-lint:
+  stage: pretest
+  except:
+    variables:
+      - $ENABLE_NIGHTLY_BUILDS
+  image: i10git.cs.fau.de:5005/pycodegen/pycodegen/full
+  script:
+    - flake8 lbmpy
+  tags:
+    - docker
+    - cuda11
+
+# -------------------------- Tests -------------------------------------------------------------------------------------
+
 # pipeline with latest python version
 latest-python:
   stage: test
@@ -132,18 +160,6 @@ ubuntu:
     reports:
       junit: report.xml
 
-minimal-conda:
-  stage: test
-  except:
-    variables:
-      - $ENABLE_NIGHTLY_BUILDS
-  image: i10git.cs.fau.de:5005/pycodegen/pycodegen/minimal_conda
-  script:
-    - pip install git+https://gitlab-ci-token:${CI_JOB_TOKEN}@i10git.cs.fau.de/pycodegen/pystencils.git@master#egg=pystencils
-    - python setup.py quicktest
-  tags:
-    - docker
-
 pycodegen-integration:
   image: i10git.cs.fau.de:5005/pycodegen/pycodegen/full
   stage: test
@@ -179,21 +195,7 @@ pycodegen-integration:
     - cuda11
     - AVX
 
-# -------------------- Linter & Documentation --------------------------------------------------------------------------
-
-
-flake8-lint:
-  stage: test
-  except:
-    variables:
-      - $ENABLE_NIGHTLY_BUILDS
-  image: i10git.cs.fau.de:5005/pycodegen/pycodegen/full
-  script:
-    - flake8 lbmpy
-  tags:
-    - docker
-    - cuda11
-
+# -------------------- Documentation and deploy ------------------------------------------------------------------------
 
 build-documentation:
   stage: test

AUTHORS.txt

+
+Contributors:
+-------------
+
+  - Martin Bauer <martin.bauer@fau.de>
+  - Markus Holzer <markus.holzer@fau.de>
+  - Michael Kuron <mkuron@icp.uni-stuttgart.de>
+  - Stephan Seitz <stephan.seitz@fau.de>
+  - Frederik Hennig <frederik.hennig@fau.de>
+  - Helen Schottenhamml <helen.schottenhamml@fau.de>
+  - Rudolf Weeber <weeber@icp.uni-stuttgart.de>
+  - Christian Godenschwager <christian.godenschwager@fau.de>
+  - Jan Hönig <jan.hoenig@fau.de>

CONTRIBUTING.md

+# Contributing
+
+lbmpy is built on the open-source python framework [pystencils](https://pypi.org/project/pystencils/). Please consider the [contribution guideline](https://i10git.cs.fau.de/pycodegen/pystencils/-/blob/master/CONTRIBUTING.md) of pystencils for contributing to lbmpy.
\ No newline at end of file

MANIFEST.in

 include README.md
 include COPYING.txt
-include RELEASE-VERSION
+include AUTHORS.txt
+include CONTRIBUTING.md
 global-include *.pyx
 include versioneer.py
 include lbmpy/_version.py

README.md

@@ -55,3 +55,18 @@ Documentation
 
 Read the docs [here](http://pycodegen.pages.i10git.cs.fau.de/lbmpy) and
 check out the Jupyter notebooks in `doc/notebooks`. 
+
+Authors
+-------
+
+Many thanks go to the [contributors](AUTHORS.txt) of lbmpy.
+
+### Please cite us
+
+If you use lbmpy in a publication, please cite the following articles:
+
+Overview:
+  - M. Bauer et al, lbmpy: Automatic code generation for efficient parallel lattice Boltzmann methods. Journal of Computational Science, 2021. https://doi.org/10.1016/j.jocs.2020.101269
+
+Multiphase:
+   - M. Holzer et al, Highly efficient lattice Boltzmann multiphase simulations of immiscible fluids at high-density ratios on CPUs and GPUs through code generation. The International Journal of High Performance Computing Applications, 2021. https://doi.org/10.1177/10943420211016525