Link to glossary input deck

equinor · Nov 15, 2023 · 0556a2a · 0556a2a
1 parent f2649fa
commit 0556a2a
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 22 deletions.
diff --git a/docs/csv2res.rst b/docs/csv2res.rst
@@ -1,9 +1,9 @@
 csv2res
 =======
 
-Some of the modules inside res2df is able to write reservoir simulator input decks
+Some of the modules inside res2df is able to write reservoir simulator :ref:`input deck<glossary:input_decks>`
 from dataframes (in the format dumped by res2df). This makes it possible
-to produce reservoir input decks in any application that can write CSV files,
+to produce reservoir :ref:`input deck<glossary:input_decks>` in any application that can write CSV files,
 and use this tool to convert it into reservoir simulator files, or it can
 facilitate operations/manipulations of an existing deck using any tool
 that can work on CSV files, by first running res2csv on an input file,

diff --git a/docs/glossary.rst b/docs/glossary.rst
@@ -3,15 +3,18 @@ Glossary
 
 .. glossary::
 
-    deck/input deck
+    .. input_deck::
+    deck/:ref:`input deck<glossary:input_deck>`
         Inputs provided to reservoir simulators such as Eclipse or OPM-flow.
         Usually a .DATA file pointing to other include files. One deck points
         to multiple include files.
 
+    .. include_files::
     include files
         Files that provide inputs to reservoir simulators by using the INCLUDE statement
-        in input decks. By convention, these files often have the extension .INC (generally)
+        in :ref:`input deck<glossary:input_decks>`. By convention, these files often have the extension .INC (generally)
         or .GRDECL (for files included into the grid section).
 
+    .. res_simulator::
     reservoir simulator
         Reservoir simulators such as OPM-flow or Eclipse. 
diff --git a/docs/introduction.rst b/docs/introduction.rst
@@ -127,14 +127,14 @@ More documentation on :doc:`usage/satfunc`.
 ^^^^^^^^^
 
 Extracts the information in the `EQUIL` table, `RSVD` and `RVVD` in the
-input deck. Can write back to include files.
+:ref:`input deck<glossary:input_deck>`. Can write back to include files.
 
 More documentation on :doc:`usage/equil`.
 
 ``compdat``
 ^^^^^^^^^^^
 
-Extracts well connection data from the `COMPDAT` keyword in the input deck.
+Extracts well connection data from the `COMPDAT` keyword in the :ref:`input deck<glossary:input_deck>`.
 For multi-segment wells, `WELSEGS` and `COMPSEGS` is also parsed. The
 data is available as three different dataframes, which can be merged.
 
@@ -147,7 +147,7 @@ More documentation on :doc:`usage/compdat`.
 ^^^^^^^^^^^^
 
 Extracts the information from the `GRUPTREE` and `WELSPECS` keyword, at
-all timesteps, from the input deck. The tree structure at each relevant
+all timesteps, from the :ref:`input deck<glossary:input_deck>`. The tree structure at each relevant
 date can be returned as a dataframe of the edges, as a nested dictionary
 or as a `treelib` tree.
 
@@ -156,7 +156,7 @@ More documentation on :doc:`usage/gruptree`.
 ``pvt``
 ^^^^^^^
 
-Extracts PVT data from an input deck, from the keywords `PVTO`, `PVDG`,
+Extracts PVT data from an :ref:`input deck<glossary:input_deck>`, from the keywords `PVTO`, `PVDG`,
 `DENSITY`, `ROCK` etc. Can write data back to include files.
 
 More documentation on :doc:`usage/pvt`.
@@ -173,7 +173,7 @@ More documentation on :doc:`usage/wcon`.
 ^^^^^^^^^^^^^^^^
 
 This is an internal helper module in order to represent finished or
-unfinished input decks and runs. The class ResdataFiles can cache binary
+unfinished :ref:`input deck<glossary:input_decks>` and runs. The class ResdataFiles can cache binary
 files that are recently read, and is able to locate the various output
 files based on the basename or the `.DATA` filename.
 
@@ -183,7 +183,7 @@ Metadata support
 parameters.txt
 ^^^^^^^^^^^^^^
 
-Metadata for each input deck are sometimes added in a text file named
+Metadata for each :ref:`input deck<glossary:input_deck>` are sometimes added in a text file named
 ``parameters.txt``, alongside the Eclipse DATA file or one or two directory levels
 above it.
 

diff --git a/docs/res2csv.rst b/docs/res2csv.rst
@@ -4,7 +4,7 @@ res2csv
 Most of the functionality in res2df is exposed to the command line through
 the script *res2csv*. The first argument to this script is always
 the submodule (subcommand) from which you want functionality. Mandatory argument is
-always an input deck or sometimes individual include files, and
+always an :ref:`input deck<glossary:input_deck>` or sometimes individual include files, and
 there is usually an ``--output`` option to specify which file to dump
 the CSV to. If you want output to your terminal, use ``-`` as the output filename.
 

