From 42abb6a1c1a858741e09fdeb1cf995ff75ccc91f Mon Sep 17 00:00:00 2001 From: "Yngve S. Kristiansen" Date: Tue, 21 Nov 2023 12:16:42 +0100 Subject: [PATCH] Fixup DATAFILE descriptions --- res2df/grid.py | 4 ++-- res2df/nnc.py | 4 ++-- res2df/pillars.py | 3 ++- res2df/pvt.py | 4 +++- res2df/rft.py | 2 +- res2df/satfunc.py | 3 ++- res2df/summary.py | 5 +++-- res2df/trans.py | 4 ++-- res2df/wcon.py | 3 ++- res2df/wellcompletiondata.py | 3 ++- res2df/wellconnstatus.py | 3 ++- 11 files changed, 23 insertions(+), 15 deletions(-) diff --git a/res2df/grid.py b/res2df/grid.py index 407bd14a4..0a59fbf96 100644 --- a/res2df/grid.py +++ b/res2df/grid.py @@ -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", diff --git a/res2df/nnc.py b/res2df/nnc.py index 105cc7f53..9ced3ea6e 100644 --- a/res2df/nnc.py +++ b/res2df/nnc.py @@ -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", diff --git a/res2df/pillars.py b/res2df/pillars.py index 5d547a5c0..76e3d45f9 100644 --- a/res2df/pillars.py +++ b/res2df/pillars.py @@ -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", diff --git a/res2df/pvt.py b/res2df/pvt.py index 507c7d82c..c38222b0f 100644 --- a/res2df/pvt.py +++ b/res2df/pvt.py @@ -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", diff --git a/res2df/rft.py b/res2df/rft.py index 81569462b..ec8f4e4d8 100644 --- a/res2df/rft.py +++ b/res2df/rft.py @@ -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" ), diff --git a/res2df/satfunc.py b/res2df/satfunc.py index eea6949e0..c3aa62fb6 100644 --- a/res2df/satfunc.py +++ b/res2df/satfunc.py @@ -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", diff --git a/res2df/summary.py b/res2df/summary.py index 1d0144d00..4b67d3e58 100644 --- a/res2df/summary.py +++ b/res2df/summary.py @@ -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", @@ -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." ), diff --git a/res2df/trans.py b/res2df/trans.py index f9e0df277..f041917ed 100644 --- a/res2df/trans.py +++ b/res2df/trans.py @@ -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( diff --git a/res2df/wcon.py b/res2df/wcon.py index a1da585f6..35f261544 100644 --- a/res2df/wcon.py +++ b/res2df/wcon.py @@ -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" diff --git a/res2df/wellcompletiondata.py b/res2df/wellcompletiondata.py index 20b63891c..6922ba3b9 100644 --- a/res2df/wellcompletiondata.py +++ b/res2df/wellcompletiondata.py @@ -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", diff --git a/res2df/wellconnstatus.py b/res2df/wellconnstatus.py index 30affe072..69cf06706 100644 --- a/res2df/wellconnstatus.py +++ b/res2df/wellconnstatus.py @@ -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",