fluidfoam

fluidfoam

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

What is this repository for?

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

Documentation and Examples

http://fluidfoam.readthedocs.org

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 fluidfoam directory, run::

python3 -m pip install --editable . --user

Or if you are using a virtual environment, run::

python3 -m pip install --editable .

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.

Example Usage

• https://sedfoam.github.io

Core Developers

• [email protected]

Other Contributors

• [email protected]
• [email protected]
• [email protected]
• [email protected]
• [email protected]
• [email protected]
• Gabriel Goncalves

Emeritus Core Developers

• [email protected]

Emeritus Developers

• [email protected]
• [email protected]

License

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

… _GPLv3: https://www.gnu.org/licenses/gpl-3.0.en.html