Added links for keyword files in chapter 5.3 #411

hakonhagland · 2024-11-05T12:52:44Z

Used the script in #410 to add links to all keyword files in Chapter 5.3. See #410 for more information.

gdfldm · 2024-11-07T15:18:28Z

parts/chapters/subsections/5.3/BRINE.fodt

    <text:p text:style-name="_40_Example">--</text:p>
-    <text:p text:style-name="_40_Example">BRINE</text:p>


@hakonhagland, it looks like a link has been created here possibly because the style-name was directly specified as "_40_Example" rather than indirectly as for example "P64".

gdfldm · 2024-11-07T16:17:25Z

parts/chapters/subsections/5.3/ACTDIMS.fodt

@@ -4328,17 +4328,17 @@ Updated with AFR/TSA Rev-D comments and new keywords.</dc:description><meta:init
      <table:covered-table-cell/>
     </table:table-row>
    </table:table>
-    <text:p text:style-name="P14560">Table <text:sequence text:ref-name="refTable18" text:name="Table" text:formula="ooow:Table+1" style:num-format="1">5.3</text:sequence>: ACTDIMS Keyword Description</text:p>
+    <text:p text:style-name="P14560">Table <text:sequence text:ref-name="refTable18" text:name="Table" text:formula="ooow:Table+1" style:num-format="1">5.3</text:sequence>: <text:a xlink:href="#__RefHeading___Toc4408_421927891">ACTDIMS</text:a> Keyword Description</text:p>


I wonder whether we should add links to Table and Figure captions, since these seem to mostly refer to the current keyword?

Might be easiest to do this using the manual marker method. See #411 (comment)

There seems to be a lot more tables than figures. I think we might be able to handle the tables using the script. I will have a look at it.

gdfldm · 2024-11-07T16:21:58Z

parts/chapters/subsections/5.3/CO2SOL.fodt

-       <text:p text:style-name="Footnote">Tor Harald Sandve1, Sarah E. Gasda, Atgeirr Rasmussen, <text:span text:style-name="T22">and</text:span> Alf Birger Rustad. Convective dissolution in field scale CO<text:span text:style-name="T20">2</text:span> storage simulation using the OPM Flow simulator. Submitted to TCCS 11 – Trondheim Conference on CO<text:span text:style-name="T20">2</text:span> Capture, Transport and Storage Trondheim, Norway – June 21-23, 2021.</text:p></text:note-body></text:note>. Note that the CO<text:span text:style-name="T20">2</text:span>-Brine PVT properties depend on the temperature and salinity and these must therefore be entered in the PROPS section. The reservoir temperature can be defined using, e.g., the RTEMP keyword. Region based salinity can be provided using the SALINITY keyword.</text:p>
-    <text:p text:style-name="P52">The CO2SOL keyword must be used together with the SOLVENT keyword in the RUNSPEC section. The SOLVENT keyword activates the four component black-oil model: oil, water and gas, plus a solvent (in this case CO<text:span text:style-name="T20">2</text:span>).</text:p>
-    <text:p text:style-name="P52">The DISGASW keyword in the RUNSPEC section can be used to model dissolution of CO<text:span text:style-name="T20">2</text:span> in the Brine. <text:span text:style-name="T21">Note that hydrocarbon gas is not allowed to dissolve in the Brine (this is considered a reasonable assumption for most hydrocarbon gases).</text:span></text:p>
-    <text:p text:style-name="P52">The hydrocarbon <text:span text:style-name="T23">reservoir fluid</text:span> properties should be set up as normal apart from the water PVT properties, which will be defined by the simulators’ CO<text:span text:style-name="T20">2</text:span>-Brine PVT model, so the water PVT keywords (e.g. PVTW) are not required. The CO<text:span text:style-name="T20">2</text:span> PVT properties will also be defined by the CO<text:span text:style-name="T20">2</text:span>-Brine PVT model so the solvent PVT keywords (e.g. SDENSITY, PVTSOL) are also not required.</text:p>


