From 60a39db6af46163fa4cee6526e151ed2f9d92215 Mon Sep 17 00:00:00 2001 From: "Yngve S. Kristiansen" Date: Wed, 15 Nov 2023 13:12:31 +0100 Subject: [PATCH] Update glossary --- docs/glossary.rst | 10 +++++++--- docs/index.rst | 4 ++-- docs/introduction.rst | 2 +- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/glossary.rst b/docs/glossary.rst index df0fa8fd7..c5914a449 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -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 - \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index c80403a24..de50acc0d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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:: diff --git a/docs/introduction.rst b/docs/introduction.rst index b4dae3b80..6dce64fda 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -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`.