From 750099d2f1cee79face8cc803f0c58d0c1c6d571 Mon Sep 17 00:00:00 2001 From: Martin Bauer <martin.bauer@fau.de> Date: Fri, 22 Mar 2019 14:44:10 +0100 Subject: [PATCH] Update readme and wrote separate readme's for packages --- README.md | 35 ++++++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 712df71..5131d8a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,34 @@ -pystencils -========== +lbmpy +===== +Run fast fluid simulations based on the lattice Boltzmann method in Python. - \ No newline at end of file + + + +Installation +------------ + +```bash +export PIP_EXTRA_INDEX_URL=https://www.walberla.net/pip +pip install lbmpy[interactive] +``` + + +Without `[interactive]` you get a minimal version with very little dependencies. + +All options: +- `gpu`: use this if nVidia GPU is available and CUDA is installed +- `alltrafos`: pulls in additional dependencies for loop simplification e.g. libisl +- `interactive`: installs dependencies to work in Jupyter including image I/O, plotting etc. + +Options can be combined e.g. +```bash +pip install pystencils[interactive,gpu,doc] +``` + + +Documentation +------------- + +Read the docs [here](http://software.pages.walberla.net/pystencils/lbmpy) -- GitLab