Skip to content

Commit

Permalink
Fixup DATAFILE descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
Yngve S. Kristiansen committed Nov 21, 2023
1 parent 1288b42 commit 42abb6a
Show file tree
Hide file tree
Showing 11 changed files with 23 additions and 15 deletions.
4 changes: 2 additions & 2 deletions res2df/grid.py
Original file line number Diff line number Diff line change
Expand Up @@ -540,8 +540,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
"""
parser.add_argument(
"DATAFILE",
help="Name of simulator input .DATA file. "
+ "INIT and EGRID file must lie alongside.",
help="Name of the .DATA input file for the reservoir simulator."
+ " There must exist .INIT and .EGRID files with the same path and basename.",
)
parser.add_argument(
"--vectors",
Expand Down
4 changes: 2 additions & 2 deletions res2df/nnc.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
"""
parser.add_argument(
"DATAFILE",
help="Name of simulator input .DATA file. "
+ "INIT and EGRID file must lie alongside.",
help="Name of the .DATA input file for the reservoir simulator."
+ " There must exist .INIT and .EGRID files with the same path and basename.",
)
parser.add_argument(
"-c",
Expand Down
3 changes: 2 additions & 1 deletion res2df/pillars.py
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
"""
parser.add_argument(
"DATAFILE",
help=("Name of simulator input .DATA file. INIT and EGRID file must lie alongside."),
help="Name of the .DATA input file for the reservoir simulator."
+ " There must exist .INIT and .EGRID files with the same path and basename.",
)
parser.add_argument(
"--region",
Expand Down
4 changes: 3 additions & 1 deletion res2df/pvt.py
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,9 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
parser (ArgumentParser or subparser): parser to fill with arguments
"""
parser.add_argument(
"DATAFILE", help="Name of simulator input .DATA file or file with PVT keywords."
"DATAFILE",
help="Name of the .DATA input file for the reservoir simulator,"
+ " or file with PVT keywords.",
)
parser.add_argument(
"-o",
Expand Down
2 changes: 1 addition & 1 deletion res2df/rft.py
Original file line number Diff line number Diff line change
Expand Up @@ -654,7 +654,7 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
parser.add_argument(
"DATAFILE",
help=(
"Name of simulator input .DATA file or RFT file. "
"Name of .DATA input file for the reservoir simulator, or RFT file. "
"If .DATA file is provided, it will look for"
" the associated .DATA file"
),
Expand Down
3 changes: 2 additions & 1 deletion res2df/satfunc.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
"""
parser.add_argument(
"DATAFILE",
help="Name of simulator input .DATA file or file with saturation functions.",
help="Name of .DATA input file for the reservoir simulator,"
+ " or file with saturation functions.",
)
parser.add_argument(
"-o",
Expand Down
5 changes: 3 additions & 2 deletions res2df/summary.py
Original file line number Diff line number Diff line change
Expand Up @@ -804,7 +804,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
"""
parser.add_argument(
"DATAFILE",
help="Name of simulator input .DATA file. UNSMRY file must lie alongside.",
help="Name of the .DATA input file for the reservoir simulator."
+ " There must exist a UNSMRY file with the same path and basename.",
)
parser.add_argument(
"--time_index",
Expand Down Expand Up @@ -856,7 +857,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 simulator input .DATA file or an absolute filename. "
"relative to simulator input (.DATA) file or an absolute filename. "
"If not supplied, parameters.{json,yml,txt} in "
"{., .. and ../..} will be merged in."
),
Expand Down
4 changes: 2 additions & 2 deletions res2df/trans.py
Original file line number Diff line number Diff line change
Expand Up @@ -261,8 +261,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
"""
parser.add_argument(
"DATAFILE",
help="Name of simulator input .DATA file. "
+ "INIT and EGRID file must lie alongside.",
help="Name of the .DATA input file for the reservoir simulator."
+ " There must exist INIT and EGRID files with the same path and basename.",
)
parser.add_argument("--vectors", nargs="+", help="Extra INIT vectors to be added")
parser.add_argument(
Expand Down
3 changes: 2 additions & 1 deletion res2df/wcon.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
fill with arguments
"""
parser.add_argument(
"DATAFILE", help="Name of simulator input .DATA file or resdata include file."
"DATAFILE",
help="Name of the .DATA input file or include file.",
)
parser.add_argument(
"-o", "--output", type=str, help="Name of output csv file.", default="wcon.csv"
Expand Down
3 changes: 2 additions & 1 deletion res2df/wellcompletiondata.py
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
parser.add_argument(
"DATAFILE",
type=str,
help="Name of simulator input .DATA file. UNSMRY file must lie alongside.",
help="Name of the .DATA input file for the reservoir simulator."
+ " There must exist a UNSMRY file with the same path and basename",
)
parser.add_argument(
"--zonemap",
Expand Down
3 changes: 2 additions & 1 deletion res2df/wellconnstatus.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
parser.add_argument(
"DATAFILE",
type=str,
help="Name of simulator input .DATA file. UNSMRY file must lie alongside.",
help="Name of the .DATA input file for the reservoir simulator."
+ " There must exist a UNSMRY file with the same path and basename.",
)
parser.add_argument(
"-o",
Expand Down

0 comments on commit 42abb6a

Please sign in to comment.