Rename to res2df #462

yngve-sk · 2023-11-14T08:43:13Z

Resolves https://github.com/equinor/scout/issues/927

codecov-commenter · 2023-11-14T10:50:19Z

Codecov Report

Attention: 40 lines in your changes are missing coverage. Please review.

Comparison is base (798ee62) 95.17% compared to head (ed4166d) 95.17%.

❗ Current head ed4166d differs from pull request most recent head 972b3ef. Consider uploading reports for the commit 972b3ef to get more accurate results

Files	Patch %	Lines
res2df/vfp/_vfpinj.py	64.86%	13 Missing ⚠️
res2df/vfp/_vfpprod.py	71.11%	13 Missing ⚠️
res2df/vfp/_vfp.py	52.00%	12 Missing ⚠️
res2df/satfunc.py	96.87%	1 Missing ⚠️
res2df/vfp/_vfpcommon.py	85.71%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #462   +/-   ##
=======================================
  Coverage   95.17%   95.17%           
=======================================
  Files          31       31           
  Lines        4413     4413           
=======================================
  Hits         4200     4200           
  Misses        213      213

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

eivindjahren · 2023-11-21T09:16:32Z

docs/introduction.rst

-It is also possible to parse individual "include" files, not only a
-finished working deck.
+It is also possible to parse individual :term:`"include files" <include file>`, not only a
+finished working :term:`deck`.


Use the term complete from the glossary instead. Non need for quotes either since we have defined it in the glossary.

I suggest the following:

"It is also possible to use an incomplete :term:include file, but several keywords from the schedule section are read to correctly extract the data."

The term complete refers to whether the deck contains enough information for the simulator to run as requested. I think maybe the beginning of the sentence came out a bit weird;

Extracts well connection data from the `COMPDAT` keyword in the :term:`.DATA file`.

Rewrote the entire thing a bit

Extracts well connection data from the `COMPDAT` keyword in the :term:`deck`. For multi-segment wells, `WELSEGS` and `COMPSEGS` is also parsed. The data is available as three different dataframes, which can be merged. It is also possible to parse individual :term:`"include files" <include file>`. These files do not necessarily have to be part of a complete :term:`deck`

eivindjahren · 2023-11-21T09:20:35Z

docs/usage/satfunc.rst


 It is possible to extract keywords one at a time using the ``--keywords`` command
 line option.

-Instead of Eclipse data decks, individual include files may also be parsed, but


Instead of "data decks" what is ment here is instead "complete .DATA file".

Reworded wrt complete/incomplete data decks

Instead of complete :term:`decks <deck>`, individual include files may also be parsed, but

eivindjahren · 2023-11-21T09:25:48Z

res2df/csv2res.py

