Update README.md

README.md

@@ -17,9 +17,9 @@
 **foamlib** provides a simple, modern, ergonomic and fast Python interface for interacting with [OpenFOAM](https://www.openfoam.com).
 
 <p align="center">
-    <img alt="benchmark" src="https://github.com/gerlero/foamlib/raw/main/benchmark.png" height="250">
+    <img alt="benchmark" src="https://github.com/gerlero/foamlib/raw/main/benchmark/benchmark.png" height="250">
     <br>
-  <i>Parsing a </i>volVectorField<i> with 200k cells.</i>
+  <i>Parsing a </i>volVectorField<i> with 200k cells. [^benchmark]</i>
 </p>
 
 ## 👋 Basics
@@ -154,3 +154,6 @@ case.run()
 ## 📘 Documentation
 
 For more information, check out the [documentation](https://foamlib.readthedocs.io/).
+
+
+[^benchmark]: foamlib 0.8.1 vs PyFoam 2023.7 on a MacBook Air (2020, M1) with 8 GB of RAM. [Benchmark script](benchmark/benchmark.py).

benchmark/benchmark.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+
+import timeit
+
+from foamlib import FoamFieldFile
+from PyFoam.RunDictionary.ParsedParameterFile import ParsedParameterFile
+
+FoamFieldFile("U").internal_field = [[0.0, 0.0, 0.0]] * 200_000
+
+print(f"foamlib: {min(timeit.repeat(lambda: FoamFieldFile("U").internal_field, number=1))} s")
+print(f"PyFoam: {min(timeit.repeat(lambda: ParsedParameterFile("U")["internalField"], number=1))} s")

benchmark/requirements.txt

@@ -0,0 +1,2 @@
+foamlib==0.8.1
+PyFoam==2023.7