pyopmspe11#

A Python framework using OPM Flow for the SPE11 benchmark project.

pyopmspe11 generates simulation decks, runs OPM Flow, writes benchmark CSV files, and creates figures for SPE11A, SPE11B, and SPE11C.

Get started

Learn the main workflows and choose where to begin.

Introduction
Install

Install the Python package, OPM Flow, and visualization tools.

Installation
Configure a case

Define the model, grid, properties, wells, and injection schedule.

Configuration reference
Follow the tutorial

Progress from deck generation to benchmark data, plots, and comparisons.

Tutorial

Quick installation#

Install the current development version:

pip install git+https://github.com/OPM/pyopmspe11.git

See Installation for virtual environments, OPM Flow, ResInsight, plopm, optional LaTeX support, and installation from source.

Quick start#

Generate an SPE11B deck, run OPM Flow, and write benchmark data:

pyopmspe11 -i examples/spe11b.toml -m deck_flow_data

Generate only the OPM Flow input files directly inside the spe11b folder:

pyopmspe11 -i examples/spe11b.toml -m deck -o spe11b -f 0

Display the available command-line options:

pyopmspe11 --help

See Tutorial for a guided workflow, Examples for focused applications, and Command-line reference for exact syntax, accepted values, defaults, and option compatibility.

What can pyopmspe11 do?#

Generate simulation models

Create Cartesian, tensor, and corner-point grids for SPE11A, SPE11B, and SPE11C.

Run configurable workflows

Generate decks, run OPM Flow, process benchmark data, and create plots independently or as one workflow.

Write benchmark results

Export dense, sparse, performance, and spatial-performance CSV data in the SPE11 reporting format.

Compare simulations

Create benchmark figures, compare model variants, and assess grid refinement and convergence.