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