diff --git a/README.md b/README.md index a6a9497675b5c2fb331b14289464d4488916bbec..bd3680317ccc7c923d11873b88baffe0bdb1029b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,35 @@ pystencils ========== +Run blazingly fast stencil codes on numpy arrays.  + +Installation +------------ + +```bash +export PIP_EXTRA_INDEX_URL=https://www.walberla.net/pip +pip install pystencils[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 +- `bench_db`: functionality to store benchmark result in object databases +- `interactive`: installs dependencies to work in Jupyter including image I/O, plotting etc. +- `doc`: packages to build documentation + +Options can be combined e.g. +```bash +pip install pystencils[interactive,gpu,doc] +``` + + +Documentation +------------- + +Read the docs [here](http://software.pages.walberla.net/pystencils/pystencils) \ No newline at end of file