diff --git a/docs/usage/compdat.rst b/docs/usage/compdat.rst
@@ -1,7 +1,7 @@
 compdat
 ^^^^^^^
 
-This module extracts COMPDAT, WELSEGS and COMPSEGS from an input deck.
+This module extracts COMPDAT, WELSEGS and COMPSEGS from an :ref:`input deck<glossary:input_deck>`.
 
 Additionally, it will parse WELOPEN statements and emit new COMPDAT
 statements from the actions in WELOPEN.
@@ -26,7 +26,7 @@ for each of COMPDAT, and the segmentation keywords.
 .. warning:: When WELOPEN is in use, the dataframe can differ from Eclipse
   behaviour in certain circumstances. The dataframe representation from
   ``compdat`` does not separate from a "shut" well and the open-ness of its
-  connections. So in an input deck it is possible to shut a well, and then
+  connections. So in an :ref:`input deck<glossary:input_deck>` it is possible to shut a well, and then
   reopen it, and get back the original open/shut state of individual
   connections prior to well shut.  The dataframe format will display `all`
   connections as open if a well is opened with defaulted indices.

diff --git a/docs/usage/equil.rst b/docs/usage/equil.rst
@@ -2,7 +2,7 @@ equil
 -----
 
 This is the res2df module for processing the ``SOLUTION`` section of
-the input deck.
+the :ref:`input deck<glossary:input_deck>`.
 
 Supported keywords are ``EQUIL``, ``RSVD``, ``RVVD``, ``PBVD`` and
 ``PDVD``. Typical usage is

diff --git a/docs/usage/gruptree.rst b/docs/usage/gruptree.rst
@@ -1,12 +1,12 @@
 gruptree
 --------
 
-Extracts data from the GRUPTREE, GRUPNET and WELSPECS keywords from an input deck and presents the production network either as pretty-printed ASCII or in a
+Extracts data from the GRUPTREE, GRUPNET and WELSPECS keywords from an :ref:`input deck<glossary:input_deck>` and presents the production network either as pretty-printed ASCII or in a
 dataframe-representation.
 
-The GRUPTREE section of your input deck defines the production network
+The GRUPTREE section of your :ref:`input deck<glossary:input_deck>` defines the production network
 from wells and up to the platform (and possibly also to a field having
-many platforms). In the input deck it be as simple as this::
+many platforms). In the :ref:`input deck<glossary:input_deck>` it be as simple as this::
 
     START
       01 'JAN' 2000 /

diff --git a/docs/usage/pvt.rst b/docs/usage/pvt.rst
@@ -1,7 +1,7 @@
 pvt
 ---
 
-Extracts PVT related keyword data from the PROPS section in an input deck,
+Extracts PVT related keyword data from the PROPS section in an :ref:`input deck<glossary:input_deck>`,
 typically the keywords ``PVTO``, ``PVDG``, ``DENSITY`` and ``ROCK``. Data from
 all keywords will be merged into one common dataframe.
 
@@ -76,7 +76,7 @@ When you are done with the table, you can generate new include files from your m
 
    pvt.df2res(dframe, filename="pvt.inc")
 
-When injecting this produced ``pvt.inc`` into any new input deck, ensure you
+When injecting this produced ``pvt.inc`` into any new :ref:`input deck<glossary:input_deck>`, ensure you
 check which keywords have been written out, compared to what you gave in to
 `res2df.pvt` above. Any non-supported keywords will get lost in the import phase
 and need to be catered for outside res2df.

diff --git a/docs/usage/satfunc.rst b/docs/usage/satfunc.rst
@@ -1,7 +1,7 @@
 satfunc
 -------
 
-satfunc will extract saturation functions from input decks or from Eclipse
+satfunc will extract saturation functions from :ref:`input deck<glossary:input_decks>` or from Eclipse
 include files, these are the keywords ``SWOF``, ``SGOF``, ``SGWFN``, ``SWFN``,
 ``SOF2``, ``SGFN``, ``SOF3`` and  ``SLGOF``.
 

diff --git a/docs/usage/trans.rst b/docs/usage/trans.rst
@@ -6,7 +6,7 @@ from a simulation grid.
 
 Python API: :func:`res2df.trans.df`
 
-Applied on an input deck, the *trans* module will give out a dataframe of neighbour
+Applied on an :ref:`input deck<glossary:input_deck>`, the *trans* module will give out a dataframe of neighbour
 connections
 
 .. code-block:: python

diff --git a/docs/usage/wcon.rst b/docs/usage/wcon.rst
@@ -2,7 +2,7 @@ wcon
 ^^^^
 
 This module extracts information from WCONHIST, WCONINJE, WCONINJH and
-WCONPROD from an input deck.
+WCONPROD from an :ref:`input deck<glossary:input_deck>`.
 
 ..
   wcon.df(ResdataFiles('tests/data/reek/eclipse/model/2_R001_REEK-0.DATA')).head(15).to_csv('docs/usage/wcon.csv', index=False)