Skip to content

Commit

Permalink
Update glossary
Browse files Browse the repository at this point in the history
  • Loading branch information
Yngve S. Kristiansen committed Nov 15, 2023
1 parent cd31c43 commit 60a39db
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
10 changes: 7 additions & 3 deletions docs/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@ Glossary
.. glossary::

deck/input deck
Inputs provided to reservoir simulators such as Eclipse or OpenMP.
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
Individual include files that provide inputs to reservoir simulators.
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)
or .GRDECL (for files included into the grid section).

reservoir simulator
Bla bla bla Eclipse


4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ res2df
======

res2df is a Pandas DataFrame wrapper around libecl and opm.io, which
are used to access binary files outputted by the reservoir simulator
Eclipse, or its input files --- or any other tool outputting to the same
are used to access binary files outputted by the reservoir simulators or
their input files --- or any other tool outputting to the same
data format.

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ More documentation on :doc:`usage/fipreports`.
^^^^^^^^^^^

Extracts saturation functions (SWOF, SGOF, etc) from the deck and merges
into one DataFrame. Can write back to Eclipse include files.
into one DataFrame. Can write back to include files.

More documentation on :doc:`usage/satfunc`.

Expand Down

0 comments on commit 60a39db

Please sign in to comment.