Merge pull request #127 from daavid00/dev

Nitpicks

Author: daavid00

docs/_sources/benchmark.rst.txt

@@ -6,7 +6,7 @@ All configuration files are located in the `benchmark <https://github.com/OPM/py
 
 .. note::
     A few weeks after the OPM Flow 2025.04 release, there was a PR that changed the command line parameters for
-    `--partition-method` and `--edge-weights-method` (see `the PR <https://github.com/OPM/opm-simulators/pull/6264>`_). Then, the 
+    `\-\-partition-method` and `\-\-edge-weights-method` (see `the PR <https://github.com/OPM/opm-simulators/pull/6264>`_). Then, the 
     .txt configuration files in the benchmark folder use the old format from the OPM Flow 2025.04 release, while the .toml 
     configuration files use the new naming after that PR.
 
@@ -156,7 +156,11 @@ Spatial maps
         plopm -v xco2l -i "r1_Cart_50m-50m-10m/flow/R1_CART_50M-50M-10M r2_cp_50m-50m-8mish/flow/R2_CP_50M-50M-8MISH r3_cp_50m-50m-8mish_convective/flow/R3_CP_50M-50M-8MISH_CONVECTIVE r4_cp_8m-8mish-8mish/flow/R4_CP_8M-8MISH-8MISH" -dpi 300 -c cet_diverging_protanopic_deuteranopic_bwy_60_95_c32 -cnum 3 -xlnum 8 -clabel 'SPE11C: CO$_2$ mass fraction (liquid phase) after 1000 years (y=2.5 [km])' -d 16,3 -t "r1 Cart [50m,50m,10m]  r2 cp [50m,50m,8mish]  r3 cp [50m,50m,8mish] convective  r4 cp [8m,8mish,8mish]" -yunits km -xunits km -yformat .1f -xformat .1f -r 27 -save massfractc -cformat .2e -mask satnum -maskthr 1e-4 -suptitle 0 -subfigs 2,2 -cbsfax 0.30,0.97,0.4,0.02 -delax 1 -s ',51, ,51, ,51, ,304,' -u opm
 
 .. tip::
-    You can install `plopm <https://github.com/cssr-tools/plopm>`_ by executing in the terminal: pip install git+https://github.com/cssr-tools/plopm.git.
+    You can install `plopm <https://github.com/cssr-tools/plopm>`_ by executing in the terminal:
+    
+    .. code-block:: bash
+        
+        pip install git+https://github.com/cssr-tools/plopm.git
 
 -----------------
 Well 1 correction

docs/_sources/contributing.rst.txt