@@ -51,8 +51,8 @@ def get_parser() -> argparse.ArgumentParser:

    summary_parser = subparsers.add_parser(
        "summary",
-        help="Write EclSum UNSMRY files",
-        description=("Write Eclipse UNSMRY files from CSV files."),
+        help="Write summary UNSMRY files",


Just "Write UNSMRY files"

eivindjahren

Just a few more things.

eivindjahren · 2023-11-21T10:53:29Z

res2df/rft.py

-            "Name of Eclipse DATA file or RFT file. "
-            "If DATA file is provided, it will look for"
-            " the associated DATA file"
+            "Name of reservoir .DATA file or RFT file. "


parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator or RFT file."

eivindjahren · 2023-11-21T10:55:32Z

res2df/summary.py

@@ -853,7 +856,7 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
        type=str,
        help=(
            "Filename of key-value parameter file to look for if -p is set, "
-            "relative to Eclipse DATA file or an absolute filename. "
+            "relative to reservoir .DATA file or an absolute filename. "


".DATA input file"

eivindjahren · 2023-11-21T10:55:45Z

res2df/summary.py

@@ -801,7 +804,7 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
    """
    parser.add_argument(
        "DATAFILE",
-        help="Name of Eclipse DATA file. " + "UNSMRY file must lie alongside.",
+        help="Name of reservoir .DATA file. UNSMRY file must lie alongside.",
    )


parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator. Must have UNSMRY file with same path and basename"

res2df/vfp/_vfp.py

eivindjahren · 2023-11-21T10:56:36Z

res2df/trans.py

@@ -259,7 +261,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
    """
    parser.add_argument(
        "DATAFILE",
-        help="Name of Eclipse DATA file. " + "INIT and EGRID file must lie alongside.",
+        help="Name of reservoir .DATA file. "


parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator. Must have .INIT and .EGRID files with same path and basename"

eivindjahren · 2023-11-21T10:58:08Z

res2df/grid.py

@@ -539,7 +540,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
    """
    parser.add_argument(
        "DATAFILE",
-        help="Name of Eclipse DATA file. " + "INIT and EGRID file must lie alongside.",
+        help="Name of reservoir .DATA file. "


".DATA input file"

res2df/gruptree.py

eivindjahren · 2023-11-21T11:00:36Z

res2df/grid.py

@@ -539,7 +540,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
    """
    parser.add_argument(
        "DATAFILE",
-        help="Name of Eclipse DATA file. " + "INIT and EGRID file must lie alongside.",
+        help="Name of reservoir .DATA file. "


parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator. There must exist .INIT and .EGRID files with the same path and basename."

eivindjahren · 2023-11-21T11:01:23Z

res2df/nnc.py

@@ -175,7 +178,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
    """
    parser.add_argument(
        "DATAFILE",
-        help="Name of Eclipse DATA file. " + "INIT and EGRID file must lie alongside.",
+        help="Name of reservoir .DATA file. "


parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator. There must exist .INIT and .EGRID files with the same path and basename."

eivindjahren · 2023-11-21T11:01:39Z

res2df/pillars.py

@@ -330,12 +332,12 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
    """
    parser.add_argument(
        "DATAFILE",
-        help=("Name of Eclipse DATA file. " "INIT and EGRID file must lie alongside."),
+        help=("Name of reservoir .DATA file. INIT and EGRID file must lie alongside."),


parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator. There must exist .INIT and .EGRID files with the same path and basename."

eivindjahren · 2023-11-21T11:02:09Z

res2df/pvt.py


    Arguments:
        parser (ArgumentParser or subparser): parser to fill with arguments
    """
    parser.add_argument(
-        "DATAFILE", help="Name of Eclipse DATA file or file with PVT keywords."
+        "DATAFILE", help="Name of reservoir .DATA file or file with PVT keywords."


parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator or include file with PVT keywords."

eivindjahren · 2023-11-21T11:03:16Z

res2df/satfunc.py

@@ -160,7 +161,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
        parser (ArgumentParser or subparser): parser to fill with arguments
    """
    parser.add_argument(
-        "DATAFILE", help="Name of Eclipse DATA file or file with saturation functions."
+        "DATAFILE",
+        help="Name of reservoir .DATA file or file with saturation functions.",


parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator or include file with saturation functions."

eivindjahren · 2023-11-21T11:06:02Z

res2df/wcon.py

@@ -80,7 +80,7 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
            fill with arguments
    """
    parser.add_argument(
-        "DATAFILE", help="Name of Eclipse DATA file or Eclipse include file."
+        "DATAFILE", help="Name of reservoir .DATA file or resdata include file."


parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator."

eivindjahren

Please squash and merge

yngve-sk force-pushed the rename-to-res2df branch 11 times, most recently from de8c659 to fceffb5 Compare November 14, 2023 10:46

yngve-sk force-pushed the rename-to-res2df branch 18 times, most recently from 8790e7e to 1888da7 Compare November 15, 2023 09:15

eivindjahren reviewed Nov 21, 2023

View reviewed changes

eivindjahren requested changes Nov 21, 2023

View reviewed changes

Yngve S. Kristiansen added 4 commits November 21, 2023 11:43

Clarify some glossary terms

763bee9

Reword description of compdat

b383910

Fix satfunc doc wording

00c0ea8

Fix wording UNSMRY files

71fc136

yngve-sk force-pushed the rename-to-res2df branch from f4de140 to 71fc136 Compare November 21, 2023 10:44

eivindjahren reviewed Nov 21, 2023

View reviewed changes

res2df/vfp/_vfp.py Show resolved Hide resolved

eivindjahren reviewed Nov 21, 2023

View reviewed changes

res2df/gruptree.py Show resolved Hide resolved

eivindjahren reviewed Nov 21, 2023

View reviewed changes

yngve-sk force-pushed the rename-to-res2df branch 4 times, most recently from 8f86f3b to 42abb6a Compare November 21, 2023 11:34

Reservoir .DATA file -> simulator input .DATA file

972b3ef

yngve-sk force-pushed the rename-to-res2df branch from 42abb6a to 972b3ef Compare November 21, 2023 11:35

eivindjahren approved these changes Nov 22, 2023

View reviewed changes

yngve-sk merged commit 75b2413 into master Nov 22, 2023
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename to res2df #462

Rename to res2df #462

yngve-sk commented Nov 14, 2023 •

edited

codecov-commenter commented Nov 14, 2023 •

edited

eivindjahren Nov 21, 2023

yngve-sk Nov 21, 2023

eivindjahren Nov 21, 2023

yngve-sk Nov 21, 2023

eivindjahren Nov 21, 2023

eivindjahren left a comment

eivindjahren Nov 21, 2023 •

edited

eivindjahren Nov 21, 2023 •

edited

eivindjahren Nov 21, 2023 •

edited

eivindjahren Nov 21, 2023 •

edited

eivindjahren Nov 21, 2023

eivindjahren Nov 21, 2023

eivindjahren Nov 21, 2023

eivindjahren Nov 21, 2023

eivindjahren Nov 21, 2023 •

edited

eivindjahren Nov 21, 2023

eivindjahren Nov 21, 2023

eivindjahren left a comment

Rename to res2df #462

Rename to res2df #462

Conversation

yngve-sk commented Nov 14, 2023 • edited

codecov-commenter commented Nov 14, 2023 • edited

Codecov Report

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

eivindjahren left a comment

Choose a reason for hiding this comment

eivindjahren Nov 21, 2023 • edited

Choose a reason for hiding this comment

eivindjahren Nov 21, 2023 • edited

Choose a reason for hiding this comment

eivindjahren Nov 21, 2023 • edited

Choose a reason for hiding this comment

eivindjahren Nov 21, 2023 • edited

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

eivindjahren Nov 21, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eivindjahren left a comment

Choose a reason for hiding this comment

yngve-sk commented Nov 14, 2023 •

edited

codecov-commenter commented Nov 14, 2023 •

edited

eivindjahren Nov 21, 2023 •

edited

eivindjahren Nov 21, 2023 •

edited

eivindjahren Nov 21, 2023 •

edited

eivindjahren Nov 21, 2023 •

edited

eivindjahren Nov 21, 2023 •

edited