diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 2bcf82dbdb01ae9deb47fab1a219b312bfdf0dcd..ba923011fa3b7d81e64f6dfa100ab03935c1277f 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 0000000000000000000000000000000000000000..d591db3e7e1f226f7cccfdf29478b5cf2f42124d --- /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/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000000000000000000000000000000..eab924e075a0b33011528b0bf26769da399903fd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# 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 diff --git a/MANIFEST.in b/MANIFEST.in index fdbf85c0dc1a99f5e0f094203094bd875059e377..8d256aa5f49c3fdb1a410391f46dc677113c532f 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,7 @@ 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 diff --git a/README.md b/README.md index cd7fce1e2c5f58943c8957d31f57191632575c1b..907b512386f12a786b974613112d0705984c9b19 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 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