You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,10 +32,10 @@ _Loading a_ volVectorField _with one million cells_<sup>[1](#benchmark)</sup>
32
32
33
33
**foamlib** is a Python package designed to simplify and streamline OpenFOAM workflows. It provides:
34
34
35
-
-**🗄️ Intuitive file handling**: Read and write OpenFOAM configuration and field files as if they were Python objects
36
-
-**⚡ High performance**: Standalone parser supporting both ASCII and binary formats with or without compression
37
-
-**🔄 Async operations**: Run multiple cases in parallel with full[`asyncio`](https://docs.python.org/3/library/asyncio.html)support
38
-
-**🎯 Type safety**: A fully typed API for a better development experience
35
+
-**🗄️ Effortless file handling**: Read and write OpenFOAM configuration and field files via intuitive `dict`-like Python classes
36
+
-**⚡ High performance**: Powered by our _FoamFile_parser with seamless support for both ASCII and binary formats with or without compression
37
+
-**🔄 Async support**: Run exactly as many cases in parallel as your hardware can handle with **foamlib**'s[`asyncio`](https://docs.python.org/3/library/asyncio.html)integration
38
+
-**🎯 Type safety**: A rigorously typed API for the best coding experience
39
39
-**⚙️ Workflow automation**: Reduce boilerplate code for pre/post-processing and simulation management
40
40
-**🧩 Fully compatible**: Works with OpenFOAM from both [openfoam.com](https://www.openfoam.com/) and [openfoam.org](https://www.openfoam.org/)
41
41
- And more!
@@ -47,7 +47,7 @@ Compared to [PyFoam](https://openfoamwiki.net/index.php/Contrib/PyFoam) and othe
47
47
**foamlib** provides these key classes for different aspects of OpenFOAM workflow automation:
48
48
49
49
### 📄 File handling
50
-
***[`FoamFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFile)** - Read and write OpenFOAM configuration files as if they were Python `dict`s
50
+
***[`FoamFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFile)** - Read and edit OpenFOAM configuration files as if they were Python `dict`s
51
51
***[`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFieldFile)** - Handle field files with support for ASCII and binary formats (with or without compression)
52
52
53
53
### 📁 Case management
@@ -259,7 +259,7 @@ You're welcome to contribute to **foamlib**! Check out the [contributing guideli
259
259
260
260
**foamlib** has been published in the [Journal of Open Source Software](https://joss.theoj.org/papers/10.21105/joss.07633)!
261
261
262
-
If you use **foamlib** in your research, please cite our paper:
262
+
If you use **foamlib** in your research, please remember to cite our paper:
263
263
264
264
> Gerlero, G. S., & Kler, P. A. (2025). foamlib: A modern Python package for working with OpenFOAM. *Journal of Open Source Software*, 10(109), 7633. https://doi.org/10.21105/joss.07633
0 commit comments