pymm#
An open-source image-based framework for computational fluid dynamics in microsystems.
Get started
Learn what pymm does and how its image, mesh, flow, and tracer workflows connect.
Install
Install pymm, Gmsh, and OpenFOAM, then verify the external tools.
Follow the tutorial
Build a mesh, run flow and tracer simulations, and inspect the outputs.
Explore examples
Reproduce the image, device, and online-image cases.
Quick installation#
pip install git+https://github.com/cssr-tools/pymm.git
Quick start#
pymm -i microsystem.png -p parameters.toml -t all
What can pymm do?#
Process images
Segment grayscale microsystem images into grains and pore space.
Generate meshes
Extract polygonal boundaries and create three-dimensional Gmsh meshes.
Simulate flow
Run steady incompressible flow simulations with OpenFOAM.
Transport tracers
Run transient tracer-transport simulations and export VTK results.
Build different domains
Support image-sized and device-style computational domains.