-
Notifications
You must be signed in to change notification settings - Fork 32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rename to res2df #462
Rename to res2df #462
Conversation
de8c659
to
fceffb5
Compare
Codecov ReportAttention:
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. |
8790e7e
to
1888da7
Compare
docs/introduction.rst
Outdated
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`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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`
|
||
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of "data decks" what is ment here is instead "complete .DATA file".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reworded wrt complete/incomplete data decks
Instead of complete :term:`decks <deck>`, individual include files may also be parsed, but
res2df/csv2res.py
Outdated
@@ -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", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just "Write UNSMRY files"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few more things.
f4de140
to
71fc136
Compare
res2df/rft.py
Outdated
"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. " |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator or RFT file."
res2df/summary.py
Outdated
@@ -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. " |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
".DATA input file"
@@ -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.", | |||
) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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/trans.py
Outdated
@@ -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. " |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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"
res2df/grid.py
Outdated
@@ -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. " |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
".DATA input file"
res2df/grid.py
Outdated
@@ -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. " |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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."
res2df/nnc.py
Outdated
@@ -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. " |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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."
res2df/pillars.py
Outdated
@@ -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."), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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."
res2df/pvt.py
Outdated
|
||
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." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator or include file with PVT keywords."
res2df/satfunc.py
Outdated
@@ -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.", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator or include file with saturation functions."
res2df/wcon.py
Outdated
@@ -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." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
parser.add_argument(
"DATAFILE", help="Name of the .DATA input file for the reservoir simulator."
8f86f3b
to
42abb6a
Compare
42abb6a
to
972b3ef
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please squash and merge
Resolves https://github.com/equinor/scout/issues/927