From ec05738ab4a3dc57ecc1bbc3b092ccedff30c24d Mon Sep 17 00:00:00 2001 From: markus holzer <markus.holzer@fau.de> Date: Mon, 5 Jul 2021 12:07:25 +0200 Subject: [PATCH] Added contributing file to lbmpy --- CONTRIBUTING.md | 3 +++ README.md | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..eab924e0 --- /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/README.md b/README.md index a828d439..907b5123 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ Many thanks go to the [contributors](AUTHORS.txt) of lbmpy. ### Please cite us -If you use pystencils in a publication, please cite the following articles: +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 -- GitLab