Merge pull request #32 from daavid00/dev

Bump year to 2026

Author: daavid00

.github/workflows/CI.yml

@@ -9,23 +9,17 @@ on:
 jobs:
   run-pyopmnearwell-local:
     timeout-minutes: 60
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ['3.12']
-        os: [ubuntu-latest]
-        
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v2
       with:
         fetch-depth: 0
 
-    - name: Set up Python ${{ matrix.python-version }}
+    - name: Set up Python 3.12
       uses: actions/setup-python@v2
       with:
-        python-version: ${{ matrix.python-version }}
+        python-version: 3.12
 
     - name: Install Flow Simulator
       run: |
@@ -54,7 +48,7 @@ jobs:
       
     - name: Run the tests
       run: |
-        pytest --cov=pyopmnearwell --cov-report term-missing tests/
+        pytest -x --cov=pyopmnearwell --cov-report term-missing tests/
 
     - name: Build documentation
       run: |

docs/_sources/installation.rst.txt

@@ -62,6 +62,13 @@ You also need to install:
 
 * OPM Flow (https://opm-project.org, Release 2025.10 or current master branches)
 
+Binary packages
++++++++++++++++
+
+See the `downloading and installing <https://opm-project.org/?page_id=36>`_ OPM Flow online documentation for 
+instructions to install the binary packages in Ubuntu and Red Hat Enterprise Linux, and for other platforms which are
+supported either via source builds or through running a virtual machine.
+
 .. tip::
 
     See the `CI.yml <https://github.com/cssr-tools/pyopmnearwell/blob/main/.github/workflows/CI.yml>`_ script 
@@ -99,32 +106,40 @@ in the terminal the following lines (which in turn should build flow in the fold
 
 .. _macOS:
 
+Brew formula for macOS
+++++++++++++++++++++++
+For macOS, there are no available binary packages, so OPM Flow needs to be built from source. Recently, a formula to build flow using brew has
+been added in `https://github.com/cssr-tools/homebrew-opm <https://github.com/cssr-tools/homebrew-opm>`_. 
+Then, you can try to install flow (v2025.10) by simply typing:
+
+.. code-block:: console
+
+    brew install cssr-tools/opm/opm-simulators
+
+You can check if the installation of OPM Flow succeded by typing in the terminal **flow \-\-help**.
+
+.. tip::
+    See the actions in the `cssr-tools/homebrew-opm <https://github.com/cssr-tools/homebrew-opm/actions>`_ repository.
+
 Source build in macOS
 +++++++++++++++++++++
-For macOS, there are no available binary packages, so OPM Flow needs to be built from source, in addition to the dune libraries 
-(see the `prerequisites <https://opm-project.org/?page_id=239>`_, which can be installed using macports or brew). For example,
-with brew the prerequisites can be installed by:
+If you would like to build the latest OPM Flow from the master branch, then you can first install the prerequisites using brew:
 
 .. code-block:: console
 
     brew install boost openblas suite-sparse python@3.13 cmake
 
 In addition, it is recommended to uprade and update your macOS to the latest available versions (the following steps have 
-worked for macOS Tahoe 26.1 with Apple clang version 17.0.0).
-After the prerequisites are installed and the vpyopmnearwell Python environment is created (see :ref:`vpyopmnearwell`), 
-then building OPM Flow can be achieved with the following bash lines:
-
-This can be achieved by the following lines:
+worked for macOS Tahoe 26.2 with Apple clang version 17.0.0).
+After the prerequisites are installed, then building OPM Flow can be achieved with the following bash lines:
 
 .. code-block:: console
 
     CURRENT_DIRECTORY="$PWD"
 
-    deactivate
-    source vpyopmnearwell/bin/activate
-
     for module in common geometry grid istl
-    do   git clone https://gitlab.dune-project.org/core/dune-$module.git --branch v2.9.1
+    do  git clone https://gitlab.dune-project.org/core/dune-$module.git
+        cd dune-$module && git checkout v2.10.0 && cd ..
         ./dune-common/bin/dunecontrol --only=dune-$module cmake -DCMAKE_DISABLE_FIND_PACKAGE_MPI=1
         ./dune-common/bin/dunecontrol --only=dune-$module make -j5
     done
@@ -133,8 +148,7 @@ This can be achieved by the following lines:
 
     for repo in common grid simulators
     do  git clone https://github.com/OPM/opm-$repo.git
-        mkdir build/opm-$repo
-        cd build/opm-$repo
+        mkdir build/opm-$repo && cd build/opm-$repo
         cmake -DUSE_MPI=0 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/dune-common/build-cmake;$CURRENT_DIRECTORY/dune-grid/build-cmake;$CURRENT_DIRECTORY/dune-geometry/build-cmake;$CURRENT_DIRECTORY/dune-istl/build-cmake;$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid" $CURRENT_DIRECTORY/opm-$repo
         if [[ $repo == simulators ]]; then
             make -j5 flow
@@ -144,12 +158,10 @@ This can be achieved by the following lines:
         cd ../..
     done
 
-    echo "export PATH=\$PATH:$CURRENT_DIRECTORY/build/opm-simulators/bin" >> $CURRENT_DIRECTORY/vpyopmnearwell/bin/activate
-
-    deactivate
-    source vpyopmnearwell/bin/activate
+    echo "export PATH=\$PATH:$CURRENT_DIRECTORY/build/opm-simulators/bin" >> ~/.zprofile
+    source ~/.zprofile
 
-This builds OPM Flow, and it exports the path to the flow executable (i.e., executing in the terminal **which flow** should print the path).
+This builds OPM Flow, and it exports the path to the flow executable. You can check if the installation of OPM Flow succeded by typing in the terminal **flow \-\-help**.
 
 .. tip::
     See `this repository <https://github.com/daavid00/OPM-Flow_macOS>`_ dedicated to build OPM Flow from source in the latest macOS (GitHub actions).

docs/about.html

@@ -99,7 +99,7 @@ <h1>About pyopmnearwell<a class="headerlink" href="#about-pyopmnearwell" title="
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023-2025, NORCE Research AS.</p>
+    <p>&#169; Copyright 2023-2026, NORCE Research AS.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/api.html

@@ -140,7 +140,7 @@ <h2>pyopmnearwell<a class="headerlink" href="#pyopmnearwell" title="Link to this
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023-2025, NORCE Research AS.</p>
+    <p>&#169; Copyright 2023-2026, NORCE Research AS.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/configuration_file.html

@@ -241,7 +241,7 @@ <h2>Additional parameters<a class="headerlink" href="#additional-parameters" tit
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023-2025, NORCE Research AS.</p>
+    <p>&#169; Copyright 2023-2026, NORCE Research AS.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/contributing.html

@@ -157,7 +157,7 @@ <h2>Seek support<a class="headerlink" href="#seek-support" title="Link to this h
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023-2025, NORCE Research AS.</p>
+    <p>&#169; Copyright 2023-2026, NORCE Research AS.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/examples.html

@@ -155,7 +155,7 @@ <h2>Publications<a class="headerlink" href="#publications" title="Link to this h
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023-2025, NORCE Research AS.</p>
+    <p>&#169; Copyright 2023-2026, NORCE Research AS.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/genindex.html

@@ -690,7 +690,7 @@ <h2 id="W">W</h2>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023-2025, NORCE Research AS.</p>
+    <p>&#169; Copyright 2023-2026, NORCE Research AS.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/index.html

@@ -91,7 +91,9 @@ <h1>Welcome to pyopmnearwell’s documentation!<a class="headerlink" href="#welc
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#python-package">Python package</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#opm-flow">OPM Flow</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#binary-packages">Binary packages</a></li>
 <li class="toctree-l3"><a class="reference internal" href="installation.html#source-build-in-linux-windows">Source build in Linux/Windows</a></li>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#brew-formula-for-macos">Brew formula for macOS</a></li>
 <li class="toctree-l3"><a class="reference internal" href="installation.html#source-build-in-macos">Source build in macOS</a></li>
 </ul>
 </li>
@@ -163,7 +165,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Li
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023-2025, NORCE Research AS.</p>
+    <p>&#169; Copyright 2023-2026, NORCE Research AS.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/installation.html

@@ -49,7 +49,9 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#python-package">Python package</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#opm-flow">OPM Flow</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#binary-packages">Binary packages</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#source-build-in-linux-windows">Source build in Linux/Windows</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#brew-formula-for-macos">Brew formula for macOS</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#source-build-in-macos">Source build in macOS</a></li>
 </ul>
 </li>
@@ -141,11 +143,17 @@ <h2>OPM Flow<a class="headerlink" href="#opm-flow" title="Link to this heading">
 <ul class="simple">
 <li><p>OPM Flow (<a class="reference external" href="https://opm-project.org">https://opm-project.org</a>, Release 2025.10 or current master branches)</p></li>
 </ul>
+<section id="binary-packages">
+<h3>Binary packages<a class="headerlink" href="#binary-packages" title="Link to this heading"></a></h3>
+<p>See the <a class="reference external" href="https://opm-project.org/?page_id=36">downloading and installing</a> OPM Flow online documentation for
+instructions to install the binary packages in Ubuntu and Red Hat Enterprise Linux, and for other platforms which are
+supported either via source builds or through running a virtual machine.</p>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>
 <p>See the <a class="reference external" href="https://github.com/cssr-tools/pyopmnearwell/blob/main/.github/workflows/CI.yml">CI.yml</a> script
 for installation of OPM Flow (binary packages) and the pyopmnearwell package in Ubuntu.</p>
 </div>
+</section>
 <section id="source-build-in-linux-windows">
 <h3>Source build in Linux/Windows<a class="headerlink" href="#source-build-in-linux-windows" title="Link to this heading"></a></h3>
 <p>If you are a Linux user (including the Windows subsystem for Linux, see <a class="reference external" href="https://learn.microsoft.com/en-us/windows/python/web-frameworks">this link</a>
@@ -174,26 +182,34 @@ <h3>Source build in Linux/Windows<a class="headerlink" href="#source-build-in-li
 <p>You can create a .sh file (e.g., build_opm_mpi.sh), copy the previous lines, and run in the terminal <strong>source build_opm_mpi.sh</strong></p>
 </div>
 </section>
+<section id="brew-formula-for-macos">
+<span id="macos"></span><h3>Brew formula for macOS<a class="headerlink" href="#brew-formula-for-macos" title="Link to this heading"></a></h3>
+<p>For macOS, there are no available binary packages, so OPM Flow needs to be built from source. Recently, a formula to build flow using brew has
+been added in <a class="reference external" href="https://github.com/cssr-tools/homebrew-opm">https://github.com/cssr-tools/homebrew-opm</a>.
+Then, you can try to install flow (v2025.10) by simply typing:</p>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">brew install cssr-tools/opm/opm-simulators</span>
+</pre></div>
+</div>
+<p>You can check if the installation of OPM Flow succeded by typing in the terminal <strong>flow --help</strong>.</p>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>See the actions in the <a class="reference external" href="https://github.com/cssr-tools/homebrew-opm/actions">cssr-tools/homebrew-opm</a> repository.</p>
+</div>
+</section>
 <section id="source-build-in-macos">
-<span id="macos"></span><h3>Source build in macOS<a class="headerlink" href="#source-build-in-macos" title="Link to this heading"></a></h3>
-<p>For macOS, there are no available binary packages, so OPM Flow needs to be built from source, in addition to the dune libraries
-(see the <a class="reference external" href="https://opm-project.org/?page_id=239">prerequisites</a>, which can be installed using macports or brew). For example,
-with brew the prerequisites can be installed by:</p>
+<h3>Source build in macOS<a class="headerlink" href="#source-build-in-macos" title="Link to this heading"></a></h3>
+<p>If you would like to build the latest OPM Flow from the master branch, then you can first install the prerequisites using brew:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">brew install boost openblas suite-sparse python@3.13 cmake</span>
 </pre></div>
 </div>
 <p>In addition, it is recommended to uprade and update your macOS to the latest available versions (the following steps have
-worked for macOS Tahoe 26.1 with Apple clang version 17.0.0).
-After the prerequisites are installed and the vpyopmnearwell Python environment is created (see <a class="reference internal" href="#vpyopmnearwell"><span class="std std-ref">Python package</span></a>),
-then building OPM Flow can be achieved with the following bash lines:</p>
-<p>This can be achieved by the following lines:</p>
+worked for macOS Tahoe 26.2 with Apple clang version 17.0.0).
+After the prerequisites are installed, then building OPM Flow can be achieved with the following bash lines:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">CURRENT_DIRECTORY=&quot;$PWD&quot;</span>
 
-<span class="go">deactivate</span>
-<span class="go">source vpyopmnearwell/bin/activate</span>
-
 <span class="go">for module in common geometry grid istl</span>
-<span class="go">do   git clone https://gitlab.dune-project.org/core/dune-$module.git --branch v2.9.1</span>
+<span class="go">do  git clone https://gitlab.dune-project.org/core/dune-$module.git</span>
+<span class="go">    cd dune-$module &amp;&amp; git checkout v2.10.0 &amp;&amp; cd ..</span>
 <span class="go">    ./dune-common/bin/dunecontrol --only=dune-$module cmake -DCMAKE_DISABLE_FIND_PACKAGE_MPI=1</span>
 <span class="go">    ./dune-common/bin/dunecontrol --only=dune-$module make -j5</span>
 <span class="go">done</span>
@@ -202,8 +218,7 @@ <h3>Source build in Linux/Windows<a class="headerlink" href="#source-build-in-li
 
 <span class="go">for repo in common grid simulators</span>
 <span class="go">do  git clone https://github.com/OPM/opm-$repo.git</span>
-<span class="go">    mkdir build/opm-$repo</span>
-<span class="go">    cd build/opm-$repo</span>
+<span class="go">    mkdir build/opm-$repo &amp;&amp; cd build/opm-$repo</span>
 <span class="go">    cmake -DUSE_MPI=0 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=&quot;$CURRENT_DIRECTORY/dune-common/build-cmake;$CURRENT_DIRECTORY/dune-grid/build-cmake;$CURRENT_DIRECTORY/dune-geometry/build-cmake;$CURRENT_DIRECTORY/dune-istl/build-cmake;$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid&quot; $CURRENT_DIRECTORY/opm-$repo</span>
 <span class="go">    if [[ $repo == simulators ]]; then</span>
 <span class="go">        make -j5 flow</span>
@@ -213,13 +228,11 @@ <h3>Source build in Linux/Windows<a class="headerlink" href="#source-build-in-li
 <span class="go">    cd ../..</span>
 <span class="go">done</span>
 
-<span class="go">echo &quot;export PATH=\$PATH:$CURRENT_DIRECTORY/build/opm-simulators/bin&quot; &gt;&gt; $CURRENT_DIRECTORY/vpyopmnearwell/bin/activate</span>
-
-<span class="go">deactivate</span>
-<span class="go">source vpyopmnearwell/bin/activate</span>
+<span class="go">echo &quot;export PATH=\$PATH:$CURRENT_DIRECTORY/build/opm-simulators/bin&quot; &gt;&gt; ~/.zprofile</span>
+<span class="go">source ~/.zprofile</span>
 </pre></div>
 </div>
-<p>This builds OPM Flow, and it exports the path to the flow executable (i.e., executing in the terminal <strong>which flow</strong> should print the path).</p>
+<p>This builds OPM Flow, and it exports the path to the flow executable. You can check if the installation of OPM Flow succeded by typing in the terminal <strong>flow --help</strong>.</p>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>
 <p>See <a class="reference external" href="https://github.com/daavid00/OPM-Flow_macOS">this repository</a> dedicated to build OPM Flow from source in the latest macOS (GitHub actions).</p>
@@ -239,7 +252,7 @@ <h3>Source build in Linux/Windows<a class="headerlink" href="#source-build-in-li
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023-2025, NORCE Research AS.</p>
+    <p>&#169; Copyright 2023-2026, NORCE Research AS.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a