Metadata-Version: 2.4
Name: foamnordic
Version: 1.0.0
Summary: Integrated OpenFOAM coupling and computational modelling framework
License-Expression: MIT
Project-URL: Homepage, https://github.com/PentagonToy/FoamNordic
Project-URL: Source, https://github.com/PentagonToy/FoamNordic
Project-URL: Issues, https://github.com/PentagonToy/FoamNordic/issues
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: foamlib<2,>=1.7
Requires-Dist: jinja2
Requires-Dist: numpy
Requires-Dist: onsaemiro>=1.0.3
Requires-Dist: PyYAML>=6
Dynamic: license-file

# FoamNordic

FoamNordic provides Python-driven coupling and external model execution for
OpenFOAM using SmartSim and SmartRedis.

## Installation

FoamNordic requires Python 3.10–3.12.

```bash
pip install foamnordic
```

## Build

Activate your OpenFOAM environment first.

For example:

```bash
module load openfoam
```

Or:

```bash
source /path/to/OpenFOAM/etc/bashrc
```

Then build the FoamNordic runtime and OpenFOAM integration:

```bash
foamnordic build
```

FoamNordic automatically prepares its SmartSim, SmartRedis, Redis, RedisAI,
native SmartRedis, and OpenFOAM integration dependencies.

## Help

Display the general help:

```bash
foamnordic --help
```

Display the build options:

```bash
foamnordic build --help
```

## Python

```python
import foamnordic as fno
```

## Documentation and Development

Source code, development instructions, examples, and detailed documentation
are available on GitHub:

<https://github.com/PentagonToy/FoamNordic>

## License

FoamNordic is distributed under the MIT License.
