Docs for opm flow in macos

Author: daavid00

.github/workflows/CI.yml

@@ -42,7 +42,7 @@ jobs:
         
     - name: Check code style and linting 
       run: |
-        black --check src/ tests/
+        black --target-version py312 --check src/ tests/
         pylint src/ tests/
         mypy --ignore-missing-imports src/ tests/
       

CONTRIBUTING.md

@@ -14,7 +14,7 @@ Contributions are more than welcome using the fork and pull request approach 
 1. In the main repo execute:
     1. **pip install -r dev-requirements.txt** (this installs the [_dev-requirements.txt_](https://github.com/cssr-tools/pyopmnearwell/blob/main/dev-requirements.txt))
     1. **pip install tensorflow** (this install [_tensorflow_](https://www.tensorflow.org) for the machine learning near well funcitonality; tensorflow is not yet available for Python 3.14, then Python 3.12 or Python 3.13 are currently needed to run the tests)
-    1. **black src/ tests/** (this formats the code)
+    1. **black --target-version py312 src/ tests/** (this formats the code)
     1. **pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
     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)
     1. **pytest --cov=pyopmnearwell --cov-report term-missing tests/** (this runs locally the tests, and might rise issues that need to be fixed before the pull request; to save the files, add the flag **--basetemp=test_outputs**)

docs/_sources/contributing.rst.txt

@@ -23,7 +23,7 @@ Contribute to the software
 
     #. **pip install -r dev-requirements.txt** (this installs the `dev-requirements.txt <https://github.com/cssr-tools/pyopmnearwell/blob/main/dev-requirements.txt>`_)
     #. **pip install tensorflow**  (this installs `tensorflow <https://www.tensorflow.org>`_ for the machine learning near well funcitonality); tensorflow is not yet available for Python 3.14, then Python 3.12 or Python 3.13 are currently needed to run the tests
-    #. **black src/ tests/** (this formats the code)
+    #. **black --target-version py312 src/ tests/** (this formats the code)
     #. **pylint src/ tests/** (this 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 -\-cov=pyopmnearwell -\-cov-report term-missing tests/** (this runs locally the tests, and might rise issues that need to be fixed before the pull request; to save the files, add the flag **-\-basetemp=test_outputs**)

docs/_sources/installation.rst.txt

@@ -110,7 +110,7 @@ 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:
+Then, you can try to install flow (v2026.02) by simply typing:
 
 .. code-block:: console
 
@@ -123,45 +123,4 @@ You can check if the installation of OPM Flow succeded by typing in the terminal
 
 Source build in macOS
 +++++++++++++++++++++
-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 cjson 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.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"
-
-    for module in common geometry grid istl
-    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
-
-    mkdir build
-
-    for repo in common grid simulators
-    do  git clone https://github.com/OPM/opm-$repo.git
-        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
-        else
-            make -j5 opm$repo
-        fi
-        cd ../..
-    done
-
-    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. 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).
+See `this repository <https://github.com/daavid00/OPM-Flow_macOS>`_ dedicated to build OPM Flow from source in the latest macOS (GitHub actions), and tested with **pycopm**, another repository in cssr-tools.

docs/contributing.html

@@ -108,7 +108,7 @@ <h2>Contribute to the software<a class="headerlink" href="#contribute-to-the-sof
 <div><ol class="arabic simple">
 <li><p><strong>pip install -r dev-requirements.txt</strong> (this installs the <a class="reference external" href="https://github.com/cssr-tools/pyopmnearwell/blob/main/dev-requirements.txt">dev-requirements.txt</a>)</p></li>
 <li><p><strong>pip install tensorflow</strong>  (this installs <a class="reference external" href="https://www.tensorflow.org">tensorflow</a> for the machine learning near well funcitonality); tensorflow is not yet available for Python 3.14, then Python 3.12 or Python 3.13 are currently needed to run the tests</p></li>
-<li><p><strong>black src/ tests/</strong> (this formats the code)</p></li>
+<li><p><strong>black –target-version py312 src/ tests/</strong> (this formats the code)</p></li>
 <li><p><strong>pylint src/ tests/</strong> (this 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 --cov=pyopmnearwell --cov-report term-missing tests/</strong> (this runs locally the tests, and might rise issues that need to be fixed before the pull request; to save the files, add the flag <strong>--basetemp=test_outputs</strong>)</p></li>

docs/installation.html

@@ -186,7 +186,7 @@ <h3>Source build in Linux/Windows<a class="headerlink" href="#source-build-in-li
 <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>
+Then, you can try to install flow (v2026.02) 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>
@@ -198,45 +198,7 @@ <h3>Source build in Linux/Windows<a class="headerlink" href="#source-build-in-li
 </section>
 <section id="source-build-in-macos">
 <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 cjson 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.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">for module in common geometry grid istl</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>
-
-<span class="go">mkdir build</span>
-
-<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 &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>
-<span class="go">    else</span>
-<span class="go">        make -j5 opm$repo</span>
-<span class="go">    fi</span>
-<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; ~/.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. 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>
-</div>
+<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), and tested with <strong>pycopm</strong>, another repository in cssr-tools.</p>
 </section>
 </section>
 </section>

docs/searchindex.js

@@ -23,7 +23,7 @@ Contribute to the software
 
     #. **pip install -r dev-requirements.txt** (this installs the `dev-requirements.txt <https://github.com/cssr-tools/pyopmnearwell/blob/main/dev-requirements.txt>`_)
     #. **pip install tensorflow**  (this installs `tensorflow <https://www.tensorflow.org>`_ for the machine learning near well funcitonality); tensorflow is not yet available for Python 3.14, then Python 3.12 or Python 3.13 are currently needed to run the tests
-    #. **black src/ tests/** (this formats the code)
+    #. **black --target-version py312 src/ tests/** (this formats the code)
     #. **pylint src/ tests/** (this 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 -\-cov=pyopmnearwell -\-cov-report term-missing tests/** (this runs locally the tests, and might rise issues that need to be fixed before the pull request; to save the files, add the flag **-\-basetemp=test_outputs**)

docs/text/contributing.rst

@@ -110,7 +110,7 @@ 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:
+Then, you can try to install flow (v2026.02) by simply typing:
 
 .. code-block:: console
 
@@ -123,45 +123,4 @@ You can check if the installation of OPM Flow succeded by typing in the terminal
 
 Source build in macOS
 +++++++++++++++++++++
-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 cjson 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.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"
-
-    for module in common geometry grid istl
-    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
-
-    mkdir build
-
-    for repo in common grid simulators
-    do  git clone https://github.com/OPM/opm-$repo.git
-        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
-        else
-            make -j5 opm$repo
-        fi
-        cd ../..
-    done
-
-    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. 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).
+See `this repository <https://github.com/daavid00/OPM-Flow_macOS>`_ dedicated to build OPM Flow from source in the latest macOS (GitHub actions), and tested with **pycopm**, another repository in cssr-tools.