README.md

July 10, 2026 ยท View on GitHub

CI OpenFOAM versions Docker Docker image

A simple, extensible reaction model for OpenFOAM.

Installation

With styro

reagency can be installed with the styro package manager:

styro install reagency

Install from source

Requirements

reagency requires OpenFOAM, as distributed by OpenCFD (openfoam.com). Compatible OpenFOAM versions are v2112 and newer.

Versions produced by the OpenFOAM Foundation (openfoam.org) (e.g. OpenFOAM 12, OpenFOAM 13) are not compatible. macOS users may want to consider OpenFOAM.app.

Download

Download the source code of reagency, or clone this repository with Git:

git clone https://github.com/gerlero/reagency.git

Compile

To build and install reagency, just invoke the top-level Allwmake script:

cd reagency
./Allwmake -j

If necessary, activate/source the correct OpenFOAM environment before running Allwmake.

Test

Optionally, you can verify the installation of reagency by running the included test suite (requires Python 3.7 or later):

tests/Alltest