PVTSOL has not been converted to a link. This seems to be due to a typo in the file name PVSOL.fodt not PVTSOL.fodt.

Thanks for spotting that, I have added #415 to fix the filename.

gdfldm · 2024-11-07T16:27:34Z

parts/chapters/subsections/5.3/COMPS.fodt

@@ -4285,7 +4285,7 @@ Updated with AFR/TSA Rev-D comments and new keywords.</dc:description><meta:init
       <text:p text:style-name="P3161">1</text:p>
      </table:table-cell>
      <table:table-cell table:style-name="Table2074.B2" office:value-type="string">
-       <text:p text:style-name="P5436">COMPS</text:p>
+       <text:p text:style-name="P5436"><text:a xlink:href="#__RefHeading___Toc27871_3671211675 Copy 1">COMPS</text:a></text:p>


Here the parameter name COMPS has been interpreted as the keyword COMPS.

I do not immediately see how to fix this with the current algorithm. However, we could handle special cases like this manually by inserting a marker that the script can recognize. For example, inserting a span tag with a non-existing text:style-name. The script can then check for that style name. Like this: <text:span text:style-name="NOT_KEYWORD">COMPS</text:span>, where the style "NOT_KEYWORD" indicates to script that it should not link this word.

gdfldm · 2024-11-07T16:51:43Z

parts/chapters/subsections/5.3/INSPEC.fodt

-    <text:p text:style-name="P12632">The INIT Index file can either be written out in formatted form as ASCII i.e. text files, if the FMTOUT keyword has been activated (*.FINSPEC), or binary format (*.INSPEC) if the FMTOUT keyword has not been activated. If the INIT keyword in the GRID section has been used to switch on the writing of the *. INIT data file then a binary INIT Index file is automatically written out as well, unless the NOINSPEC keyword in the RUNSPEC section has been used to switch off the writing of the INIT Index file. </text:p>
-    <text:p text:style-name="P12632">Note that most post-processing software require the *.INSPEC file to load the *.INIT data set, although OPM ResInsight does not require this file to be able to load the *.INIT data file.</text:p>
+    <text:p text:style-name="_40_TextBody">This keyword switches on the writing of the <text:a xlink:href="#__RefHeading___Toc45789_719036256">INIT</text:a> Index file that specifies and defines the format and data type written to the *.<text:a xlink:href="#__RefHeading___Toc45789_719036256">INIT</text:a> data file. The *.<text:a xlink:href="#__RefHeading___Toc45789_719036256">INIT</text:a> data file contains the static data specified in the <text:a xlink:href="#__RefHeading___Toc38674_784232322">GRID</text:a>, <text:a xlink:href="#__RefHeading___Toc39329_784232322">PROPS</text:a> and <text:a xlink:href="#__RefHeading___Toc40648_784232322">REGIONS</text:a> sections. For example, the <text:a xlink:href="#__RefHeading___Toc45797_719036256">PORO</text:a>, PERM and <text:a xlink:href="#__RefHeading___Toc33334_784232322">NTG</text:a> arrays from the <text:a xlink:href="#__RefHeading___Toc38674_784232322">GRID</text:a> section. The data is used in post-processing software, for example OPM ResInsight, to visualize the static grid properties. </text:p>
+    <text:p text:style-name="P12632">The <text:a xlink:href="#__RefHeading___Toc45789_719036256">INIT</text:a> Index file can either be written out in formatted form as ASCII i.e. text files, if the <text:a xlink:href="#__RefHeading___Toc46651_1640804870">FMTOUT</text:a> keyword has been activated (*.FINSPEC), or binary format (*.<text:a xlink:href="#__RefHeading___Toc212474_2369005893">INSPEC</text:a>) if the <text:a xlink:href="#__RefHeading___Toc46651_1640804870">FMTOUT</text:a> keyword has not been activated. If the <text:a xlink:href="#__RefHeading___Toc45789_719036256">INIT</text:a> keyword in the <text:a xlink:href="#__RefHeading___Toc38674_784232322">GRID</text:a> section has been used to switch on the writing of the *. <text:a xlink:href="#__RefHeading___Toc45789_719036256">INIT</text:a> data file then a binary <text:a xlink:href="#__RefHeading___Toc45789_719036256">INIT</text:a> Index file is automatically written out as well, unless the <text:a xlink:href="#__RefHeading___Toc70892_4106839650">NOINSPEC</text:a> keyword in the <text:a xlink:href="#__RefHeading___Toc55591_1778172979">RUNSPEC</text:a> section has been used to switch off the writing of the <text:a xlink:href="#__RefHeading___Toc45789_719036256">INIT</text:a> Index file. </text:p>


