From de3d34bab044ec4a9de613c308fd5b9d4542288d Mon Sep 17 00:00:00 2001 From: Simon Rodriguez <66560416+ScimonCFD@users.noreply.github.com> Date: Fri, 20 Sep 2024 14:26:51 +0100 Subject: [PATCH 1/2] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a68f9a1..98cebfb 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ### What is this? ### -This repository contains OpenFOAM code and tutorials that show how to use Python interpreters to interact with OpenFOAM via pythonPal. pythonPal offers Python support and interoperability between the C++/Python data based on the pybind11 library [1]. The code in this repository is based on OpenFOAM-9, however, as noted below, the procedures are expected to compile with similar versions and forks of OpenFOAM. +This repository contains OpenFOAM code and tutorials that show how to use Python interpreters to interact with OpenFOAM via pythonPal4foam (aka pythonPal), as presented by Rodriguez and Cardiff [1]. pythonPal offers Python support and interoperability between the C++/Python data based on the pybind11 library [2]. The code in this repository is based on OpenFOAM-9, however, as noted below, the procedures are expected to compile with similar versions and forks of OpenFOAM. ### How do I get set up? ### @@ -73,5 +73,5 @@ If desired, the user can make the small changes required to get the cases to wor ### References ### - -[1] W. Jakob, J. Rhinelander, and D. Moldovan, “pybind11 – Seamless operability between C++11 and Python.” 2017. \ No newline at end of file +[1] S. A. Rodriguez L. and P. Cardiff, \A general approach for running python codes in openfoam using an embedded pybind11 python interpreter,"OpenFOAM® Journal, vol. 2, p. 166{182, Dec. 2022. [Online]. Available: http://dx.doi.org/10.51560/ofj.v2.79 +[2] W. Jakob, J. Rhinelander, and D. Moldovan, “pybind11 – Seamless operability between C++11 and Python.” 2017. From dd8b766a7b38fc10c2ab235c6d4e453fc3804f67 Mon Sep 17 00:00:00 2001 From: Simon Rodriguez <66560416+ScimonCFD@users.noreply.github.com> Date: Fri, 20 Sep 2024 14:27:36 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 98cebfb..7879b41 100644 --- a/README.md +++ b/README.md @@ -74,4 +74,5 @@ If desired, the user can make the small changes required to get the cases to wor ### References ### [1] S. A. Rodriguez L. and P. Cardiff, \A general approach for running python codes in openfoam using an embedded pybind11 python interpreter,"OpenFOAM® Journal, vol. 2, p. 166{182, Dec. 2022. [Online]. Available: http://dx.doi.org/10.51560/ofj.v2.79 + [2] W. Jakob, J. Rhinelander, and D. Moldovan, “pybind11 – Seamless operability between C++11 and Python.” 2017.