What it is
The purpose of this library is to support working with the OpenSource CFD-toolbox OpenFOAM and its forks
This Python library can be used to
- analyze the logs produced by OpenFoam-solvers
- execute OpenFoam-solvers and utilities and analyze their output simultaneously
- manipulate the parameter files and the initial-conditions of a run in a non-destructive manner
- plots the residuals of OpenFOAM solvers
- lots of other stuff
Most of this functionality is made available to the user in the form of command-line utilities.
PyFoam does all this strictly "from the outside": by writing parameter files and reading the output of the solvers. Without compiled parts or being linked to OpenFOAM.
More information is found on the OpenFOAM Wiki. Introductory presentations on PyFoam can be found there
Installation
The easiest way to install PyFoam is the Python package-manager pip:
pip install PyFoam
which will install PyFoam
License
PyFoam is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. See the file COPYING in this directory, for a description of the GNU General Public License terms under which you can copy the files.
Contributors
If not otherwise noted in a source-files the primary author is Bernhard Gschaider
The people who contributed to PyFoam (If I forgot someone: tell me):
- Bernhard Gschaider
- Martin Beaudoin
- Fabian Pollesböck
- Etienne Lorriaux
- Bruno Santos
- Marc Immer
- Oliver Borm
Further reading
These documents give further information
- ReleaseNotes: list of the changes between versions (newest versions are on top).
- DeveloperNotes: document with information for people who want to
contribute to
PyFoam
For information on the usage see the presentations on the PyFOAM
page on the OpenFOAM-Wiki
This document
The original source of this document is README.org. The
README.md (to which the README links) is automatically generated
and should not be edited. The reason for this setup is that most
Web-GUIs for VCS insist on Markdown as a markup language
1 maintainer
Metadata
1 maintainer
Release files for pyfoam 2026.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyfoam-2026.6.tar.gz | 15.5 MB | Without provenance | Details for pyfoam-2026.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyfoam-2026.6-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for pyfoam-2026.6-py2.py3-none-any.whl |
Total release size: 16.2 MB
Release files / pyfoam-2026.6.tar.gz
| Download URL | pyfoam-2026.6.tar.gz |
|---|---|
| Size | 15.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0a5ca6b980c212a9243aa3fcdd8c8be9876dd528cf79a415192e63e3d4a1c3c5
|
|
BLAKE2b-256 checksum How to use checksums |
75cb55a0f626881163f4ba3f540be47d9164172f5d8ea04b24bdf5f168f3c22a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.3
|
Release files / pyfoam-2026.6-py2.py3-none-any.whl
| Download URL | pyfoam-2026.6-py2.py3-none-any.whl |
|---|---|
| Size | 702.7 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
055c6f1942b09f8792440f74b45e8446123e5513ba75a6894c849a7ab30c23ec
|
|
BLAKE2b-256 checksum How to use checksums |
57b4bdeec50a2d67edf81c96c4bfe269c5b31ca21deaa35e8d7ec251c31f41cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.3
|
Security for pyfoam 2026.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
