From 56c29c621d31b13bff01a73c5a40c36a2f989df6 Mon Sep 17 00:00:00 2001 From: markus holzer <markus.holzer@fau.de> Date: Sun, 27 Jun 2021 16:20:11 +0200 Subject: [PATCH] Edited readme, authors and git CI --- .gitlab-ci.yml | 7 ++++--- AUTHORS.txt | 11 ++++++----- README.md | 13 ++++++++++++- pre-push | 22 ---------------------- 4 files changed, 22 insertions(+), 31 deletions(-) delete mode 100755 pre-push diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 196f25abd..439503da0 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,4 +1,5 @@ stages: + - pretest - test - deploy @@ -7,7 +8,7 @@ stages: # Normal test - runs on every commit all but "long run" tests tests-and-coverage: - stage: test + stage: pretest except: variables: - $ENABLE_NIGHTLY_BUILDS @@ -201,7 +202,7 @@ riscv64: - sed -i 's/fopenmp/fopenmp=libgomp -I\/usr\/include\/riscv64-linux-gnu/g' ~/.config/pystencils/config.json minimal-conda: - stage: test + stage: pretest except: variables: - $ENABLE_NIGHTLY_BUILDS @@ -277,7 +278,7 @@ pycodegen-integration: flake8-lint: - stage: test + stage: pretest except: variables: - $ENABLE_NIGHTLY_BUILDS diff --git a/AUTHORS.txt b/AUTHORS.txt index 443a630bd..3c5e2ba63 100644 --- a/AUTHORS.txt +++ b/AUTHORS.txt @@ -3,12 +3,13 @@ Contributors: ------------- - Martin Bauer <martin.bauer@fau.de> + - Markus Holzer <markus.holzer@fau.de> - Stephan Seitz <stephan.seitz@fau.de> + - Michael Kuron <mkuron@icp.uni-stuttgart.de> - Jan Hönig <jan.hoenig@fau.de> - - Nils Kohl <nils.kohl@fau.de> - Julian Hammer <julian.hammer@fau.de> - - Christian Godenschwager <christian.godenschwager@fau.de> - - Markus Holzer <markus.holzer@fau.de> - - Michael Kuron <mkuron@icp.uni-stuttgart.de> + - Nils Kohl <nils.kohl@fau.de> + - Frederik Hennig <frederik.hennig@fau.de> - Dominik Ernst <dominik.ernst@fau.de> - - João Victor Tozatti Risso <joaovictortr@protonmail.com> + - Christian Godenschwager <christian.godenschwager@fau.de> + - Dominik Thoennes <dominik.thoennes@fau.de> diff --git a/README.md b/README.md index fbe4e9cf4..144028bb6 100644 --- a/README.md +++ b/README.md @@ -62,9 +62,20 @@ Options can be combined e.g. pip install pystencils[interactive,gpu,doc] ``` - Documentation ------------- Read the docs [here](https://pycodegen.pages.i10git.cs.fau.de/pystencils) 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, Code Generation for Massively Parallel Phase-Field Simulations. Association for Computing Machinery, 2019. https://doi.org/10.1145/3295500.3356186 \ No newline at end of file diff --git a/pre-push b/pre-push deleted file mode 100755 index b0efe6d41..000000000 --- a/pre-push +++ /dev/null @@ -1,22 +0,0 @@ -#!/usr/bin/env bash - -# Checks run before every push -# has to be copied to .git/hooks - -echo "Running pre-push hook" -echo "Running flake8 check" -flake8 --append-config=.flake8 pystencils - -# $? stores exit value of the last command -if [ $? -ne 0 ]; then - echo "flake8 failed" - exit 1 -fi - -python3 setup.py quicktest - -# $? stores exit value of the last command -if [ $? -ne 0 ]; then - echo "quicktest failed" - exit 1 -fi -- GitLab