diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..fd28dd71b4b3bd9c00b49ba3ac6709f6628ac424 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +pystencils-walberla +=================== +[](https://i10git.cs.fau.de/pycodegen/pystencils_walberla/commits/master) + +Formulate stencil kernels in pystencils and generate optimized C++ Code for waLBerla from it. +Look at the waLBerla documentation on how to use it. + +Install with +```bash +pip install pystencils-walberla +``` +and enable WALBERLA_BUILD_WITH_CODEGEN in waLBerla's CMake. + +