Skip to main content

Openfoam PostProcessing Python Tools

Project description

======== fluidfoam

|release| |docs| |Github-action| |coverage|

.. |release| image:: :target: :alt: Latest version

.. |docs| image:: :target: :alt: Documentation status

.. |Github-action| image:: :target: :alt: CI status

.. |coverage| image:: :target: :alt: Code coverage

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

What is this repository for?

  • Openfoam Tools
  • Version : 0.2.5
  • Supported OpenFoam Versions : 2.4.0, 4.1 to 9, v1712plus to v2212plus
  • Supported Python Versions : >= 3.8

Documentation and Examples <>_

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 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

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 <>_.

Example Usage

Core Developers

Other Contributors

Emeritus Core Developers

Emeritus Developers


fluidfoam is distributed under the GNU General Public License v3 (GPLv3 or newer).

.. _GPLv3:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release. See tutorial on generating distribution archives.

Built Distribution

fluidfoam-0.2.5-py3-none-any.whl (36.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page