Merge pull request #68 from daavid00/dev

Docs brew formulas for flow and resinsight

Author: daavid00

docs/_sources/examples.rst.txt

@@ -3,12 +3,18 @@ Examples
 ********
 
 For additional examples demonstrating the applicability of **pycopm**, see the `tests <https://github.com/cssr-tools/pycopm/tree/main/tests>`_.
+
 `ResInsight <https://resinsight.org>`_ and `plopm <https://github.com/cssr-tools/plopm>`_ are used for the visualization of the results.
 
 .. note::
 
-    For macOS users, you could try to install ResInsight following `this <https://github.com/SoilRos/homebrew-OPM>`_. If you have issues
-    installing ResInsight, `ParaView <https://www.paraview.org>`_ can be also used. However, you need to add the flag **\-\-enable-vtk-output=true**
+    There are binary packages for Linux and Windows to install Resinsight, see the `ResInsight Documentation <https://resinsight.org/releases/>`_. For macOS users, you could try to install it using `brew <https://brew.sh>`_ by executing:
+
+    .. code-block:: bash
+
+        brew install cssr-tools/opm/resinsight
+    
+    Then, you should be able to open resinsight by typing in the terminal **resinsight**. If you have issues installing ResInsight, `ParaView <https://www.paraview.org>`_ can be also used. However, you need to add the flag **\-\-enable-vtk-output=true**
     to OPM Flow.
 
 =======================
@@ -24,7 +30,7 @@ to perform HM studies in drogon and norne using `ERT <https://ert.readthedocs.io
     cd examples/configurations/drogon
     pycopm -i input.toml -o drogon_coarser
 
-The following are the drogon model from `opm-tests <https://github.com/OPM/opm-tests/tree/master/drogon>`_ and coarsened model generated using **pycopm**:
+The following are the drogon model from `opm-tests <https://github.com/OPM/opm-tests/tree/master/drogon>`_ and coarsened model generated using **pycopm** using ResInsight for the visualization:
 
 .. figure:: figs/drogon_coarser.png
 

docs/_sources/installation.rst.txt

@@ -2,7 +2,7 @@
 Installation
 ============
 
-The following steps work installing the dependencies in Ubuntu via apt-get or in macOS using brew or macports.
+The following steps work installing the dependencies in Ubuntu via apt-get or in macOS using `brew <https://brew.sh>`_ or `macports <https://www.macports.org>`_.
 While using package managers such as Anaconda, Miniforge, or Mamba might work, these are not tested.
 The supported Python versions are 3.11 to 3.13. We will update the documentation when Python3.14 is supported
 (e.g., the ert Python package is not yet available via pip install in Python 3.14).
@@ -60,6 +60,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_pycopm_ubuntu.yml <https://github.com/cssr-tools/pycopm/blob/main/.github/workflows/ci_pycopm_ubuntu.yml>`_ script 
@@ -97,30 +104,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.0.1 with Apple clang version 17.0.0).
-After the prerequisites are installed and the vpyocpm Python environment is created (see :ref:`vpycopm`), 
-then building OPM Flow can be achieved with the following bash lines:
+worked for macOS Tahoe 26.2.0 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 vpycopm/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
@@ -129,8 +146,7 @@ then building OPM Flow can be achieved with the following bash 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
@@ -140,10 +156,8 @@ then building OPM Flow can be achieved with the following bash lines:
         cd ../..
     done
 
-    echo "export PATH=\$PATH:$CURRENT_DIRECTORY/build/opm-simulators/bin" >> $CURRENT_DIRECTORY/vpycopm/bin/activate
-
-    deactivate
-    source vpycopm/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.
 

docs/examples.html

@@ -95,12 +95,15 @@
 
   <section id="examples">
 <h1>Examples<a class="headerlink" href="#examples" title="Link to this heading"></a></h1>