File name extensions can be mistaken for keywords, for example *.INSPEC.

gdfldm · 2024-11-07T16:57:17Z

parts/chapters/subsections/5.3/PATHS.fodt

@@ -4316,7 +4316,7 @@ Updated with AFR/TSA Rev-D comments and new keywords.</dc:description><meta:init
    <text:p text:style-name="P13694"><text:s text:c="8"/>&apos;SCHD&apos; <text:s text:c="5"/>&apos;/DISK1/NORNE/2017/SCHD-INCLUDES&apos; <text:s text:c="25"/>/</text:p>
    <text:p text:style-name="P13694">/ <text:s text:c="6"/></text:p>
    <text:p text:style-name="P13694"/>
-    <text:p text:style-name="P11188">The above example defines “GRID” and “SCHD” aliases in the RUNSPEC section than can be used in the GRID and SCHEDULE sections of the input deck. The next example shows how to use the “GRID” alias with the INCLUDE keyword in the GRID section.</text:p>
+    <text:p text:style-name="P11188">The above example defines “<text:a xlink:href="#__RefHeading___Toc38674_784232322">GRID</text:a>” and “SCHD” aliases in the <text:a xlink:href="#__RefHeading___Toc55591_1778172979">RUNSPEC</text:a> section than can be used in the <text:a xlink:href="#__RefHeading___Toc38674_784232322">GRID</text:a> and <text:a xlink:href="#__RefHeading___Toc43945_784232322">SCHEDULE</text:a> sections of the input deck. The next example shows how to use the “<text:a xlink:href="#__RefHeading___Toc38674_784232322">GRID</text:a>” alias with the <text:a xlink:href="#__RefHeading___Toc605478_3199477706">INCLUDE</text:a> keyword in the <text:a xlink:href="#__RefHeading___Toc38674_784232322">GRID</text:a> section.</text:p>


The path alias "GRID" has been mistaken for a keyword. Perhaps keyword-like strings within quotes could be ignored?

gdfldm · 2024-11-07T17:11:24Z

I have created a PDF of the Manual based on this PR and it looks very nice. I think there are just a few special cases that should be addressed.

hakonhagland · 2024-11-07T22:30:24Z

@gdfldm Thanks for the detailed review! I have tried to address your comments in the latest commit.

gdfldm · 2024-11-08T16:03:17Z

@hakonhagland Thank you for all the updates. I have recreated the manual and found some places in Section 5 where we might want to mark up the documents by hand to avoid generating links but otherwise it looks good:

API: "API Tracking", "API gravity"
CPR: "CPR linear solver", "CPR preconditioner"
ENDSCALE: "SWL arrays" this is not referring to a keyword but the link may still be helpful?
EOS: "Equation of State (EOS)", "EOS region"
EQLOPTS: THPRES parameter is also a keyword
GIMODEL: "GI option"
NOINSPEC: "INIT index file"
REGDIMS: "FIPNUM regions" this is not referring to a keyword but the link may still be helpful?
SATOPTS: A link has been generated in the title of the second Table in the description of this keyword.
SAVE: "SAVE file"
VE: "VE model"
VISAGE: "VISAGE option" could simply change to "Visage option"?

hakonhagland · 2024-11-08T19:34:00Z

found some places in Section 5 where we might want to mark up the documents by hand

