Metadata-Version: 2.1
Name: fluidsimfoam
Version: 0.0.1
Summary: Python framework for OpenFOAM
License: BSD-3-Clause
Author: pierre.augier
Author-email: pierre.augier@univ-grenoble-alpes.fr
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: fluiddyn (>=0.5.2,<0.6.0)
Requires-Dist: fluidsim-core (>=0.7.2,<0.8.0)
Requires-Dist: inflection (>=0.5.1,<0.6.0)
Requires-Dist: ipython (>=8.11.0,<9.0.0)
Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
Requires-Dist: pandas (>=1.5.3,<2.0.0)
Description-Content-Type: text/markdown

# Fluidsimfoam

<!-- badges -->

Python framework for [OpenFOAM]

Fluidsimfoam is a Python package which **will** allow one to write [Fluidsim]
solvers based for the simulations on the C++ CFD code [OpenFOAM]. There
**will** be open-source solvers (in particular fluidsimfoam-phill and
fluidsimfoam-tgv) and it **will** not be difficult to write your own solver
based on your [OpenFOAM] cases.

With a Fluidsimfoam solver, it **will** becomes very easy to

- launch/restart simulations with Python scripts and terminal commands,
- load simulations, read the associated parameters/data and produce nice figures/movies.

Fluidsimfoam can be seen as a workflow manager for [OpenFOAM] or a Python
wrapper around [OpenFOAM]. It uses [OpenFOAM] on the background and is thus NOT
a rewrite of [OpenFOAM]!

Fluidsimfoam is now in very early development. The goal is to get the
equivalent of [Snek5000], our Fluidsim framework for [Nek5000].

## Related projects

- [PyFoam] ([PyPI package](https://pypi.org/project/PyFoam/),
  [hg repo](http://hg.code.sf.net/p/openfoam-extend/PyFoam)) Python utilities for
  OpenFOAM. GNU GPL. Still maintained. Should be used by Fluidsimfoam.

- [Fluidfoam] Another Fluiddyn package (like Fluidsimfoam) to use/plot OpenFOAM
  data. Will be used by Fluidsimfoam.

- [PythonFlu] ([wiki](https://openfoamwiki.net/index.php/Contrib_pythonFlu))

- [Swak4Foam]

[PyFoam]: https://openfoamwiki.net/index.php/Contrib/PyFoam
[fluidsim]: https://fluidsim.readthedocs.io
[fluidfoam]: https://fluidfoam.readthedocs.io
[openfoam]: https://openfoam.org/
[nek5000]: https://nek5000.mcs.anl.gov/
[snek5000]: https://snek5000.readthedocs.io
[PythonFlu]: http://pythonflu.wikidot.com/
[Swak4Foam]: https://openfoamwiki.net/index.php/Contrib/swak4Foam

