---

foamlib is a modern Python package that simplifies working with OpenFOAM input/output data by providing a standalone parser for OpenFOAM’s own file format. It also includes robust case-handling capabilities that reduce boilerplate code and enable efficient pre-processing, post-processing, and simulation management directly from Python.

With support for ASCII- and binary-formatted fields, a fully type-hinted API, and asynchronous operations, foamlib offers a streamlined, Pythonic approach to automating and managing OpenFOAM workflows.

Note

foamlib is published in the Journal of Open Source Software (JOSS). Read the paper for more details about the design and implementation.

📚 Documentation guide

• 📄 File manipulation
  • FoamFile
  • FoamFieldFile
  • Additional classes
  • Exceptions
• 📁 Case manipulation
  • FoamCaseBase
  • FoamCase
  • AsyncFoamCase
  • AsyncSlurmFoamCase
  • Exceptions
• ▶️ Example
  • Overview
  • Code
• 🗃️ Parametric study (foamlib.preprocessing)
  • Installing extra dependencies
  • Overview
  • CSV Generator
  • Grid Parameter sweep
• 👓 Post-processing (foamlib.postprocessing)
  • Installing extra dependencies
  • Time series data
  • List output files
  • Spatial data (surfaces, sets, …)
• 🏷️ Typing (foamlib.typing)
  • Standard types
  • Other accepted types

🔍 Indices and search

• Index

• Module Index

• Search Page