Skip to content

Commit 6e8c2e7

Browse files
authored
Merge pull request #154 from daavid00/dev
Updating the README.md and typos
2 parents 1a7f58e + f836bf9 commit 6e8c2e7

5 files changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pip install -e .
4242
pip install -r dev-requirements.txt
4343
```
4444

45-
To generate only the input files (e.g., .DATA, .GRID, .INC), this does not required to have OPM Flow installed, and in principle should work in Windows without using the subsystem for Linux. Then, one could always generate a deck with the grid and all include files, and modify them in order to use other simulators different than OPM Flow.
45+
To generate only the input files (e.g., .DATA, .GRID, .INC), this does not required to have OPM Flow installed, and works in Windows without using the subsystem for Linux (see [_ci_pyopmspe11_windows.yml_](https://github.com/OPM/pyopmspe11/actions/workflows/ci_pyopmspe11_windows.yml)). Then, one could always generate a deck with the grid and all include files, and modify them in order to use other simulators different than OPM Flow.
4646

4747
If you are insterested in running the cases via ***pyopmspe11*** and generating the CSV files with the benchmark format, then you will first need to install
4848
* Flow (https://opm-project.org, Release 2026.04 or current master branches)

docs/_sources/examples.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Then, we run the simulations:
4040
pyopmspe11 -i convective.toml -o convective -m deck_flow_data -w 1
4141
4242
Here we have just set the framework to generate the deck, run the simulations, and generate the performance and sparse data (default value for **-g**).
43-
Then, to visualize the comparison between both runs, this can be achived by executing:
43+
Then, to visualize the comparison between both runs, this can be achieved by executing:
4444

4545
.. code-block:: bash
4646
@@ -68,7 +68,7 @@ This example uses a very coarser grid to run fast. See the :doc:`benchmark <./be
6868
===========================
6969
Cp grids (11 and 18 levels)
7070
===========================
71-
In a `recent paper <https://link.springer.com/article/10.1007/s11242-025-02275-0>`_ to history match the FluidFlower data using the laboratory images, a more regular coner-point grid
71+
In a `recent paper <https://link.springer.com/article/10.1007/s11242-025-02275-0>`_ to history match the FluidFlower data using the laboratory images, a more regular corner-point grid
7272
was used consisting in 11 levels instead of 18 as the submitted results for the SPE11 benchmark. Then, the corner-point grid from that paper has been included in the
7373
**pyopmspe11** tool. To use this corner-point grid, then one needs to give an array of size 11 for the variable "z_n" in the toml files. For example, in the
7474
`spe11b.toml <https://github.com/OPM/pyopmspe11/blob/main/examples/spe11b.toml>`_ in the examples folder, setting z_n to [2, 2, 2, 3, 2, 2, 8, 4, 8, 8, 1] and

docs/examples.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h2>Hello world<a class="headerlink" href="#hello-world" title="Link to this hea
119119
</pre></div>
120120
</div>
121121
<p>Here we have just set the framework to generate the deck, run the simulations, and generate the performance and sparse data (default value for <strong>-g</strong>).
122-
Then, to visualize the comparison between both runs, this can be achived by executing:</p>
122+
Then, to visualize the comparison between both runs, this can be achieved by executing:</p>
123123
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyopmspe11<span class="w"> </span>-c<span class="w"> </span>spe11b
124124
</pre></div>
125125
</div>
@@ -146,7 +146,7 @@ <h2>Hello world<a class="headerlink" href="#hello-world" title="Link to this hea
146146
</section>
147147
<section id="cp-grids-11-and-18-levels">
148148
<h2>Cp grids (11 and 18 levels)<a class="headerlink" href="#cp-grids-11-and-18-levels" title="Link to this heading"></a></h2>
149-
<p>In a <a class="reference external" href="https://link.springer.com/article/10.1007/s11242-025-02275-0">recent paper</a> to history match the FluidFlower data using the laboratory images, a more regular coner-point grid
149+
<p>In a <a class="reference external" href="https://link.springer.com/article/10.1007/s11242-025-02275-0">recent paper</a> to history match the FluidFlower data using the laboratory images, a more regular corner-point grid
150150
was used consisting in 11 levels instead of 18 as the submitted results for the SPE11 benchmark. Then, the corner-point grid from that paper has been included in the
151151
<strong>pyopmspe11</strong> tool. To use this corner-point grid, then one needs to give an array of size 11 for the variable “z_n” in the toml files. For example, in the
152152
<a class="reference external" href="https://github.com/OPM/pyopmspe11/blob/main/examples/spe11b.toml">spe11b.toml</a> in the examples folder, setting z_n to [2, 2, 2, 3, 2, 2, 8, 4, 8, 8, 1] and

docs/text/examples.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Then, we run the simulations:
4040
pyopmspe11 -i convective.toml -o convective -m deck_flow_data -w 1
4141
4242
Here we have just set the framework to generate the deck, run the simulations, and generate the performance and sparse data (default value for **-g**).
43-
Then, to visualize the comparison between both runs, this can be achived by executing:
43+
Then, to visualize the comparison between both runs, this can be achieved by executing:
4444

4545
.. code-block:: bash
4646
@@ -68,7 +68,7 @@ This example uses a very coarser grid to run fast. See the :doc:`benchmark <./be
6868
===========================
6969
Cp grids (11 and 18 levels)
7070
===========================
71-
In a `recent paper <https://link.springer.com/article/10.1007/s11242-025-02275-0>`_ to history match the FluidFlower data using the laboratory images, a more regular coner-point grid
71+
In a `recent paper <https://link.springer.com/article/10.1007/s11242-025-02275-0>`_ to history match the FluidFlower data using the laboratory images, a more regular corner-point grid
7272
was used consisting in 11 levels instead of 18 as the submitted results for the SPE11 benchmark. Then, the corner-point grid from that paper has been included in the
7373
**pyopmspe11** tool. To use this corner-point grid, then one needs to give an array of size 11 for the variable "z_n" in the toml files. For example, in the
7474
`spe11b.toml <https://github.com/OPM/pyopmspe11/blob/main/examples/spe11b.toml>`_ in the examples folder, setting z_n to [2, 2, 2, 3, 2, 2, 8, 4, 8, 8, 1] and

src/pyopmspe11/core/pyopmspe11.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ def load_parser(argv: list[str] | None) -> dict:
9090
"all",
9191
],
9292
default="deck_flow",
93-
help="Parts of pyopmsoe11 to run",
93+
help="Parts of pyopmspe11 to run",
9494
)
9595
parser.add_argument(
9696
"-c",

0 commit comments

Comments
 (0)