README.md 1.15 KB
Newer Older
1
2
lbmpy
=====
3

4
[![Docs](https://img.shields.io/badge/read-the_docs-brightgreen.svg)](http://pycodegen.pages.walberla.net/lbmpy)
5
[![pipeline status](https://i10git.cs.fau.de/pycodegen/lbmpy/badges/master/pipeline.svg)](https://i10git.cs.fau.de/pycodegen/lbmpy/commits/master)
6
[![coverage report](https://i10git.cs.fau.de/pycodegen/lbmpy/badges/master/coverage.svg)](http://pycodegen.pages.walberla.net/lbmpy/coverage_report)
7
8


9
Run fast fluid simulations based on the lattice Boltzmann method in Python.
10

11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
![alt text](doc/img/logo.png)


Installation
------------

```bash
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
31
pip install lbmpy[interactive,gpu,doc]
32
33
34
35
36
37
```


Documentation
-------------

38
39
Read the docs [here](http://pycodegen.pages.walberla.net/lbmpy) and
check out the Jupyter notebooks in `doc/notebooks`.