@@ -26,8 +26,8 @@ This requires a Python version of at least 3.11 (due to `tomllib <https://toml.i
     #. **pip install -r dev-requirements.txt** (this installs the `dev-requirements.txt <https://github.com/cssr-tools/pyopmspe11/blob/main/dev-requirements.txt>`_; in addition, both opm Python and LaTeX are required, then for not macOs users run **pip install opm** and **sudo apt-get install texlive-fonts-recommended texlive-fonts-extra dvipng cm-super**, or else follow the instructions in `macOS installation <https://cssr-tools.github.io/pyopmspe11/installation.html#source-build-in-macos>`_)
     #. **black 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=pyopmspe11 --cov-report term-missing tests/** (this runs locally the tests in ca. 30 minutes, 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=pyopmspe11 \-\-cov-report term-missing tests/** (this runs locally the tests in ca. 30 minutes, 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 delete all content from the `docs <https://github.com/cssr-tools/pyopmspe11/tree/main/docs>`_ folder except `Makefile <https://github.com/OPM/pyopmspe11/blob/main/docs/Makefile>`_, `text <https://github.com/OPM/pyopmspe11/blob/main/docs/text>`_, and `.nojekyll <https://github.com/OPM/pyopmspe11/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/pyopmspe11/tree/main/docs>`_ folder)
 
     .. tip::

docs/_sources/related.rst.txt

@@ -2,7 +2,7 @@
 Related
 =======
 
-Below are some tools that might be of interest; check them out 🙂.
+Below are some tools that might be of interest; check 'em out 🙂.
 
 ******
 pycopm

docs/benchmark.html

@@ -108,7 +108,7 @@ <h1>Benchmark<a class="headerlink" href="#benchmark" title="Link to this heading
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>A few weeks after the OPM Flow 2025.04 release, there was a PR that changed the command line parameters for
-<cite>–partition-method</cite> and <cite>–edge-weights-method</cite> (see <a class="reference external" href="https://github.com/OPM/opm-simulators/pull/6264">the PR</a>). Then, the
+<cite>--partition-method</cite> and <cite>--edge-weights-method</cite> (see <a class="reference external" href="https://github.com/OPM/opm-simulators/pull/6264">the PR</a>). Then, the
 .txt configuration files in the benchmark folder use the old format from the OPM Flow 2025.04 release, while the .toml
 configuration files use the new naming after that PR.</p>
 </div>
@@ -287,7 +287,10 @@ <h3>Spatial maps<a class="headerlink" href="#id7" title="Link to this heading">
 </div>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>
-<p>You can install <a class="reference external" href="https://github.com/cssr-tools/plopm">plopm</a> by executing in the terminal: pip install git+https://github.com/cssr-tools/plopm.git.</p>
+<p>You can install <a class="reference external" href="https://github.com/cssr-tools/plopm">plopm</a> by executing in the terminal:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>git+https://github.com/cssr-tools/plopm.git
+</pre></div>
+</div>
 </div>
 </section>
 <section id="well-1-correction">

docs/contributing.html

@@ -111,8 +111,8 @@ <h2>Contribute to the software<a class="headerlink" href="#contribute-to-the-sof
 <li><p><strong>pip install -r dev-requirements.txt</strong> (this installs the <a class="reference external" href="https://github.com/cssr-tools/pyopmspe11/blob/main/dev-requirements.txt">dev-requirements.txt</a>; in addition, both opm Python and LaTeX are required, then for not macOs users run <strong>pip install opm</strong> and <strong>sudo apt-get install texlive-fonts-recommended texlive-fonts-extra dvipng cm-super</strong>, or else follow the instructions in <a class="reference external" href="https://cssr-tools.github.io/pyopmspe11/installation.html#source-build-in-macos">macOS installation</a>)</p></li>
 <li><p><strong>black 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=pyopmspe11 –cov-report term-missing tests/</strong> (this runs locally the tests in ca. 30 minutes, 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=pyopmspe11 --cov-report term-missing tests/</strong> (this runs locally the tests in ca. 30 minutes, 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 delete all content from the <a class="reference external" href="https://github.com/cssr-tools/pyopmspe11/tree/main/docs">docs</a> folder except <a class="reference external" href="https://github.com/OPM/pyopmspe11/blob/main/docs/Makefile">Makefile</a>, <a class="reference external" href="https://github.com/OPM/pyopmspe11/blob/main/docs/text">text</a>, and <a class="reference external" href="https://github.com/OPM/pyopmspe11/blob/main/docs/.nojekyll">.nojekyll</a>, after copy all contents from the docs/_build/html/ folder, and finally paste them in the <a class="reference external" href="https://github.com/cssr-tools/pyopmspe11/tree/main/docs">docs</a> folder)</p></li>
 </ol>
 <div class="admonition tip">

docs/related.html

@@ -91,7 +91,7 @@
 
   <section id="related">
 <h1>Related<a class="headerlink" href="#related" title="Link to this heading"></a></h1>
-<p>Below are some tools that might be of interest; check them out 🙂.</p>
+<p>Below are some tools that might be of interest; check ‘em out 🙂.</p>
 <section id="pycopm">
 <h2>pycopm<a class="headerlink" href="#pycopm" title="Link to this heading"></a></h2>
 <a class="reference internal image-reference" href="_images/pycopm.png"><img alt="_images/pycopm.png" src="_images/pycopm.png" style="width: 699.52px; height: 295.68px;" />

docs/searchindex.js

@@ -6,7 +6,7 @@ All configuration files are located in the `benchmark <https://github.com/OPM/py
 
 .. note::
     A few weeks after the OPM Flow 2025.04 release, there was a PR that changed the command line parameters for
-    `--partition-method` and `--edge-weights-method` (see `the PR <https://github.com/OPM/opm-simulators/pull/6264>`_). Then, the 
+    `\-\-partition-method` and `\-\-edge-weights-method` (see `the PR <https://github.com/OPM/opm-simulators/pull/6264>`_). Then, the 
     .txt configuration files in the benchmark folder use the old format from the OPM Flow 2025.04 release, while the .toml 
     configuration files use the new naming after that PR.
 
@@ -156,7 +156,11 @@ Spatial maps
         plopm -v xco2l -i "r1_Cart_50m-50m-10m/flow/R1_CART_50M-50M-10M r2_cp_50m-50m-8mish/flow/R2_CP_50M-50M-8MISH r3_cp_50m-50m-8mish_convective/flow/R3_CP_50M-50M-8MISH_CONVECTIVE r4_cp_8m-8mish-8mish/flow/R4_CP_8M-8MISH-8MISH" -dpi 300 -c cet_diverging_protanopic_deuteranopic_bwy_60_95_c32 -cnum 3 -xlnum 8 -clabel 'SPE11C: CO$_2$ mass fraction (liquid phase) after 1000 years (y=2.5 [km])' -d 16,3 -t "r1 Cart [50m,50m,10m]  r2 cp [50m,50m,8mish]  r3 cp [50m,50m,8mish] convective  r4 cp [8m,8mish,8mish]" -yunits km -xunits km -yformat .1f -xformat .1f -r 27 -save massfractc -cformat .2e -mask satnum -maskthr 1e-4 -suptitle 0 -subfigs 2,2 -cbsfax 0.30,0.97,0.4,0.02 -delax 1 -s ',51, ,51, ,51, ,304,' -u opm
 
 .. tip::
-    You can install `plopm <https://github.com/cssr-tools/plopm>`_ by executing in the terminal: pip install git+https://github.com/cssr-tools/plopm.git.
+    You can install `plopm <https://github.com/cssr-tools/plopm>`_ by executing in the terminal:
+    
+    .. code-block:: bash
+        
+        pip install git+https://github.com/cssr-tools/plopm.git
 
 -----------------
 Well 1 correction

docs/text/benchmark.rst

@@ -26,8 +26,8 @@ This requires a Python version of at least 3.11 (due to `tomllib <https://toml.i
     #. **pip install -r dev-requirements.txt** (this installs the `dev-requirements.txt <https://github.com/cssr-tools/pyopmspe11/blob/main/dev-requirements.txt>`_; in addition, both opm Python and LaTeX are required, then for not macOs users run **pip install opm** and **sudo apt-get install texlive-fonts-recommended texlive-fonts-extra dvipng cm-super**, or else follow the instructions in `macOS installation <https://cssr-tools.github.io/pyopmspe11/installation.html#source-build-in-macos>`_)
     #. **black 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=pyopmspe11 --cov-report term-missing tests/** (this runs locally the tests in ca. 30 minutes, 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=pyopmspe11 \-\-cov-report term-missing tests/** (this runs locally the tests in ca. 30 minutes, 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 delete all content from the `docs <https://github.com/cssr-tools/pyopmspe11/tree/main/docs>`_ folder except `Makefile <https://github.com/OPM/pyopmspe11/blob/main/docs/Makefile>`_, `text <https://github.com/OPM/pyopmspe11/blob/main/docs/text>`_, and `.nojekyll <https://github.com/OPM/pyopmspe11/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/pyopmspe11/tree/main/docs>`_ folder)
 
     .. tip::

docs/text/contributing.rst

@@ -2,7 +2,7 @@
 Related
 =======
 
-Below are some tools that might be of interest; check them out 🙂.
+Below are some tools that might be of interest; check 'em out 🙂.
 
 ******
 pycopm