https://github.com/fluiddyn/fluidfoam

OpenFoam postprocessing python tool
https://github.com/fluiddyn/fluidfoam

cfd openfoam postprocessing python

Last synced: 10 days ago
JSON representation

OpenFoam postprocessing python tool

• Host: GitHub
• URL: https://github.com/fluiddyn/fluidfoam
• Owner: fluiddyn
• License: gpl-3.0
• Created: 2018-01-16T18:22:50.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-03-29T15:30:21.000Z (24 days ago)
• Last Synced: 2025-04-09T14:16:07.955Z (13 days ago)
• Topics: cfd, openfoam, postprocessing, python
• Language: Python
• Homepage:
• Size: 47.4 MB
• Stars: 169
• Watchers: 11
• Forks: 52
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt
  • Authors: AUTHORS.txt

Awesome Lists containing this project

README

        
========

fluidfoam

========

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

.. |release| image:: https://img.shields.io/pypi/v/fluidfoam.svg

   :target: https://pypi.python.org/pypi/fluidfoam/

   :alt: Latest version

.. |docs| image:: https://readthedocs.org/projects/fluidfoam/badge/?version=latest

   :target: http://fluidfoam.readthedocs.org

   :alt: Documentation status

.. |Github-action| image:: https://github.com/fluiddyn/fluidfoam/actions/workflows/build_and_test.yml/badge.svg

   :target: https://github.com/fluiddyn/fluidfoam/actions

   :alt: CI status

.. |coverage| image:: https://codecov.io/gh/fluiddyn/fluidfoam/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/fluiddyn/fluidfoam/branch/master/

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

* Supported OpenFoam Versions : 2.4.0, 4.1 to 9, v1712plus to v2406plus

* 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

-------------

* 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