Skip to content

cssr-tools/pofff

Repository files navigation

Build Status Code style License: GPL v3

pofff: An open-source image-based history-matching framework for the FluidFlower Benchmark study using OPM Flow

This repository contains runscripts to simulate CO2 injection in the fluidflower benchmark system using the OPM Flow simulator and perform history matching studies using the ensemble reservoir simulation tool ERT or everest.

Installation

You will first need to install

To install the pofff executable from the development version, and companion libraries:

pip install git+https://github.com/cssr-tools/pofff.git
pip install git+https://github.com/equinor/everest.git
pip install opm # For macOS users, this will not work, then follow the steps in the docs

If you are interested in modifying the source code, then you can clone the repository and install the Python requirements in a virtual environment with the following commands:

# Clone the repo
git clone https://github.com/cssr-tools/pofff.git
# Get inside the folder
cd pofff
# Create virtual environment
python3 -m venv vpofff
# Activate virtual environment
source vpofff/bin/activate
# Upgrade pip, setuptools, and wheel
pip install --upgrade pip setuptools wheel
# Install the pofff package
pip install -e .
# Third party companions
pip install git+https://github.com/equinor/everest.git
# For macOS users, this will not work, then skip this and follow the steps in the docs
pip install opm
# For contributions/testing/linting, install the dev-requirements
pip install -r dev-requirements.txt

See the installation for further details on building OPM Flow from the master branches in Linux, Windows (via WSL), and macOS, as well as the opm Python package.

Running pofff

You can run pofff as a single command line:

pofff -i name_of_input_file.toml

Run pofff --help to see all possible command line argument options.

Getting started

See the examples in the documentation.

Citing

If you use pofff in your research, please cite the following publication:

Landa-Marbán, D., Sandve, T.H., Both, J.W., Nordbotten, J.M., and Gasda, S.E., 2025. Performance of an open-source image-based history matching framework for CO2 storage. https://arxiv.org/abs/2510.20614.

About pofff

The pofff package is funded by the HPC Simulation Software for the Gigatonne Storage Challenge project [project number 622059] and Center for Sustainable Subsurface Resources (CSSR) [project no. 331841]. Contributions are more than welcome using the fork and pull request approach. For a new feature, please request this by raising an issue.

About

An open-source image-based history-matching framework for the FluidFlower Benchmark study using OPM Flow

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published