========
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.6
* Supported OpenFoam Versions : 2.4.0, 4.1 to 9, v1712plus to v2312plus
* Supported Python Versions : >= 3.8
Documentation and Examples
--------------------------
`http://fluidfoam.readthedocs.org
<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
<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
Committing instructions (in development mode)
---------------------------------------------
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/>`_.
Example Usage
-------------
* https://sedfoam.github.io
Core Developers
---------------
* Cyrille.Bonamy@univ-grenoble-alpes.fr
Other Contributors
------------------
* Julien.Chauchat@univ-grenoble-alpes.fr
* amathieu@udel.edu
* Remi.Chassagne@univ-grenoble-alpes.fr
* Quentin.Clemencot@univ-grenoble-alpes.fr
* Matthias.Renaud@univ-grenoble-alpes.fr
* Alban.Gilletta.De.Saint.Joseph@france-energies-marines.org
* Gabriel Goncalves
Emeritus Core Developers
------------------------
* Pierre.Augier@legi.cnrs.fr
Emeritus Developers
------------------------
* Guillaume.Maurice@univ-grenoble-alpes.fr
* Tim.Nagel@legi.cnrs.fr
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
Raw data
{
"_id": null,
"home_page": "http://legi.grenoble-inp.fr",
"name": "fluidfoam",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Openfoam, postprocessing, python, CFD",
"author": "Cyrille Bonamy",
"author_email": "cyrille.bonamy@univ-grenoble-alpes.fr",
"download_url": null,
"platform": null,
"description": "========\nfluidfoam\n========\n\n|release| |docs| |Github-action| |coverage|\n\n.. |release| image:: https://img.shields.io/pypi/v/fluidfoam.svg\n :target: https://pypi.python.org/pypi/fluidfoam/\n :alt: Latest version\n\n.. |docs| image:: https://readthedocs.org/projects/fluidfoam/badge/?version=latest\n :target: http://fluidfoam.readthedocs.org\n :alt: Documentation status\n\n.. |Github-action| image:: https://github.com/fluiddyn/fluidfoam/actions/workflows/build_and_test.yml/badge.svg\n :target: https://github.com/fluiddyn/fluidfoam/actions\n :alt: CI status\n\n.. |coverage| image:: https://codecov.io/gh/fluiddyn/fluidfoam/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/fluiddyn/fluidfoam/branch/master/\n :alt: Code coverage\n\nThe fluidfoam package provides Python classes useful to perform some plot with OpenFoam data.\n\nWhat is this repository for?\n----------------------------\n\n* Openfoam Tools\n* Version : 0.2.6\n* Supported OpenFoam Versions : 2.4.0, 4.1 to 9, v1712plus to v2312plus\n* Supported Python Versions : >= 3.8\n\nDocumentation and Examples\n--------------------------\n\n`http://fluidfoam.readthedocs.org\n<http://fluidfoam.readthedocs.org>`_\n\nDeployment instructions\n-----------------------\n\nThe simplest way to install fluidfoam is by using pip::\n\n pip install fluidfoam --user\n\nYou can get the source code from `github\n<https://github.com/fluiddyn/fluidfoam>`_ or from `the Python Package Index\n<https://pypi.python.org/pypi/fluidfoam/>`_.\n\nThe development mode is often useful. From the root directory, run::\n\n python setup.py develop --user\n\n\nCommitting instructions (in development mode)\n---------------------------------------------\n\nA good starting point is to follow this `forking tutorial <https://guides.github.com/activities/forking/>`_.\n\nTo clone your fork of fluidfoam repository::\n\n git clone https://github.com/your_username/fluidfoam\n \nTo get the status of the repository::\n\n git status\n\nIn case of new/modified file(s)::\n\n git add new_file\n\nTo commit a revision on the local repository::\n\n git commit -m \"comment on the revision\"\n\nTo push the revision on your github fluidfoam repository::\n\n git push\n\nTo propose your changes into the main fluidfoam project, follow again the `forking tutorial <https://guides.github.com/activities/forking/>`_.\n\nExample Usage\n-------------\n\n* https://sedfoam.github.io\n\nCore Developers\n---------------\n\n* Cyrille.Bonamy@univ-grenoble-alpes.fr\n\nOther Contributors\n------------------\n\n* Julien.Chauchat@univ-grenoble-alpes.fr\n* amathieu@udel.edu\n* Remi.Chassagne@univ-grenoble-alpes.fr\n* Quentin.Clemencot@univ-grenoble-alpes.fr\n* Matthias.Renaud@univ-grenoble-alpes.fr\n* Alban.Gilletta.De.Saint.Joseph@france-energies-marines.org\n* Gabriel Goncalves\n\nEmeritus Core Developers\n------------------------\n\n* Pierre.Augier@legi.cnrs.fr\n\nEmeritus Developers\n------------------------\n\n* Guillaume.Maurice@univ-grenoble-alpes.fr\n* Tim.Nagel@legi.cnrs.fr\n\nLicense\n-------\n\nfluidfoam is distributed under the GNU General Public License v3 (GPLv3 or newer).\n\n.. _GPLv3: https://www.gnu.org/licenses/gpl-3.0.en.html\n",
"bugtrack_url": null,
"license": "GPLv2",
"summary": "Openfoam PostProcessing Python Tools",
"version": "0.2.6",
"project_urls": {
"Homepage": "http://legi.grenoble-inp.fr"
},
"split_keywords": [
"openfoam",
" postprocessing",
" python",
" cfd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3c2a5ee7b22555f9c6949a116a4efe8934efe56a544c0b86d89b1cac724f80e",
"md5": "9807b3c71d7438803475c24f6a701a1a",
"sha256": "3197411b09577670a645d4c0e38a27eab4ba31c0a161654c888d6ad76edb23e1"
},
"downloads": -1,
"filename": "fluidfoam-0.2.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9807b3c71d7438803475c24f6a701a1a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 37478,
"upload_time": "2024-04-16T11:34:34",
"upload_time_iso_8601": "2024-04-16T11:34:34.624834Z",
"url": "https://files.pythonhosted.org/packages/d3/c2/a5ee7b22555f9c6949a116a4efe8934efe56a544c0b86d89b1cac724f80e/fluidfoam-0.2.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 11:34:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fluidfoam"
}
JSON