-<p>For additional examples demonstrating the applicability of <strong>pycopm</strong>, see the <a class="reference external" href="https://github.com/cssr-tools/pycopm/tree/main/tests">tests</a>.
-<a class="reference external" href="https://resinsight.org">ResInsight</a> and <a class="reference external" href="https://github.com/cssr-tools/plopm">plopm</a> are used for the visualization of the results.</p>
+<p>For additional examples demonstrating the applicability of <strong>pycopm</strong>, see the <a class="reference external" href="https://github.com/cssr-tools/pycopm/tree/main/tests">tests</a>.</p>
+<p><a class="reference external" href="https://resinsight.org">ResInsight</a> and <a class="reference external" href="https://github.com/cssr-tools/plopm">plopm</a> are used for the visualization of the results.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>For macOS users, you could try to install ResInsight following <a class="reference external" href="https://github.com/SoilRos/homebrew-OPM">this</a>. If you have issues
-installing ResInsight, <a class="reference external" href="https://www.paraview.org">ParaView</a> can be also used. However, you need to add the flag <strong>--enable-vtk-output=true</strong>
+<p>There are binary packages for Linux and Windows to install Resinsight, see the <a class="reference external" href="https://resinsight.org/releases/">ResInsight Documentation</a>. For macOS users, you could try to install it using <a class="reference external" href="https://brew.sh">brew</a> by executing:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>brew<span class="w"> </span>install<span class="w"> </span>cssr-tools/opm/resinsight
+</pre></div>
+</div>
+<p>Then, you should be able to open resinsight by typing in the terminal <strong>resinsight</strong>. If you have issues installing ResInsight, <a class="reference external" href="https://www.paraview.org">ParaView</a> can be also used. However, you need to add the flag <strong>--enable-vtk-output=true</strong>
 to OPM Flow.</p>
 </div>
 <section id="via-configuration-files">
@@ -112,7 +115,7 @@ <h2>Via configuration files<a class="headerlink" href="#via-configuration-files"
 pycopm<span class="w"> </span>-i<span class="w"> </span>input.toml<span class="w"> </span>-o<span class="w"> </span>drogon_coarser
 </pre></div>
 </div>
-<p>The following are the drogon model from <a class="reference external" href="https://github.com/OPM/opm-tests/tree/master/drogon">opm-tests</a> and coarsened model generated using <strong>pycopm</strong>:</p>
+<p>The following are the drogon model from <a class="reference external" href="https://github.com/OPM/opm-tests/tree/master/drogon">opm-tests</a> and coarsened model generated using <strong>pycopm</strong> using ResInsight for the visualization:</p>
 <figure class="align-default">
 <img alt="_images/drogon_coarser.png" src="_images/drogon_coarser.png" />
 </figure>

docs/index.html

@@ -100,7 +100,9 @@ <h1>Welcome to pycopm’s documentation!<a class="headerlink" href="#welcome-to-
 <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>

docs/installation.html

@@ -50,7 +50,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>
@@ -91,7 +93,7 @@
 
   <section id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1>
-<p>The following steps work installing the dependencies in Ubuntu via apt-get or in macOS using brew or macports.
+<p>The following steps work installing the dependencies in Ubuntu via apt-get or in macOS using <a class="reference external" href="https://brew.sh">brew</a> or <a class="reference external" href="https://www.macports.org">macports</a>.
 While using package managers such as Anaconda, Miniforge, or Mamba might work, these are not tested.
 The supported Python versions are 3.11 to 3.13. We will update the documentation when Python3.14 is supported
 (e.g., the ert Python package is not yet available via pip install in Python 3.14).</p>
@@ -139,11 +141,17 @@ <h1>Installation<a class="headerlink" href="#installation" title="Link to this h
 <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/pycopm/blob/main/.github/workflows/ci_pycopm_ubuntu.yml">ci_pycopm_ubuntu.yml</a> script
 for installation of OPM Flow (binary packages) and the pycopm 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>
@@ -172,25 +180,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.0.1 with Apple clang version 17.0.0).
-After the prerequisites are installed and the vpyocpm Python environment is created (see <a class="reference internal" href="#vpycopm"><span class="std std-ref">Python package</span></a>),
-then building OPM Flow can be achieved with the following bash lines:</p>
+worked for macOS Tahoe 26.2.0 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 vpycopm/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>
@@ -199,8 +216,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>
@@ -210,10 +226,8 @@ <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/vpycopm/bin/activate</span>
-
-<span class="go">deactivate</span>
-<span class="go">source vpycopm/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.</p>