Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ jobs:

- name: Run the tests
run: |
pytest tests/ --cov=pofff --exitfirst --cov-report term-missing --basetemp=test_outputs
pytest --cov=pofff --exitfirst --cov-report term-missing --basetemp=test_outputs tests/

- name: Build documentation
run: |
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Contributions are more than welcome using the fork and pull request approach
1. **pylint src/ tests/ publication/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
1. **ruff check src/ tests/ publication/** (this also analyses the code, and might rise issues that need to be fixed before the pull request)
1. **mypy --ignore-missing-imports src/ tests/ publication/** (this is a static checker, and might rise issues that need to be fixed before the pull request)
1. **pytest tests/ --cov=pofff --exitfirst --cov-report term-missing --basetemp=test_outputs** (this runs locally the tests, and might rise issues that need to be fixed before the pull request)
1. **pytest --cov=pofff --cov-report term-missing --basetemp=test_outputs tests/ -n auto** (this runs locally the tests, and might rise issues that need to be fixed before the pull request)
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/pofff/tree/main/docs) folder except [_Makefile_](https://github.com/OPM/pofff/blob/main/docs/Makefile), [_text_](https://github.com/OPM/pofff/blob/main/docs/text), and [_.nojekyll_](https://github.com/OPM/pofff/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/pofff/tree/main/docs) folder)
* Tip for Linux users: See the [_CI.yml_](https://github.com/cssr-tools/pofff/blob/main/.github/workflows/CI.yml) script and the [_Actions_](https://github.com/cssr-tools/pofff/actions) for installation of pofff, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.12.
* 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 pofff), OPM Flow (source build), and dependencies, as well as running the tests in macOS 26 using Python 3.13. Note that to run the pofff tests, you have to add the directory containing the OPM Flow executable to your system's PATH environment variable (e.g., export PATH=$PATH:/path/to/opm-flow); you can check if this worked by after typing in the terminal 'flow \-\-help'.
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![Build Status](https://github.com/cssr-tools/pofff/actions/workflows/CI.yml/badge.svg)](https://github.com/cssr-tools/pofff/actions/workflows/CI.yml)
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.12%20to%203.13-blue.svg"></a>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.12%20to%203.14-blue.svg"></a>
[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

Expand All @@ -19,23 +19,23 @@ OPM simulations.

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

To install the _pofff_ executable from the development version:

```bash
pip install git+https://github.com/cssr-tools/pofff.git
```

If you are interested in a specific version (e.g., v2025.10) 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:
If you are interested in a specific version (e.g., v2026.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/cssr-tools/pofff.git
# Get inside the folder
cd pofff
# For a specific version (e.g., v2025.10), or skip this step (i.e., edge version)
git checkout v2025.10
# For a specific version (e.g., v2026.04), or skip this step (i.e., edge version)
git checkout v2026.04
# Create virtual environment (to specific Python, python3.13 -m venv vpofff)
python3 -m venv vpofff
# Activate virtual environment
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

We only provide security updates for the following versions:

* **Version 2025.10** (Current Stable)
* **Version 2026.04** (Current Stable)

## Reporting a Vulnerability

Expand Down
17 changes: 9 additions & 8 deletions dev-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
black
mypy
pylint
pytest-cov
ruff
sphinx
sphinx-rtd-theme
sphinxcontrib-video
black<=26.5.1
mypy<=2.1.0
pylint<=4.0.5
pytest-cov<=7.1.0
pytest-xdist<=3.8.0
ruff<=0.15.14
sphinx<=9.1.0
sphinx-rtd-theme<=3.1.0
sphinxcontrib-video<=0.4.2
Binary file modified docs/_images/content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/pofff+plopm_xco2l.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/_sources/contributing.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ Contribute to the software
#. **pylint src/ tests/ publication/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
#. **ruff check src/ tests/ publication/** (this also analyses the code, and might rise issues that need to be fixed before the pull request)
#. **mypy \-\-ignore-missing-imports src/ tests/** (this is a static checker, and might rise issues that need to be fixed before the pull request)
#. **pytest tests/ \-\-cov=pofff \-\-exitfirst \-\-cov-report term-missing \-\-basetemp=test_outputs** (this runs locally the tests, and might rise issues that need to be fixed before the pull request)
#. **pytest \-\-cov=pofff \-\-cov-report term-missing \-\-basetemp=test_outputs tests/ -n auto** (this runs locally the tests, and might rise issues that need to be fixed before the pull request)
#. **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 copy all content from the docs/_build/html/ folder and replace the files in the `docs <https://github.com/cssr-tools/pofff/tree/main/docs>`_ folder)

.. tip::
See the `CI.yml <https://github.com/cssr-tools/pofff/blob/main/.github/workflows/CI.yml>`_ script and the `Actions <https://github.com/cssr-tools/pofff/actions>`_ for installation of pofff, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.12.
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 pofff), OPM Flow (source build), and dependencies in macOS 26 using Python 3.13.
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 pofff), OPM Flow (source build), and dependencies in macOS 26 using Python 3.14.
In addition for macOS, 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/pofff/build/opm-simulators/bin).

#. Squash your commits into a single commit (see this `nice tutorial <https://gist.github.com/lpranam/4ae996b0a4bc37448dc80356efbca7fa>`_ if you are not familiar with this)
Expand Down
2 changes: 1 addition & 1 deletion docs/_sources/examples.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Then the following GIF is generated by:

.. code-block:: bash

pofff -i appendixb.toml -o plopm+pofff -m single -c '5e-2' -f none
pofff -i appendixb.toml -o pofff+plopm -m single -c '5e-2' -f none
plopm -v xco2l -i 'pofff+plopm/POFFF+PLOPM' -d 16,5 -mask satnum -m gif -dpi 1000 -f 20 -loop 1 -cformat .1e -cbsfax 0.30,0.01,0.4,0.02 -interval 437.5 -maskthr 1e-5 -tunits h -cnum 5 -clabel 'CO$_2$ mass fraction in liquid [-]' -t 'FluidFlower simulation (GitHub/cssr-tools/pofff),'

.. figure:: figs/pofff+plopm_xco2l.gif
Expand Down
13 changes: 6 additions & 7 deletions docs/_sources/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@ Installation
============

The following steps work installing the dependencies in Linux via apt-get or in macOS using brew or macports.
While using package managers such as Anaconda, Miniforge, or Mamba might work, these are not tested. We will
update the documentation when Python 3.14 is supported (e.g., the ert Python package is not yet available
via pip install in Python 3.14).
While using package managers such as Anaconda, Miniforge, or Mamba might work, these are not tested. The
supported Python versions are 3.12 to 3.14.

`ResInsight <https://resinsight.org>`_ and `plopm <https://github.com/cssr-tools/plopm>`_ can be used for the visualization of the results.

Expand Down Expand Up @@ -36,7 +35,7 @@ To install the **pofff** executable from the development version:

pip install git+https://github.com/cssr-tools/pofff.git

If you are interested in a specific version (e.g., v2025.10) or in modifying the source code, then you can clone the repository and
If you are interested in a specific version (e.g., v2026.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:

.. code-block:: console
Expand All @@ -45,8 +44,8 @@ install the Python requirements in a virtual environment with the following comm
git clone https://github.com/cssr-tools/pofff.git
# Get inside the folder
cd pofff
# For a specific version (e.g., v2025.10), or skip this step (i.e., edge version)
git checkout v2025.10
# For a specific version (e.g., v2026.04), or skip this step (i.e., edge version)
git checkout v2026.04
# Create virtual environment (to specific Python, python3.12 -m venv vpofff)
python3 -m venv vpofff
# Activate virtual environment
Expand Down Expand Up @@ -76,7 +75,7 @@ OPM Flow
--------
You also need to install:

* OPM Flow (https://opm-project.org, Release 2025.10 or current master branches)
* OPM Flow (https://opm-project.org, Release 2026.04 or current master branches)

Binary packages
+++++++++++++++
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,13 @@ <h2>Contribute to the software<a class="headerlink" href="#contribute-to-the-sof
<li><p><strong>pylint src/ tests/ publication/</strong> (this analyses the code, and might rise issues that need to be fixed before the pull request)</p></li>
<li><p><strong>ruff check src/ tests/ publication/</strong> (this also analyses the code, and might rise issues that need to be fixed before the pull request)</p></li>
<li><p><strong>mypy --ignore-missing-imports src/ tests/</strong> (this is a static checker, and might rise issues that need to be fixed before the pull request)</p></li>
<li><p><strong>pytest tests/ --cov=pofff --exitfirst --cov-report term-missing --basetemp=test_outputs</strong> (this runs locally the tests, and might rise issues that need to be fixed before the pull request)</p></li>
<li><p><strong>pytest --cov=pofff --cov-report term-missing --basetemp=test_outputs tests/ -n auto</strong> (this runs locally the tests, and might rise issues that need to be fixed before the pull request)</p></li>
<li><p><strong>pushd docs &amp; make html</strong> (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 copy all content from the docs/_build/html/ folder and replace the files in the <a class="reference external" href="https://github.com/cssr-tools/pofff/tree/main/docs">docs</a> folder)</p></li>
</ol>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>See the <a class="reference external" href="https://github.com/cssr-tools/pofff/blob/main/.github/workflows/CI.yml">CI.yml</a> script and the <a class="reference external" href="https://github.com/cssr-tools/pofff/actions">Actions</a> for installation of pofff, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.12.
For macOS users, see the <a class="reference external" href="https://github.com/daavid00/OPM-Flow_macOS/blob/main/.github/workflows/ci_pycopm_macos.yml">ci_pycopm_macos.yml</a> script and the <a class="reference external" href="https://github.com/cssr-tools/pycopm/actions">OPM-Flow_macOS Actions</a> for installation of pycopm (a related tool to pofff), OPM Flow (source build), and dependencies in macOS 26 using Python 3.13.
For macOS users, see the <a class="reference external" href="https://github.com/daavid00/OPM-Flow_macOS/blob/main/.github/workflows/ci_pycopm_macos.yml">ci_pycopm_macos.yml</a> script and the <a class="reference external" href="https://github.com/cssr-tools/pycopm/actions">OPM-Flow_macOS Actions</a> for installation of pycopm (a related tool to pofff), OPM Flow (source build), and dependencies in macOS 26 using Python 3.14.
In addition for macOS, 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/pofff/build/opm-simulators/bin).</p>
</div>
</div></blockquote>
Expand Down
2 changes: 1 addition & 1 deletion docs/examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ <h2>Visualization<a class="headerlink" href="#visualization" title="Link to this
</div>
<p>Then the following GIF is generated by:</p>
<blockquote>
<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pofff<span class="w"> </span>-i<span class="w"> </span>appendixb.toml<span class="w"> </span>-o<span class="w"> </span>plopm+pofff<span class="w"> </span>-m<span class="w"> </span>single<span class="w"> </span>-c<span class="w"> </span><span class="s1">&#39;5e-2&#39;</span><span class="w"> </span>-f<span class="w"> </span>none
<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pofff<span class="w"> </span>-i<span class="w"> </span>appendixb.toml<span class="w"> </span>-o<span class="w"> </span>pofff+plopm<span class="w"> </span>-m<span class="w"> </span>single<span class="w"> </span>-c<span class="w"> </span><span class="s1">&#39;5e-2&#39;</span><span class="w"> </span>-f<span class="w"> </span>none
plopm<span class="w"> </span>-v<span class="w"> </span>xco2l<span class="w"> </span>-i<span class="w"> </span><span class="s1">&#39;pofff+plopm/POFFF+PLOPM&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="m">16</span>,5<span class="w"> </span>-mask<span class="w"> </span>satnum<span class="w"> </span>-m<span class="w"> </span>gif<span class="w"> </span>-dpi<span class="w"> </span><span class="m">1000</span><span class="w"> </span>-f<span class="w"> </span><span class="m">20</span><span class="w"> </span>-loop<span class="w"> </span><span class="m">1</span><span class="w"> </span>-cformat<span class="w"> </span>.1e<span class="w"> </span>-cbsfax<span class="w"> </span><span class="m">0</span>.30,0.01,0.4,0.02<span class="w"> </span>-interval<span class="w"> </span><span class="m">437</span>.5<span class="w"> </span>-maskthr<span class="w"> </span>1e-5<span class="w"> </span>-tunits<span class="w"> </span>h<span class="w"> </span>-cnum<span class="w"> </span><span class="m">5</span><span class="w"> </span>-clabel<span class="w"> </span><span class="s1">&#39;CO$_2$ mass fraction in liquid [-]&#39;</span><span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;FluidFlower simulation (GitHub/cssr-tools/pofff),&#39;</span>
</pre></div>
</div>
Expand Down
Loading
Loading