FluidFoam documentation

The fluidfoam package provides Python classes useful to perform some plot with OpenFoam data.

What is this repository for?

  • Openfoam Tools
  • Version : 0.2.0
  • Supported OpenFoam Versions : 2.4.0, 4.1 to 7, v1712plus to v1912plus
  • Supported Python Versions : 2.7.x, >= 3.4

Deployment instructions

The simplest way to install fluidfoam is by using pip:

pip install fluidfoam --user

You can get the source code from github or from the Python Package Index.

The development mode is often useful. From the root directory, run:

python setup.py develop --user

Committing instructions (in development mode)

A good starting point is to follow this forking tutorial.

To clone your fork of fluidfoam repository:

git clone https://github.com/your_username/fluidfoam

To get the status of the repository:

git status

In case of new/modified file(s):

git add new_file

To commit a revision on the local repository:

git commit -m "comment on the revision"

To push the revision on your github fluidfoam repository:

git push

To propose your changes into the main fluidfoam project, follow again the forking tutorial.

Emeritus Core Developers


fluidfoam is distributed under the GNU General Public License v2 (GPLv2).

Modules Reference

Here is presented the general organization of the package and the documentation of the modules, classes and functions.

fluidfoam.readof Read OpenFoam Files for Python
fluidfoam.processing1d Write, Read and Plot 1D input files for swak4foam
fluidfoam.readpostpro Read OpenFoam PostProcessing Files for Python
fluidfoam.meshdesign Compute mesh grading and cell sizes

Example galleries:


Indices and tables