@gdfldm Thanks! I checked the SATOPTS page now, and saw that KRNUMX and other similar keywords was not recognized. I think that is because they are not separate keywords in the manual. They are all described under the KRNUM keyword. Maybe the script should set up aliases for these?

gdfldm · 2024-11-08T21:23:35Z

Maybe the script should set up aliases for these?

Yes, I think so.

hakonhagland · 2024-11-09T10:32:23Z

@gdfldm See the last commit for updates to address the comments above.

gdfldm · 2024-11-09T16:41:23Z

parts/chapters/subsections/5.3/SATOPTS.fodt

For keywords like KRNUMX- the "-" seems to be placed outside the tag, for example:
<text:a xlink:href="#__RefHeading___Toc273792_2369005893">KRNUMX</text:a>-,

hakonhagland · 2024-11-10T07:36:51Z

For keywords like KRNUMX- the "-" seems to be placed outside the tag

@gdfldm Good observation! I have fixed the script to handle this case. Check the latest commit for the result.

hakonhagland · 2024-11-11T12:12:39Z

Rebased

When a keyword ended with a "-" the anchor word not include the trailing "-".

gdfldm reviewed Nov 7, 2024

View reviewed changes

This was referenced Nov 7, 2024

Fix typo in PVTSOL filename #415

Merged

Script to insert keyword links #410

Merged

Insert special markers around words to avoid linking #417

Merged

gdfldm reviewed Nov 9, 2024

View reviewed changes

hakonhagland force-pushed the link5_3 branch from 5cbe32e to 61b5c2a Compare November 11, 2024 12:12

hakonhagland force-pushed the link5_3 branch from 61b5c2a to 443f7e4 Compare November 13, 2024 11:06

hakonhagland added 4 commits November 13, 2024 17:11

Added links for keyword files in chapter 5.3

22b4880

Updated files according to review comments

0d19ec2

Changes requested by review comments

d675dd5

Fix linking of keywords ending with "-"

9f3dc22

When a keyword ended with a "-" the anchor word not include the trailing "-".

hakonhagland force-pushed the link5_3 branch from 443f7e4 to 9f3dc22 Compare November 13, 2024 16:23

blattms merged commit a6495d0 into OPM:main Nov 26, 2024

hakonhagland mentioned this pull request Nov 26, 2024

Added links for keyword files in chapter 6.3 #416

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added links for keyword files in chapter 5.3 #411

Added links for keyword files in chapter 5.3 #411

hakonhagland commented Nov 5, 2024

gdfldm Nov 7, 2024

gdfldm Nov 7, 2024

hakonhagland Nov 7, 2024

hakonhagland Nov 7, 2024

gdfldm Nov 7, 2024

hakonhagland Nov 7, 2024

gdfldm Nov 7, 2024

hakonhagland Nov 7, 2024

gdfldm Nov 7, 2024

gdfldm Nov 7, 2024

gdfldm commented Nov 7, 2024

hakonhagland commented Nov 7, 2024 •

edited

Loading

gdfldm commented Nov 8, 2024

hakonhagland commented Nov 8, 2024

gdfldm commented Nov 8, 2024

hakonhagland commented Nov 9, 2024

gdfldm Nov 9, 2024

hakonhagland commented Nov 10, 2024

hakonhagland commented Nov 11, 2024

		<text:p text:style-name="_40_Example">--</text:p>
		<text:p text:style-name="_40_Example">BRINE</text:p>

Added links for keyword files in chapter 5.3 #411

Added links for keyword files in chapter 5.3 #411

Conversation

hakonhagland commented Nov 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gdfldm commented Nov 7, 2024

hakonhagland commented Nov 7, 2024 • edited Loading

gdfldm commented Nov 8, 2024

hakonhagland commented Nov 8, 2024

gdfldm commented Nov 8, 2024

hakonhagland commented Nov 9, 2024

Choose a reason for hiding this comment

hakonhagland commented Nov 10, 2024

hakonhagland commented Nov 11, 2024

hakonhagland commented Nov 7, 2024 •

edited

Loading