From 5a6dc812e95e65ae3871242e396829b349e47b8a Mon Sep 17 00:00:00 2001
From: markus holzer <markus.holzer@fau.de>
Date: Sun, 27 Jun 2021 16:40:29 +0200
Subject: [PATCH] Edited readme, authors and git CI
---
.gitlab-ci.yml | 60 ++++++++++++++++++++++++++------------------------
AUTHORS.txt | 13 +++++++++++
README.md | 15 +++++++++++++
3 files changed, 59 insertions(+), 29 deletions(-)
create mode 100644 AUTHORS.txt
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 2bcf82db..ba923011 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,13 +1,14 @@
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
diff --git a/AUTHORS.txt b/AUTHORS.txt
new file mode 100644
index 00000000..d591db3e
--- /dev/null
+++ b/AUTHORS.txt
@@ -0,0 +1,13 @@
+
+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>
diff --git a/README.md b/README.md
index cd7fce1e..3403bd8c 100644
--- a/README.md
+++ b/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 pystencils.
+
+### Please cite us
+
+If you use pystencils 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
--
GitLab