Merge pull request #18 from OFDataCommittee/hotfix

[README] update for new installation

Author: tmaric

README.md

@@ -19,8 +19,8 @@ The source code license: GPL-3.0-or-later
 
 1. [OpenFOAM-v2312] or newer, or a recent [development version][OpenFOAM-git]
    from [OpenFOAM.com][OpenFOAM]. 
-2. [SmartSim] 0.6.0 
-3. [SmartRedis] N.N.N 
+2. [SmartSim] 0.6.2 [installation instructions](https://www.craylabs.org/docs/installation_instructions/basic.html)
+3. [SmartRedis] latest, installed automatically by `./Allwmake`
 4. [PyFoam,pandas,matplotlib]: pip install PyFoam pandas matplotlib
 
 ## Building
@@ -30,22 +30,29 @@ The source code license: GPL-3.0-or-later
 * `WM_COMPILER=Gcc` , compilers: g++ 11.4.0
 * `WM_COMPILER=Icx`, compilers: Intel(R) oneAPI DPC++/C++ Compiler 2023.2.4
 
-### Build script 
+### Compiling and installation 
 
-The OpenFOAM-SmartSim coupling functions over a connection that OpenFOAM as a client maintains with the SmartRedis database. This means that OpenFOAM elements (application, solver, function object, boundary condition, etc.) must be able to include SmartRedis source folders and link with a SmartRedis library. To facilitate this, a Bash script is provided:
+The OpenFOAM-SmartSim coupling functions over a connection that OpenFOAM as a client maintains with the SmartRedis database. This means that OpenFOAM elements (application, solver, function object, boundary condition, etc.) must be able to include SmartRedis source folders and link with a SmartRedis library. To facilitate this, an `./Allrun` Bash script is provided. 
 
-```Bash
-# This will set up your environment, get smartredis, and compile all libs and apps 
-source SOURCEME.sh
+To build the project, you need to have a working OpenFOAM environment: 
+
+```
+openfoam-smartsim > ./Allwmake
 ```
 
-## How to use it
+- This will fetch and compile the latest-n-greatest [SmartRedis](https://github.com/CrayLabs/SmartRedis) for you.
+- SmartRedis libraries will be installed into `$FOAM_USER_LIBBIN`.
+- OpenFOAM+SmartSim libraries and applictaions will also be installed into `$FOAM_USER_LIBBIN`.
+
+## Running 
+
+OpenFOAM+SmartSim workflows are implemented in Python programs where SmartSim "governs" the computational workflow. The workflows can be implemented in Jupyter Notebooks or as Python programs. 
+
+Examples that use Jupyter Notebooks set some requirements: 
 
-- Run `source SOURCEME.sh`
-  - This will fetch latest-n-greatest (and compile) [SmartRedis](https://github.com/CrayLabs/SmartRedis) for you
-  - It will compile the OpenFOAM libs provided in `src` into your `$FOAM_USER_LIBBIN`
 - Make sure port 8000 is free. `ss -plant  | grep 8000` should return nothing!
-- Head to one of the tutorials, and run the python script you find there
+
+Head to one of the tutorials, and run the jupyter notebook or a python program you find there.
 
 ## Authors / Contributors
 
@@ -70,4 +77,4 @@ source SOURCEME.sh
 
 ## References
 
-
+Maric, T., Fadeli, M. E., Rigazzi, A., Shao, A., & Weiner, A. (2024). Combining Machine Learning with Computational Fluid Dynamics using OpenFOAM and SmartSim. arXiv preprint [arXiv:2402.16196](https://doi.org/10.48550/arXiv.2402.16196).