# What it is
The purpose of this library is to support working with the OpenSource
CFD-toolbox [OpenFOAM](http://www.openfoam.org) and its forks
This [Python](http://www.python.org) library can be used to
- analyze the logs produced by OpenFoam-solvers
- execute OpenFoam-solvers and utilities and analyze their output
simultaneously
- manipulate the parameter files and the initial-conditions of a run
in a non-destructive manner
- plots the residuals of OpenFOAM solvers
- lots of other stuff
Most of this functionality is made available to the user in the form
of command-line utilities.
PyFoam does all this strictly "from the outside": by writing parameter
files and reading the output of the solvers. Without compiled parts or
being linked to OpenFOAM.
More information is found on [the OpenFOAM Wiki](http://openfoamwiki.net/index.php/Contrib_PyFoam).
Introductory presentations on PyFoam can be found there
# Installation
The easiest way to install PyFoam is the Python package-manager `pip`:
pip install PyFoam
which will install PyFoam
# License
PyFoam is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version. See the file COPYING in this directory,
for a description of the GNU General Public License terms under which
you can copy the files.
# Contributors
If not otherwise noted in a source-files the primary author is Bernhard Gschaider
The people who contributed to PyFoam (If I forgot someone: tell me):
- Bernhard Gschaider
- Martin Beaudoin
- Fabian Pollesböck
- Etienne Lorriaux
- Bruno Santos
- Marc Immer
- Oliver Borm
# Further reading
These documents give further information
- **ReleaseNotes:** list of the changes between versions (newest
versions are on top).
- **DeveloperNotes:** document with information for people who want to
contribute to `PyFoam`
For information on the usage see the presentations on [the `PyFOAM`
page on the OpenFOAM-Wiki](https://openfoamwiki.net/index.php/Contrib_PyFoam)
# This document
The original source of this document is `README.org`. The
`README.md` (to which the `README` links) is automatically generated
and should **not** be edited. The reason for this setup is that most
Web-GUIs for VCS insist on Markdown as a markup language
Raw data
{
"_id": null,
"home_page": "http://openfoamwiki.net/index.php/Contrib/PyFoam",
"name": "PyFoam",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "cfd openfoam",
"author": "Bernhard F.W. Gschaider",
"author_email": "bgschaid@hfd-research.com",
"download_url": "",
"platform": null,
"description": "# What it is\n\nThe purpose of this library is to support working with the OpenSource\nCFD-toolbox [OpenFOAM](http://www.openfoam.org) and its forks\n\nThis [Python](http://www.python.org) library can be used to\n\n- analyze the logs produced by OpenFoam-solvers\n- execute OpenFoam-solvers and utilities and analyze their output\n simultaneously\n- manipulate the parameter files and the initial-conditions of a run\n in a non-destructive manner\n- plots the residuals of OpenFOAM solvers\n- lots of other stuff\n\nMost of this functionality is made available to the user in the form\nof command-line utilities.\n\nPyFoam does all this strictly \"from the outside\": by writing parameter\nfiles and reading the output of the solvers. Without compiled parts or\nbeing linked to OpenFOAM.\n\nMore information is found on [the OpenFOAM Wiki](http://openfoamwiki.net/index.php/Contrib_PyFoam).\nIntroductory presentations on PyFoam can be found there\n\n\n# Installation\n\nThe easiest way to install PyFoam is the Python package-manager `pip`:\n\n pip install PyFoam\n\nwhich will install PyFoam\n\n\n# License\n\nPyFoam is free software; you can redistribute it and/or modify it\nunder the terms of the GNU General Public License as published by the\nFree Software Foundation; either version 2 of the License, or (at your\noption) any later version. See the file COPYING in this directory,\nfor a description of the GNU General Public License terms under which\nyou can copy the files.\n\n\n# Contributors\n\nIf not otherwise noted in a source-files the primary author is Bernhard Gschaider\n\nThe people who contributed to PyFoam (If I forgot someone: tell me):\n\n- Bernhard Gschaider\n- Martin Beaudoin\n- Fabian Pollesb\u00f6ck\n- Etienne Lorriaux\n- Bruno Santos\n- Marc Immer\n- Oliver Borm\n\n\n# Further reading\n\nThese documents give further information\n\n- **ReleaseNotes:** list of the changes between versions (newest\n versions are on top).\n- **DeveloperNotes:** document with information for people who want to\n contribute to `PyFoam`\n\nFor information on the usage see the presentations on [the `PyFOAM`\npage on the OpenFOAM-Wiki](https://openfoamwiki.net/index.php/Contrib_PyFoam)\n\n\n# This document\n\nThe original source of this document is `README.org`. The\n`README.md` (to which the `README` links) is automatically generated\nand should **not** be edited. The reason for this setup is that most\nWeb-GUIs for VCS insist on Markdown as a markup language\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Python Utilities for OpenFOAM",
"version": "2023.7",
"project_urls": {
"Homepage": "http://openfoamwiki.net/index.php/Contrib/PyFoam"
},
"split_keywords": [
"cfd",
"openfoam"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e804ab62021ebbc7d25f90f34c998f6c72d9b43f196c832b6f21b2098023596e",
"md5": "0f80edff0af3c5e174f881b62c4312d2",
"sha256": "a8b08cee19f0a83f8eb9397638139f310597d7a5bcf4505ab63a0697f60d1456"
},
"downloads": -1,
"filename": "PyFoam-2023.7-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f80edff0af3c5e174f881b62c4312d2",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 697216,
"upload_time": "2023-07-10T10:48:38",
"upload_time_iso_8601": "2023-07-10T10:48:38.483561Z",
"url": "https://files.pythonhosted.org/packages/e8/04/ab62021ebbc7d25f90f34c998f6c72d9b43f196c832b6f21b2098023596e/PyFoam-2023.7-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-10 10:48:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyfoam"
}
JSON