pyopmspe11

pyopmspe11: A Python framework using OPM Flow for the SPE11 benchmark project - Published in JOSS (2025)

https://github.com/opm/pyopmspe11

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 7 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
✓
Committers with academic emails
1 of 8 committers (12.5%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

co2 csp11 flow opm spe11

Last synced: 6 months ago · JSON representation ·

Repository

A Python framework using OPM Flow for the SPE11 benchmark project

Basic Info

Host: GitHub
Owner: OPM
License: mit
Language: Python
Default Branch: main
Homepage: http://OPM.github.io/pyopmspe11/
Size: 169 MB

Statistics

Stars: 14
Watchers: 4
Forks: 12
Open Issues: 7
Releases: 3

Topics

co2 csp11 flow opm spe11

Created over 2 years ago · Last pushed 7 months ago

Metadata Files

Readme Contributing License Citation

pyopmspe11: A Python framework using OPM Flow for the SPE11 benchmark project

This repository contains scripts to set up a workflow using Python for the three cases in the SPE11 project. Here we use the OPM-Flow simulator.

Installation

You will first need to install * Flow (https://opm-project.org, Release 2025.04 or current master branches)

To install the pyopmspe11 executable from the development version:

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

If you are interested in a specific version (e.g., v2025.04) or in modifying the source code, then you can clone the repository and install the Python requirements in a virtual environment with the following commands:

```bash

Clone the repo

git clone https://github.com/OPM/pyopmspe11.git

Get inside the folder

cd pyopmspe11

For a specific version (e.g., v2025.04), or skip this step (i.e., edge version)

git checkout v2025.04

Create virtual environment (to specific Python, python3.13 -m venv vpyopmspe11)

python3 -m venv vpyopmspe11

Activate virtual environment

source vpyopmspe11/bin/activate

Upgrade pip, setuptools, and wheel

pip install --upgrade pip setuptools wheel

Install the pyopmspe11 package

pip install -e .

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, and macOS, as well as the OPM Python package and LaTeX dependencies.

Running pyopmspe11

You can run pyopmspe11 as a single command line: pyopmspe11 -i configuration_file Run pyopmspe11 --help to see all possible command line argument options. Inside the configuration_file you provide the path to the flow executable and simulation parameters. See the .txt and .toml files in the examples, benchmark, and tests folders.

Getting started

See the examples in the documentation and the journal paper.

Citing

Landa-Marbán, D. and Sandve, T.H. 2025. pyopmspe11: A Python framework using OPM Flow for the SPE11 benchmark project. Journal of Open Source Software, 10(105), 7357, https://doi.org/10.21105/joss.07357.

About pyopmspe11

The pyopmspe11 package is being 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]. Here is the link to the SPE11 details. Contributions are more than welcome using the fork and pull request approach. For a new feature, please request this by raising an issue.

Owner

Name: OPM
Login: OPM
Kind: organization

Website: www.opm-project.org
Repositories: 46
Profile: https://github.com/OPM

JOSS Publication

pyopmspe11: A Python framework using OPM Flow for the SPE11 benchmark project

Published

January 30, 2025

DOI

10.21105/joss.07357

Volume 10, Issue 105, Page 7357

Authors

David Landa-Marbán

NORCE Norwegian Research Centre AS, Bergen, Norway

Tor H. Sandve

NORCE Norwegian Research Centre AS, Bergen, Norway

Editor

Rachel Wegener

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Landa-Marbán
  given-names: David
  orcid: "https://orcid.org/0000-0002-3343-1005"
- family-names: Sandve
  given-names: Tor H.
  orcid: "https://orcid.org/0000-0002-3267-8276"
contact:
- family-names: Landa-Marbán
  given-names: David
  orcid: "https://orcid.org/0000-0002-3343-1005"
doi: 10.6084/m9.figshare.28284845.v1
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Landa-Marbán
    given-names: David
    orcid: "https://orcid.org/0000-0002-3343-1005"
  - family-names: Sandve
    given-names: Tor H.
    orcid: "https://orcid.org/0000-0002-3267-8276"
  date-published: 2025-01-30
  doi: 10.21105/joss.07357
  issn: 2475-9066
  issue: 105
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 7357
  title: "pyopmspe11: A Python framework using OPM Flow for the SPE11
    benchmark project"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.07357"
  volume: 10
title: "pyopmspe11: A Python framework using OPM Flow for the SPE11
  benchmark project"

GitHub Events

Total

Create event: 3
Release event: 3
Issues event: 18
Watch event: 6
Member event: 1
Issue comment event: 31
Push event: 29
Pull request review event: 4
Pull request review comment event: 6
Pull request event: 63
Fork event: 5

Last Year

Create event: 3
Release event: 3
Issues event: 18
Watch event: 6
Member event: 1
Issue comment event: 31
Push event: 29
Pull request review event: 4
Pull request review comment event: 6
Pull request event: 63
Fork event: 5

Committers

Last synced: 7 months ago

All Time

Total Commits: 116
Total Committers: 8
Avg Commits per committer: 14.5
Development Distribution Score (DDS): 0.121

Past Year

Commits: 49
Committers: 7
Avg Commits per committer: 7.0
Development Distribution Score (DDS): 0.122

Top Committers

Name	Email	Commits
David Landa Marban	d**r@n**o	102
Tor Harald Sandve	t**a@n**o	5
jfranc	j**c@s**u	3
jakobtorben	J**n@s**o	2
Rene Gassmoeller	r**r@m**g	1
Rachel Wegener	r**r@g**m	1
Olav Møyner	o**r@g**m	1
FahadsNest	f**u@g**m	1

Committer Domains (Top 20 + Academic)

norceresearch.no: 2 mailbox.org: 1 sintef.no: 1 stanford.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 14
Total pull requests: 125
Average time to close issues: about 2 months
Average time to close pull requests: 1 day
Total issue authors: 6
Total pull request authors: 8
Average comments per issue: 1.93
Average comments per pull request: 0.08
Merged pull requests: 119
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 10
Pull requests: 56
Average time to close issues: about 2 months
Average time to close pull requests: 1 day
Issue authors: 2
Pull request authors: 5
Average comments per issue: 1.9
Average comments per pull request: 0.07
Merged pull requests: 51
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

MatthewFlamm (7)
gassmoeller (5)
daavid00 (2)
ZhenQin-USC (1)
Pascapone (1)
rabiu42000 (1)
Dhrubo2625 (1)

Pull Request Authors

daavid00 (164)
totto82 (6)
gassmoeller (4)
jakobtorben (4)
rwegener2 (2)
jafranc (2)
fahadsNest (2)
moyner (2)

pyopmspe11

Science Score: 100.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

pyopmspe11: A Python framework using OPM Flow for the SPE11 benchmark project

Installation

Clone the repo

Get inside the folder

For a specific version (e.g., v2025.04), or skip this step (i.e., edge version)

Create virtual environment (to specific Python, python3.13 -m venv vpyopmspe11)

Activate virtual environment

Upgrade pip, setuptools, and wheel

Install the pyopmspe11 package

For contributions/testing/linting, install the dev-requirements

Running pyopmspe11

Getting started

Citing

About pyopmspe11

Owner

JOSS Publication

pyopmspe11: A Python framework using OPM Flow for the SPE11 benchmark project

Authors

Editor

Tags

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels