Metadata-Version: 2.1
Name: lbmpy
Version: 0.2.9
Summary: Code Generation for Lattice Boltzmann Methods
Home-page: https://i10git.cs.fau.de/pycodegen/lbmpy/
Author: Martin Bauer
Author-email: martin.bauer@fau.de
License: AGPLv3
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Jupyter
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Requires-Python: >=3.6
Requires-Dist: pystencils
Provides-Extra: alltrafos
Requires-Dist: islpy ; extra == 'alltrafos'
Requires-Dist: py-cpuinfo ; extra == 'alltrafos'
Provides-Extra: doc
Requires-Dist: sphinx ; extra == 'doc'
Requires-Dist: sphinx-rtd-theme ; extra == 'doc'
Requires-Dist: nbsphinx ; extra == 'doc'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'doc'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'doc'
Requires-Dist: pandoc ; extra == 'doc'
Provides-Extra: gpu
Requires-Dist: pycuda ; extra == 'gpu'
Provides-Extra: interactive
Requires-Dist: scipy ; extra == 'interactive'
Requires-Dist: scikit-image ; extra == 'interactive'
Requires-Dist: cython ; extra == 'interactive'
Requires-Dist: matplotlib ; extra == 'interactive'
Requires-Dist: ipy-table ; extra == 'interactive'
Requires-Dist: imageio ; extra == 'interactive'
Requires-Dist: jupyter ; extra == 'interactive'
Requires-Dist: pyevtk ; extra == 'interactive'
Provides-Extra: opencl
Requires-Dist: pyopencl ; extra == 'opencl'

lbmpy
=====

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


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

![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
pip install lbmpy[interactive,gpu,doc]
```


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

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


