|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.
http://fluidfoam.readthedocs.org <http://fluidfoam.readthedocs.org>_
The simplest way to install fluidfoam is by using pip::
pip install fluidfoam --user
You can get the source code from github <https://github.com/fluiddyn/fluidfoam> or from the Python Package Index <https://pypi.python.org/pypi/fluidfoam/>.
The development mode is often useful. From the root directory, run::
python setup.py develop --user
A good starting point is to follow this forking tutorial <https://guides.github.com/activities/forking/>_.
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 <https://guides.github.com/activities/forking/>_.
fluidfoam is distributed under the GNU General Public License v3 (GPLv3 or newer).
.. _GPLv3: https://www.gnu.org/licenses/gpl-3.0.en.html