Skip to content

martidig/fluidfoam

 
 

Repository files navigation

fluidfoam

Latest version Documentation status CI status 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

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

Example Usage

Core Developers

Other Contributors

Emeritus Core Developers

Emeritus Developers

License

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

About

OpenFoam postprocessing python tool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.4%
  • Dockerfile 1.1%
  • Makefile 0.5%