Skip to content

Commit 95d6b87

Browse files
committed
Retiring resdata, introducing pofff, and OPM Flow 2025.10
1 parent e816769 commit 95d6b87

85 files changed

Lines changed: 344 additions & 724 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/CI.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444
4545
- name: Install pyopmspe11
4646
run: |
47-
pip install .[opm]
47+
pip install .
4848
4949
- name: Check code style and linting
5050
run: |

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,4 +182,4 @@ examples/spe11b_tensor_grid
182182
tests/configs/check_format.py
183183
tests/configs/is_notebook.py
184184
**/tests/configs/*/
185-
**/tests/decks/*/
185+
**/tests/decks/*/

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ Contributions are more than welcome using the fork and pull request approach
99
- We document our code
1010

1111
## Contribute to the software
12-
This requires a Python version of at least 3.11 (due to [_tomllib_](https://toml.io/en/)).
1312

1413
1. Work on your own fork of the main repo
1514
1. In the main repo execute:
16-
1. **pip install -r dev-requirements.txt** (this installs the [_dev-requirements.txt_](https://github.com/cssr-tools/pyopmspe11/blob/main/dev-requirements.txt); in addition, both opm Python and LaTeX are required, then for not macOs users run **pip install opm** and **sudo apt-get install texlive-fonts-recommended texlive-fonts-extra dvipng cm-super**, or else follow the instructions in [_macOS installation_](https://cssr-tools.github.io/pyopmspe11/installation.html#source-build-in-macos))
15+
1. **pip install -r dev-requirements.txt** (this installs the [_dev-requirements.txt_](https://github.com/cssr-tools/pyopmspe11/blob/main/dev-requirements.txt); in addition, LaTeX is required, then for not macOs users run **sudo apt-get install texlive-fonts-recommended texlive-fonts-extra dvipng cm-super**, or else follow the instructions in [_macOS installation_](https://cssr-tools.github.io/pyopmspe11/installation.html#source-build-in-macos))
1716
1. **black src/ tests/** (this formats the code)
1817
1. **pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
1918
1. **mypy --ignore-missing-imports src/ tests/** (this is a static checker, and might rise issues that need to be fixed before the pull request)
2019
1. **pytest --cov=pyopmspe11 --cov-report term-missing tests/** (this runs locally the tests in ca. 30 minutes, and might rise issues that need to be fixed before the pull request)
2120
1. **pushd docs & make html** (this generates the documentation, and might rise issues that need to be fixed before the pull request; if the build succeeds and if the contribution changes the documentation, then delete all content from the [_docs_](https://github.com/cssr-tools/pyopmspe11/tree/main/docs) folder except [_Makefile_](https://github.com/OPM/pyopmspe11/blob/main/docs/Makefile), [_text_](https://github.com/OPM/pyopmspe11/blob/main/docs/text), and [_.nojekyll_](https://github.com/OPM/pyopmspe11/blob/main/docs/.nojekyll), after copy all contents from the docs/_build/html/ folder, and finally paste them in the [_docs_](https://github.com/cssr-tools/pyopmspe11/tree/main/docs) folder)
22-
* Tip: See the [_CI.yml_](https://github.com/cssr-tools/pyopmspe11/blob/main/.github/workflows/CI.yml) script and the [_Actions_](https://github.com/cssr-tools/pyopmspe11/actions) for installation of pyopmspe11, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.10 using Python3.11.
21+
* Tip for Linux users: See the [_CI.yml_](https://github.com/cssr-tools/pyopmspe11/blob/main/.github/workflows/CI.yml) script and the [_Actions_](https://github.com/cssr-tools/pyopmspe11/actions) for installation of pyopmspe11, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.11.
22+
* Tip for macOS users: See the [_ci_pycopm_macos_.yml_](https://github.com/daavid00/OPM-Flow_macOS/blob/main/.github/workflows/ci_pycopm_macos.yml) script and the [_OPM-Flow_macOS Actions_](https://github.com/cssr-tools/pycopm/actions) for installation of pycopm (a related tool to pyopmspe11), OPM Flow (source build), and dependencies in macOS 26 using Python 3.13. In addition, you need to add the directory containing the OPM Flow executable to your system's PATH environment variable (e.g., export PATH=$PATH:/Users/yourname/pyopmspe11/build/opm-simulators/bin).
2323
1. Squash your commits into a single commit (see this [_nice tutorial_](https://gist.github.com/lpranam/4ae996b0a4bc37448dc80356efbca7fa) if you are not familiar with this)
2424
1. Push your commit and make a pull request
2525
1. The maintainers will review the pull request, and if the contribution is accepted, then it will be merge to the main repo
@@ -33,4 +33,4 @@ This requires a Python version of at least 3.11 (due to [_tomllib_](https://toml
3333

3434
1. The preferred approach to seek support is to raise an issue as described in the previous lines.
3535
1. We will try to answer as soon as possible, but also any user is more than welcome to answer.
36-
- An alternative approach is to send an email to any of the [_mantainers_](https://github.com/cssr-tools/pyopmspe11/blob/main/pyproject.toml).
36+
- An alternative approach is to send an email to any of the [_mantainers_](https://github.com/cssr-tools/pyopmspe11/blob/main/pyproject.toml).

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ include src/pyopmspe11/templates/co2/*
55
include src/pyopmspe11/templates/common/*
66
include src/pyopmspe11/templates/reference_mesh/*
77
include src/pyopmspe11/utils/*
8-
include src/pyopmspe11/visualization/*
8+
include src/pyopmspe11/visualization/*

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[![Build Status](https://github.com/OPM/pyopmspe11/actions/workflows/CI.yml/badge.svg)](https://github.com/OPM/pyopmspe11/actions/workflows/CI.yml)
2-
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.9%20to%203.13-blue.svg"></a>
2+
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.11%20to%203.14-blue.svg"></a>
33
[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
44
[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](https://opensource.org/license/mit/)
55
[![DOI](https://joss.theoj.org/papers/10.21105/joss.07357/status.svg)](https://doi.org/10.21105/joss.07357)
@@ -13,7 +13,7 @@ Here we use the [_OPM-Flow_](https://opm-project.org/?page_id=19) simulator.
1313

1414
## Installation
1515
You will first need to install
16-
* Flow (https://opm-project.org, Release 2025.04 or current master branches)
16+
* Flow (https://opm-project.org, Release 2025.10 or current master branches)
1717

1818
To install the _pyopmspe11_ executable from the development version:
1919

@@ -30,7 +30,7 @@ git clone https://github.com/OPM/pyopmspe11.git
3030
cd pyopmspe11
3131
# For a specific version (e.g., v2025.04), or skip this step (i.e., edge version)
3232
git checkout v2025.04
33-
# Create virtual environment (to specific Python, python3.13 -m venv vpyopmspe11)
33+
# Create virtual environment (to specific Python, python3.14 -m venv vpyopmspe11)
3434
python3 -m venv vpyopmspe11
3535
# Activate virtual environment
3636
source vpyopmspe11/bin/activate
@@ -42,7 +42,7 @@ pip install -e .
4242
pip install -r dev-requirements.txt
4343
```
4444

45-
See the [_installation_](https://OPM.github.io/pyopmspe11/installation.html) 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.
45+
See the [_installation_](https://OPM.github.io/pyopmspe11/installation.html) for further details on building OPM Flow from the master branches in Linux, Windows (via [_WSL_](https://learn.microsoft.com/en-us/windows/wsl/)), and macOS, as well as the LaTeX (optional) dependency.
4646

4747
## Running pyopmspe11
4848
You can run _pyopmspe11_ as a single command line:
@@ -64,4 +64,4 @@ The pyopmspe11 package is being funded by the [_HPC Simulation Software for the
6464
[project no. 331841].
6565
[_Here_](https://www.spe.org/en/csp/) is the link to the SPE11 details.
6666
Contributions are more than welcome using the fork and pull request approach.
67-
For a new feature, please request this by raising an issue.
67+
For a new feature, please request this by raising an issue.

benchmark/spe11a/r1_Cart_1cm.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""Set the full path to the flow executable and flags"""
2-
mpirun -np 32 flow --partition-method=2 --edge-weights-method=2 --imbalance-tol=1.1 --nonlinear-solver=nldd --matrix-add-well-contributions=1 --linear-solver=cpr_trueimpes --solver-max-time-step-in-days=0.02 --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations --newton-min-iterations=1 --time-step-control-target-newton-iterations=2 --time-step-control-growth-rate=1.15 --time-step-control-decay-rate=0.85 --newton-max-iterations=6 --relaxed-max-pv-fraction=0 --min-strict-cnv-iter=8 --tolerance-cnv-relaxed=1e-2 --tolerance-cnv=1e-3 --local-domains-ordering-measure=residual --time-step-control=newtoniterationcount --use-update-stabilization=0 --max-local-solve-iterations=50 --linear-solver-max-iter=50
2+
mpirun -np 32 flow --partition-method=metis --edge-weights-method=logtrans --imbalance-tol=1.1 --nonlinear-solver=nldd --matrix-add-well-contributions=1 --linear-solver=cpr_trueimpes --solver-max-time-step-in-days=0.02 --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations --newton-min-iterations=1 --time-step-control-target-newton-iterations=2 --time-step-control-growth-rate=1.15 --time-step-control-decay-rate=0.85 --newton-max-iterations=6 --relaxed-max-pv-fraction=0 --min-strict-cnv-iter=8 --tolerance-cnv-relaxed=1e-2 --tolerance-cnv=1e-3 --local-domains-ordering-measure=residual --time-step-control=newtoniterationcount --use-update-stabilization=0 --max-local-solve-iterations=50 --linear-solver-max-iter=50
33

44
"""Set the model parameters"""
55
spe11a master #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)

benchmark/spe11a/r2_Cart_1cm_capmax2500Pa.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""Set the full path to the flow executable and flags"""
2-
mpirun -np 32 flow --partition-method=2 --edge-weights-method=2 --imbalance-tol=1.1 --nonlinear-solver=nldd --matrix-add-well-contributions=1 --linear-solver=cpr_trueimpes --solver-max-time-step-in-days=0.02 --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations --newton-min-iterations=1 --time-step-control-target-newton-iterations=2 --time-step-control-growth-rate=1.15 --time-step-control-decay-rate=0.85 --newton-max-iterations=6 --relaxed-max-pv-fraction=0 --min-strict-cnv-iter=8 --tolerance-cnv-relaxed=1e-2 --tolerance-cnv=1e-3 --local-domains-ordering-measure=residual --time-step-control=newtoniterationcount --use-update-stabilization=0 --max-local-solve-iterations=50 --linear-solver-max-iter=50
2+
mpirun -np 32 flow --partition-method=metis --edge-weights-method=logtrans --imbalance-tol=1.1 --nonlinear-solver=nldd --matrix-add-well-contributions=1 --linear-solver=cpr_trueimpes --solver-max-time-step-in-days=0.02 --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations --newton-min-iterations=1 --time-step-control-target-newton-iterations=2 --time-step-control-growth-rate=1.15 --time-step-control-decay-rate=0.85 --newton-max-iterations=6 --relaxed-max-pv-fraction=0 --min-strict-cnv-iter=8 --tolerance-cnv-relaxed=1e-2 --tolerance-cnv=1e-3 --local-domains-ordering-measure=residual --time-step-control=newtoniterationcount --use-update-stabilization=0 --max-local-solve-iterations=50 --linear-solver-max-iter=50
33

44
"""Set the model parameters"""
55
spe11a master #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)

benchmark/spe11a/r3_cp_1cmish_capmax2500Pa.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""Set the full path to the flow executable and flags"""
2-
mpirun -np 32 flow --partition-method=2 --edge-weights-method=2 --imbalance-tol=1.1 --min-strict-cnv-iter=5 --tolerance-cnv-relaxed=1e-2 --tolerance-cnv=1e-3 --newton-min-iterations=1 --enable-tuning=true --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations
2+
mpirun -np 32 flow --partition-method=metis --edge-weights-method=logtrans --imbalance-tol=1.1 --min-strict-cnv-iter=5 --tolerance-cnv-relaxed=1e-2 --tolerance-cnv=1e-3 --newton-min-iterations=1 --enable-tuning=true --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations
33

44
"""Set the model parameters"""
55
spe11a master #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)

benchmark/spe11a/r4_Cart_1mm_capmax2500Pa.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""Set the full path to the flow executable and flags"""
2-
mpirun -np 70 flow --partition-method=2 --edge-weights-method=2 --imbalance-tol=1.1 --newton-min-iterations=1 --enable-tuning=true --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations
2+
mpirun -np 70 flow --partition-method=metis --edge-weights-method=logtrans --imbalance-tol=1.1 --newton-min-iterations=1 --enable-tuning=true --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations
33

44
"""Set the model parameters"""
55
spe11a master #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)

benchmark/spe11a/r5_Cart_1mm_capmax2500Pa_strictol.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""Set the full path to the flow executable and flags"""
2-
mpirun -np 32 flow --partition-method=2 --edge-weights-method=2 --imbalance-tol=1.1 --nonlinear-solver=nldd --matrix-add-well-contributions=1 --linear-solver=cpr_trueimpes --solver-max-time-step-in-days=0.02 --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations --newton-min-iterations=1 --time-step-control-target-newton-iterations=2 --time-step-control-growth-rate=1.15 --time-step-control-decay-rate=0.85 --newton-max-iterations=6 --relaxed-max-pv-fraction=0 --min-strict-cnv-iter=8 --tolerance-cnv-relaxed=1e-2 --tolerance-cnv=1e-3 --local-domains-ordering-measure=residual --time-step-control=newtoniterationcount --use-update-stabilization=0 --max-local-solve-iterations=50 --linear-solver-max-iter=50
2+
mpirun -np 32 flow --partition-method=metis --edge-weights-method=logtrans --imbalance-tol=1.1 --nonlinear-solver=nldd --matrix-add-well-contributions=1 --linear-solver=cpr_trueimpes --solver-max-time-step-in-days=0.02 --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations --newton-min-iterations=1 --time-step-control-target-newton-iterations=2 --time-step-control-growth-rate=1.15 --time-step-control-decay-rate=0.85 --newton-max-iterations=6 --relaxed-max-pv-fraction=0 --min-strict-cnv-iter=8 --tolerance-cnv-relaxed=1e-2 --tolerance-cnv=1e-3 --local-domains-ordering-measure=residual --time-step-control=newtoniterationcount --use-update-stabilization=0 --max-local-solve-iterations=50 --linear-solver-max-iter=50
33

44
"""Set the model parameters"""
55
spe11a master #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)

0 commit comments

Comments
 (0)