Merge pull request #75 from daavid00/documentation

Removing opm-models from OPM Flow built
OPM · Sep 9, 2024 · 90be278 · 90be278
2 parents b5bfbe0 + 30c0c2f
commit 90be278
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 31 deletions.
diff --git a/docs/_sources/installation.rst.txt b/docs/_sources/installation.rst.txt
@@ -57,25 +57,25 @@ in the terminal the following lines (which in turn should build flow in the fold
 
     CURRENT_DIRECTORY="$PWD"
 
-    for repo in common grid models simulators
+    for repo in common grid simulators
     do
         git clone https://github.com/OPM/opm-$repo.git
     done
 
     mkdir build
 
-    for repo in common grid models
+    for repo in common grid
     do
         mkdir build/opm-$repo
         cd build/opm-$repo
-        cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid" $CURRENT_DIRECTORY/opm-$repo
+        cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/build/opm-common" $CURRENT_DIRECTORY/opm-$repo
         make -j5 opm$repo
         cd ../..
     done    
 
     mkdir build/opm-simulators
     cd build/opm-simulators
-    cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid;$CURRENT_DIRECTORY/build/opm-models" $CURRENT_DIRECTORY/opm-simulators
+    cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid" $CURRENT_DIRECTORY/opm-simulators
     make -j5 flow
     cd ../..
 
@@ -103,7 +103,7 @@ package (see the `prerequisites <https://opm-project.org/?page_id=239>`_, which
          ./dune-common/bin/dunecontrol --only=dune-$module make -j5
     done
 
-    for repo in common grid models simulators
+    for repo in common grid simulators
     do
         git clone https://github.com/OPM/opm-$repo.git
     done
@@ -112,18 +112,18 @@ package (see the `prerequisites <https://opm-project.org/?page_id=239>`_, which
 
     mkdir build
 
-    for repo in common grid models
+    for repo in common grid
     do
         mkdir build/opm-$repo
         cd build/opm-$repo
-        cmake -DPYTHON_EXECUTABLE=$(which python) -DWITH_NDEBUG=1 -DUSE_MPI=0 -DOPM_ENABLE_PYTHON=ON -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
-        make -j5
+        cmake -DPYTHON_EXECUTABLE=$(which python) -DWITH_NDEBUG=1 -DUSE_MPI=0 -DOPM_ENABLE_PYTHON=ON -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/opm-$repo
+        make -j5 opm$repo
         cd ../..
     done    
 
     mkdir build/opm-simulators
     cd build/opm-simulators
-    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/build/opm-models" $CURRENT_DIRECTORY/opm-simulators
+    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-simulators
     make -j5 flow
     cd ../..
 

diff --git a/docs/_sources/related.rst.txt b/docs/_sources/related.rst.txt
@@ -20,7 +20,7 @@ plopm
 
 .. image:: ./figs/plopm.png
 
-`Quick generation of PNG figures and VTKs from a OPM Flow type model <https://github.com/cssr-tools/plopm>`_.
+`Quick generation of PNGs, GIFs, and VTKs from a OPM Flow type model <https://github.com/cssr-tools/plopm>`_.
 
 ******
 pycopm

diff --git a/docs/installation.html b/docs/installation.html
@@ -140,25 +140,25 @@ <h3>Source build in Linux/Windows<a class="headerlink" href="#source-build-in-li
 in the terminal the following lines (which in turn should build flow in the folder ./build/opm-simulators/bin/flow.):</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 repo in common grid models simulators</span>
+<span class="go">for repo in common grid simulators</span>
 <span class="go">do</span>
 <span class="go">    git clone https://github.com/OPM/opm-$repo.git</span>
 <span class="go">done</span>
 
 <span class="go">mkdir build</span>
 
-<span class="go">for repo in common grid models</span>
+<span class="go">for repo in common grid</span>
 <span class="go">do</span>
 <span class="go">    mkdir build/opm-$repo</span>
 <span class="go">    cd build/opm-$repo</span>
-<span class="go">    cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=&quot;$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid&quot; $CURRENT_DIRECTORY/opm-$repo</span>
+<span class="go">    cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=&quot;$CURRENT_DIRECTORY/build/opm-common&quot; $CURRENT_DIRECTORY/opm-$repo</span>
 <span class="go">    make -j5 opm$repo</span>
 <span class="go">    cd ../..</span>
 <span class="go">done</span>
 
 <span class="go">mkdir build/opm-simulators</span>
 <span class="go">cd build/opm-simulators</span>
-<span class="go">cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=&quot;$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid;$CURRENT_DIRECTORY/build/opm-models&quot; $CURRENT_DIRECTORY/opm-simulators</span>
+<span class="go">cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=&quot;$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid&quot; $CURRENT_DIRECTORY/opm-simulators</span>
 <span class="go">make -j5 flow</span>
 <span class="go">cd ../..</span>
 </pre></div>
@@ -182,7 +182,7 @@ <h3>Source build in Linux/Windows<a class="headerlink" href="#source-build-in-li
 <span class="go">     ./dune-common/bin/dunecontrol --only=dune-$module make -j5</span>
 <span class="go">done</span>
 
-<span class="go">for repo in common grid models simulators</span>
+<span class="go">for repo in common grid simulators</span>
 <span class="go">do</span>
 <span class="go">    git clone https://github.com/OPM/opm-$repo.git</span>
 <span class="go">done</span>
@@ -191,18 +191,18 @@ <h3>Source build in Linux/Windows<a class="headerlink" href="#source-build-in-li
 
 <span class="go">mkdir build</span>
 
-<span class="go">for repo in common grid models</span>
+<span class="go">for repo in common grid</span>
 <span class="go">do</span>
 <span class="go">    mkdir build/opm-$repo</span>
 <span class="go">    cd build/opm-$repo</span>
-<span class="go">    cmake -DPYTHON_EXECUTABLE=$(which python) -DWITH_NDEBUG=1 -DUSE_MPI=0 -DOPM_ENABLE_PYTHON=ON -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">    make -j5</span>
+<span class="go">    cmake -DPYTHON_EXECUTABLE=$(which python) -DWITH_NDEBUG=1 -DUSE_MPI=0 -DOPM_ENABLE_PYTHON=ON -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&quot; $CURRENT_DIRECTORY/opm-$repo</span>
+<span class="go">    make -j5 opm$repo</span>
 <span class="go">    cd ../..</span>
 <span class="go">done</span>
 
 <span class="go">mkdir build/opm-simulators</span>
 <span class="go">cd build/opm-simulators</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;$CURRENT_DIRECTORY/build/opm-models&quot; $CURRENT_DIRECTORY/opm-simulators</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-simulators</span>
 <span class="go">make -j5 flow</span>
 <span class="go">cd ../..</span>
 

diff --git a/docs/related.html b/docs/related.html
@@ -102,7 +102,7 @@ <h2>pyopmnearwell<a class="headerlink" href="#pyopmnearwell" title="Link to this
 <section id="plopm">
 <h2>plopm<a class="headerlink" href="#plopm" title="Link to this heading"></a></h2>
 <img alt="_images/plopm.png" src="_images/plopm.png" />
-<p><a class="reference external" href="https://github.com/cssr-tools/plopm">Quick generation of PNG figures and VTKs from a OPM Flow type model</a>.</p>
+<p><a class="reference external" href="https://github.com/cssr-tools/plopm">Quick generation of PNGs, GIFs, and VTKs from a OPM Flow type model</a>.</p>
 </section>
 <section id="pycopm">
 <h2>pycopm<a class="headerlink" href="#pycopm" title="Link to this heading"></a></h2>

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/text/installation.rst b/docs/text/installation.rst
@@ -57,25 +57,25 @@ in the terminal the following lines (which in turn should build flow in the fold
 
     CURRENT_DIRECTORY="$PWD"
 
-    for repo in common grid models simulators
+    for repo in common grid simulators
     do
         git clone https://github.com/OPM/opm-$repo.git
     done
 
     mkdir build
 
-    for repo in common grid models
+    for repo in common grid
     do
         mkdir build/opm-$repo
         cd build/opm-$repo
-        cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid" $CURRENT_DIRECTORY/opm-$repo
+        cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/build/opm-common" $CURRENT_DIRECTORY/opm-$repo
         make -j5 opm$repo
         cd ../..
     done    
 
     mkdir build/opm-simulators
     cd build/opm-simulators
-    cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid;$CURRENT_DIRECTORY/build/opm-models" $CURRENT_DIRECTORY/opm-simulators
+    cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid" $CURRENT_DIRECTORY/opm-simulators
     make -j5 flow
     cd ../..
 
@@ -103,7 +103,7 @@ package (see the `prerequisites <https://opm-project.org/?page_id=239>`_, which
          ./dune-common/bin/dunecontrol --only=dune-$module make -j5
     done
 
-    for repo in common grid models simulators
+    for repo in common grid simulators
     do
         git clone https://github.com/OPM/opm-$repo.git
     done
@@ -112,18 +112,18 @@ package (see the `prerequisites <https://opm-project.org/?page_id=239>`_, which
 
     mkdir build
 
-    for repo in common grid models
+    for repo in common grid
     do
         mkdir build/opm-$repo
         cd build/opm-$repo
-        cmake -DPYTHON_EXECUTABLE=$(which python) -DWITH_NDEBUG=1 -DUSE_MPI=0 -DOPM_ENABLE_PYTHON=ON -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
-        make -j5
+        cmake -DPYTHON_EXECUTABLE=$(which python) -DWITH_NDEBUG=1 -DUSE_MPI=0 -DOPM_ENABLE_PYTHON=ON -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/opm-$repo
+        make -j5 opm$repo
         cd ../..
     done    
 
     mkdir build/opm-simulators
     cd build/opm-simulators
-    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/build/opm-models" $CURRENT_DIRECTORY/opm-simulators
+    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-simulators
     make -j5 flow
     cd ../..
 

diff --git a/docs/text/related.rst b/docs/text/related.rst
@@ -20,7 +20,7 @@ plopm
 
 .. image:: ./figs/plopm.png
 
-`Quick generation of PNG figures and VTKs from a OPM Flow type model <https://github.com/cssr-tools/plopm>`_.
+`Quick generation of PNGs, GIFs, and VTKs from a OPM Flow type model <https://github.com/cssr-tools/plopm>`_.
 
 ******
 pycopm