TUD LBM

A lattice Boltzmann method package developed at Delft University of Technology. This package provides tools for simulating fluid dynamics using the lattice Boltzmann method, supporting both single-phase and multi-phase simulations.

The project setup is documented in project_setup.md.

Installation

TUD-LBM requires Python 3.10 or newer.

We recommend using uv for installation because it provides a fast, consistent, and cross-platform workflow for Linux, macOS, and Windows. For most users, uv is the simplest way to create an isolated environment and install the package from the repository.

If you already work in a conda-based scientific Python environment, on an HPC system, or need non-Python/system-level dependencies managed outside the project, conda remains a good optional alternative.

Install uv

Install uv by following the official instructions for your platform:

• https://docs.astral.sh/uv/getting-started/installation/

Linux and macOS

git clone git@github.com:szkuds/tud_lbm.git
cd tud_lbm
uv venv --python 3.14
source .venv/bin/activate
uv pip install .
python -c "import tud_lbm"

Windows

git clone git@github.com:szkuds/tud_lbm.git
cd tud_lbm
uv venv --python 3.14
.venv\Scripts\activate
uv pip install .
python -c "import tud_lbm"

Optional: editable install for contributors

uv pip install -e .[dev]

Optional: conda

If you prefer conda for scientific Python environments, you can still use the conda-based workflow documented in project_setup.md.

Documentation

For full documentation, visit tud-lbm.readthedocs.io.

Quick Start

Python API

from app_setup import SimulationSetup
from runner import Run

setup = SimulationSetup(
    grid_shape=(100, 100),
    tau=0.6,
    nt=10000,
    save_interval=1000,
)
sim = Run(setup)
sim.run(verbose=True)

TOML Configuration File

tud_lbm example/config_simple.toml

Interactive CLI

tud_lbm  # launches interactive parameter prompts

For the full package reference (module-by-module API, operator tables, and architecture details), see the developer documentation.

Contributing

If you want to contribute to the development of tud_lbm, have a look at the contribution guidelines.

Credits

This package was created with Copier and the NLeSC/python-template.