subscript 1.13.1__tar.gz → 1.14.0__tar.gz

{subscript-1.13.1 → subscript-1.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: subscript
-Version: 1.13.1
+Version: 1.14.0
 Summary: Equinor's collection of subsurface reservoir modelling scripts
 Author-email: Equinor <rnyb@equinor.com>
 License:                     GNU GENERAL PUBLIC LICENSE

{subscript-1.13.1 → subscript-1.14.0}/src/subscript/field_statistics/field_statistics.py

@@ -37,7 +37,7 @@ from field parameters using ERTBOX grid.
 The script reads ensembles of realizations from scratch disk  from
 <RUN_PATH> directory::
 
-  share/results/grids/geogrid--<propertyname>.roff.
+  share/results/grids/<geogridname>--<propertyname>.roff.
 
 Optionally also temporary field parameters coming from APS or petrophysical
 field parameters can be used to calculate mean and standard deviations.
@@ -172,9 +172,13 @@ EPILOGUE = """
 
     # Specify which geogrid fields to use
     # Geogrid fields are typically found in:
-    # <RUN_PATH>/share/results/grids/geogrid--<property-name>.roff
+    # <RUN_PATH>/share/results/grids/<geogridname>--<property-name>.roff
     # Optional keyword
     geogrid_fields:
+        # Prefix (name of geogrid) to be used for field parameters related to the
+        # geogrid.
+        geogrid_name: "geogrid"
+
         # Selected set of zone names to use in calculations of statistics.
         # Must be one or more of the defined zones.
         # Require at least one zone to be selected.
@@ -201,7 +205,7 @@ EPILOGUE = """
         # For each zone specify which discrete parameter to use to calculate
         # facies probability estimates.
         # Possible names are those found in the
-        # share/results/grids/geogrid--<name>.roff
+        # share/results/grids/<geogridname>--<name>.roff
         # files that are of discrete type.
         # This key can be omitted or some of the lines specifying parameters
         # for a zone if you don't want to use it.
@@ -213,7 +217,7 @@ EPILOGUE = """
         # For each zone specify which continuous parameter to use to
         # calculate estimate of mean and stdev over ensemble.
         # Possible names are those found in the
-        #  share/results/grids/geogrid--<name>.roff
+        #  share/results/grids/<geogridname>--<name>.roff
         # files that are of continuous type
         # This key can be omitted or some of the lines specifying
         # parameters for a zone if you don't want to use it.
@@ -608,9 +612,10 @@ def read_ensemble_realization(
     iter_number,
     property_param_name,
     zone_code_names,
+    geogrid_name,
 ):
     realization_path = Path(f"realization-{realization_number}/iter-{iter_number}")
-    grid_path = Path("share/results/grids/geogrid.roff")
+    grid_path = Path("share/results/grids/" + geogrid_name + ".roff")
     file_path_grid = Path(ensemble_path) / realization_path / grid_path
     if file_path_grid.exists():
         grid = xtgeo.grid_from_file(file_path_grid, fformat="roff")
@@ -618,7 +623,9 @@ def read_ensemble_realization(
     else:
         return None, None, None
 
-    property_path = Path(f"share/results/grids/geogrid--{property_param_name}.roff")
+    property_path = Path(
+        "share/results/grids/" + geogrid_name + f"--{property_param_name}.roff"
+    )
     file_path_property = Path(ensemble_path) / realization_path / property_path
     property_param = xtgeo.gridproperty_from_file(file_path_property, fformat="roff")
 
@@ -635,9 +642,10 @@ def read_geogrid_realization(
     realization_number,
     iter_number,
     zone_code_names,
+    geogrid_name,
 ):
     realization_path = Path(f"realization-{realization_number}/iter-{iter_number}")
-    grid_path = Path("share/results/grids/geogrid.roff")
+    grid_path = Path("share/results/grids/" + geogrid_name + ".roff")
     file_path_grid = Path(ensemble_path) / realization_path / grid_path
     if file_path_grid.exists():
         grid = xtgeo.grid_from_file(file_path_grid, fformat="roff")
@@ -778,6 +786,7 @@ def write_mean_stdev_nactive(
     result_path,
     ens_path,
     zone_code_names,
+    geogrid_name,
     copy_to_geogrid_realization=False,
 ):
     output_path = result_path
@@ -826,7 +835,11 @@ def write_mean_stdev_nactive(
         # Use realization number 0
         real_number = 0
         geogrid_dimensions, geogrid_subgrids = read_geogrid_realization(
-            ens_path, real_number, iter_number, zone_code_names
+            ens_path,
+            real_number,
+            iter_number,
+            zone_code_names,
+            geogrid_name,
         )
 
         ertbox_to_geogrid_statistics(
@@ -839,6 +852,7 @@ def write_mean_stdev_nactive(
             ertbox_dims,
             conformity,
             ens_path,
+            geogrid_name,
             param_name=param_name,
         )
 
@@ -852,6 +866,7 @@ def write_mean_stdev_nactive(
             ertbox_dims,
             conformity,
             ens_path,
+            geogrid_name,
             param_name=param_name,
         )
 
@@ -875,13 +890,14 @@ def ertbox_to_geogrid_statistics(
     ertbox_dimensions,
     zone_conformity,
     ens_path,
+    geogrid_name,
     param_name=None,
     facies_name=None,
 ):
     if param_name:
-        geogrid_stat_name = f"geogrid--{statistics_name}_{param_name}"
+        geogrid_stat_name = f"{geogrid_name}--{statistics_name}_{param_name}"
     if facies_name:
-        geogrid_stat_name = f"geogrid--{statistics_name}_{facies_name}"
+        geogrid_stat_name = f"{geogrid_name}--{statistics_name}_{facies_name}"
     assert (param_name is not None) or (facies_name is not None)
     geogrid_stat_file_name = (
         ens_path
@@ -930,6 +946,7 @@ def write_fraction_nactive(
     result_path,
     ens_path,
     zone_code_names,
+    geogrid_name,
     ncount_active_values=None,
     copy_to_geogrid_realization=False,
 ):
@@ -979,7 +996,11 @@ def write_fraction_nactive(
         # Use realization number 0
         real_number = 0
         geogrid_dimensions, geogrid_subgrids = read_geogrid_realization(
-            ens_path, real_number, iter_number, zone_code_names
+            ens_path,
+            real_number,
+            iter_number,
+            zone_code_names,
+            geogrid_name,
         )
         ertbox_to_geogrid_statistics(
             "prob",
@@ -991,6 +1012,7 @@ def write_fraction_nactive(
             ertbox_dimensions,
             conformity,
             ens_path,
+            geogrid_name,
             facies_name=facies_name,
         )
 
@@ -1042,6 +1064,14 @@ def get_specifications(input_dict, ertbox_size, ert_config_path):
         use_geogrid_fields = True
         geogrid_fields_dict = input_dict["geogrid_fields"]
 
+        key = "geogrid_name"
+        if key in geogrid_fields_dict:
+            geogrid_name = geogrid_fields_dict[key]
+            geogrid_name = geogrid_name.strip()
+        else:
+            # Set default
+            geogrid_name = "geogrid"
+
         key = "zone_code_names"
         if key in geogrid_fields_dict:
             zone_code_names = geogrid_fields_dict[key]
@@ -1119,6 +1149,7 @@ def get_specifications(input_dict, ertbox_size, ert_config_path):
         zone_names_used,
         zone_conformity,
         zone_code_names,
+        geogrid_name,
         param_name_dict,
         disc_param_name_dict,
         init_path,
@@ -1254,6 +1285,7 @@ def calc_stats(
         zone_names,
         zone_conformity,
         zone_code_names,
+        geogrid_name,
         param_name_dict,
         disc_param_name_dict,
         _,
@@ -1290,6 +1322,7 @@ def calc_stats(
                                 iter_number,
                                 param_name,
                                 zone_code_names,
+                                geogrid_name,
                             )
                         )
                         if grid_dimensions is None:
@@ -1342,6 +1375,7 @@ def calc_stats(
                             result_path,
                             ens_path,
                             zone_code_names,
+                            geogrid_name,
                             copy_to_geogrid_realization=copy_to_geogrid_realization,
                         )
                         has_written_nactive = True
@@ -1377,6 +1411,7 @@ def calc_stats(
                                 iter_number,
                                 param_name,
                                 zone_code_names,
+                                geogrid_name,
                             )
                         )
 
@@ -1439,6 +1474,7 @@ def calc_stats(
                                     result_path,
                                     ens_path,
                                     zone_code_names,
+                                    geogrid_name,
                                     ncount_active_values=sum_active,
                                     copy_to_geogrid_realization=copy_to_geogrid_realization,
                                 )
@@ -1453,6 +1489,7 @@ def calc_stats(
                                     result_path,
                                     ens_path,
                                     zone_code_names,
+                                    geogrid_name,
                                     copy_to_geogrid_realization=copy_to_geogrid_realization,
                                 )
                         txt4 = f"  Sum facies volume fraction: {sum_fraction}"

{subscript-1.13.1 → subscript-1.14.0}/src/subscript/prtvol2csv/prtvol2csv.py

@@ -5,6 +5,7 @@ import argparse
 import logging
 import re
 import warnings
+from datetime import datetime
 from pathlib import Path
 from typing import Optional
 
@@ -96,7 +97,7 @@ def get_parser() -> argparse.ArgumentParser:
     return parser
 
 
-def prep_output_dir(tablesdir: Optional[str], suffix: Optional[str]) -> Path:
+def prep_output_dir(tablesdir: Optional[str]) -> Path:
     """Ensures an output directory exists, and returns
     the name of the directory.
 
@@ -105,16 +106,12 @@ def prep_output_dir(tablesdir: Optional[str], suffix: Optional[str]) -> Path:
 
     Args:
         tablesdir (str): Directory to create. Default is share/results/volumes.
-        suffix (str): If nonempty, added to the results-part in tablesdir.
 
     Returns:
         str: The directory that was ensured existed.
     """
     if not tablesdir:
-        if not suffix or suffix == "":
-            tablesdir = "share/results/volumes/"  # FMU standard
-        else:
-            tablesdir = "share/results-" + suffix + "/volumes"
+        tablesdir = "share/results/volumes/"  # FMU standard
     if not Path(tablesdir).is_dir():
         warnings.warn(
             (
@@ -203,6 +200,53 @@ def currently_in_place_from_prt(
     inplace_df.index.name = fipname  # Use "FIPNUM" if not handled by Webviz
 
     logger.info("Extracted CURRENTLY IN PLACE from %s at date %s", prt_file, date_str)
+
+    # Find the initial date from the PRT file, to compare with date for report extracted
+    # Eclipse: Look for "  REPORT   0" at start of line (OBS! Not very robust)
+    date_matcher_ecl = re.compile(r"^\s{2}REPORT\s{3}0")
+    # Flow: Look for "Report step  0" at start of line
+    date_matcher_flow = re.compile(r"^Report step\s{2}0")
+
+    with Path(prt_file).open(encoding="utf8") as f_handle:
+        for line in f_handle:
+            if date_matcher_ecl.search(line) is not None:
+                line_split = line.split("*")
+                initial_date_string = line_split[0].rstrip().split("  ")[-1]
+                initial_date_object = datetime.strptime(
+                    initial_date_string, "%d %b %Y"
+                ).date()
+                logger.info(
+                    f"Initial date is {initial_date_object}, report date is {date_str}"
+                )
+                initial_date_found = True
+                break
+            if date_matcher_flow.search(line) is not None:
+                line_split = line.split("=")
+                initial_date_string = line_split[-1].strip()
+                initial_date_object = datetime.strptime(
+                    initial_date_string, "%d-%b-%Y"
+                ).date()
+                logger.info(
+                    f"Initial date is {initial_date_object}, report date is {date_str}"
+                )
+                initial_date_found = True
+                break
+
+    if initial_date_found and (date_str > initial_date_object):
+        warnings.warn(
+            (
+                "The volume report extracted is not at initial time. \n The volume "
+                f"report is from {date_str}, which is later than start of simulation "
+                f"({initial_date_object})."
+            ),
+            UserWarning,
+        )
+    elif not initial_date_found:
+        warnings.warn(
+            ("Cannot determine if volume report is at initial time."),
+            UserWarning,
+        )
+
     return inplace_df
 
 
@@ -289,7 +333,7 @@ def main() -> None:
     """Function for command line invocation"""
     args = get_parser().parse_args()
 
-    tablesdir = prep_output_dir(args.dir, "")
+    tablesdir = prep_output_dir(args.dir)
 
     if args.dir != ".":
         logger.warning(

{subscript-1.13.1 → subscript-1.14.0}/src/subscript/version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '1.13.1'
-__version_tuple__ = version_tuple = (1, 13, 1)
+__version__ = version = '1.14.0'
+__version_tuple__ = version_tuple = (1, 14, 0)
+
+__commit_id__ = commit_id = 'gc174caf25'

{subscript-1.13.1 → subscript-1.14.0}/src/subscript.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: subscript
-Version: 1.13.1
+Version: 1.14.0
 Summary: Equinor's collection of subsurface reservoir modelling scripts
 Author-email: Equinor <rnyb@equinor.com>
 License:                     GNU GENERAL PUBLIC LICENSE

{subscript-1.13.1 → subscript-1.14.0}/src/subscript.egg-info/SOURCES.txt

@@ -367,6 +367,8 @@ tests/testdata_prtvol2csv/0readme.txt
 tests/testdata_prtvol2csv/DROGON_FIPNUM.PRT
 tests/testdata_prtvol2csv/DROGON_FIPZON.PRT
 tests/testdata_prtvol2csv/DROGON_INACTIVE_FIPNUM.PRT
+tests/testdata_prtvol2csv/DROGON_NO_INITIAL_BALANCE.PRT
+tests/testdata_prtvol2csv/DROGON_NO_INITIAL_BALANCE_FLOW.PRT
 tests/testdata_ri_wellmod/drogon_wells_noicd.rsp
 tests/testdata_ri_wellmod/ri_reek_wells.rsp
 tests/testdata_ri_wellmod/drogon_include/grid/drogon.grid.grdecl

{subscript-1.13.1 → subscript-1.14.0}/tests/test_field_statistics.py

@@ -35,6 +35,7 @@ CONFIG_DICT = {
     "iterations": [0, 3],
     "use_population_stdev": False,
     "geogrid_fields": {
+        "geogrid_name": "my_geogrid",
         "use_zones": ["A", "B", "C"],
         "zone_code_names": {
             1: "A",
@@ -74,7 +75,7 @@ def make_box_grid(dimensions, grid_name, result_path):
     grid.to_file(filename_egrid, fformat="egrid")
 
 
-def make_file_names(ensemble_path, iter_number, real_number, param_name):
+def make_file_names(ensemble_path, iter_number, real_number, param_name, geogrid_name):
     filedir = ensemble_path / Path("realization-" + str(real_number))
     if not filedir.exists():
         filedir.mkdir()
@@ -90,9 +91,9 @@ def make_file_names(ensemble_path, iter_number, real_number, param_name):
     filedir = filedir / Path("grids")
     if not filedir.exists():
         filedir.mkdir()
-    filename = filedir / Path("geogrid--" + param_name + ".roff")
-    filename_active = filedir / Path("geogrid--active.roff")
-    filename_grid = filedir / Path("geogrid.roff")
+    filename = filedir / Path(f"{geogrid_name}--" + param_name + ".roff")
+    filename_active = filedir / Path(f"{geogrid_name}--active.roff")
+    filename_grid = filedir / Path(f"{geogrid_name}.roff")
     return filename, filename_active, filename_grid
 
 
@@ -110,6 +111,7 @@ def make_ensemble_test_data(
 
     iteration_list = [0, 3]
     zone_code_names = config_dict["geogrid_fields"]["zone_code_names"]
+    geogrid_name = config_dict["geogrid_fields"]["geogrid_name"]
     discrete_param_name_per_zone = config_dict["geogrid_fields"][
         "discrete_property_param_per_zone"
     ]
@@ -138,7 +140,11 @@ def make_ensemble_test_data(
                             (nx, ny, 3 * nz_ertbox), dtype=np.float32
                         )
                         filename, filename_active, filename_grid = make_file_names(
-                            ensemble_path, iter_number, real_number, param_name
+                            ensemble_path,
+                            iter_number,
+                            real_number,
+                            param_name,
+                            geogrid_name,
                         )
                         values = assign_values_continuous_param(
                             nz_ertbox,
@@ -195,7 +201,11 @@ def make_ensemble_test_data(
                             (nx, ny, 3 * nz_ertbox), dtype=np.uint8
                         )
                         filename, filename_active, filename_grid = make_file_names(
-                            ensemble_path, iter_number, real_number, param_name
+                            ensemble_path,
+                            iter_number,
+                            real_number,
+                            param_name,
+                            geogrid_name,
                         )
 
                         values, code_names = assign_values_discrete_param(
@@ -683,6 +693,7 @@ CONFIG_DICT_REF = {
     "nreal": 10,
     "iterations": [0, 3],
     "geogrid_fields": {
+        "geogrid_name": "my_geogrid",
         "use_zones": ["A", "B", "C"],
         "zone_code_names": {
             1: "A",
@@ -713,6 +724,7 @@ CONFIG_A = {
     "nreal": 10,
     "iterations": [0],
     "geogrid_fields": {
+        "geogrid_name": "geogrid",
         "zone_code_names": {
             1: "A",
             2: "B",
@@ -736,6 +748,7 @@ CONFIG_A_REF = {
     "nreal": 10,
     "iterations": [0],
     "geogrid_fields": {
+        "geogrid_name": "geogrid",
         "zone_code_names": {
             1: "A",
             2: "B",
@@ -761,6 +774,7 @@ CONFIG_B = {
     "nreal": 10,
     "iterations": [0],
     "geogrid_fields": {
+        "geogrid_name": "geogrid",
         "zone_code_names": {
             1: "A",
             2: "B",
@@ -785,6 +799,7 @@ CONFIG_B_REF = {
     "nreal": 10,
     "iterations": [0],
     "geogrid_fields": {
+        "geogrid_name": "geogrid",
         "zone_code_names": {
             1: "A",
             2: "B",
@@ -884,6 +899,7 @@ def test_get_specification(
         zone_names,
         zone_conformity,
         zone_code_names,
+        geogrid_name,
         param_name_dict,
         disc_param_name_dict,
         _,

{subscript-1.13.1 → subscript-1.14.0}/tests/test_prtvol2csv.py

@@ -569,6 +569,36 @@ def test_inactive_fipnum(tmp_path, mocker):
     assert dframe.loc[dframe["FIPNUM"].idxmax(), "HCPV_TOTAL"] != 0
 
 
+def test_warning_not_initial(tmp_path, mocker):
+    """Test that the warning about not inital volume report is triggered"""
+
+    # with Eclipse PRT file, BALANCE report only
+    prtfile_ecl = TEST_PRT_DATADIR / "DROGON_NO_INITIAL_BALANCE.PRT"
+
+    # with OPM Flow PRT file, BALANCE, BALZON (for FIPZON), RESERVOIR VOLUME reports
+    prtfile_flow = TEST_PRT_DATADIR / "DROGON_NO_INITIAL_BALANCE_FLOW.PRT"
+
+    os.chdir(tmp_path)
+
+    with pytest.warns(UserWarning, match="not at initial time") as warnings_record:
+        mocker.patch(
+            "sys.argv",
+            ["prtvol2csv", "--debug", "--dir", ".", str(prtfile_ecl)],
+        )
+        prtvol2csv.main()
+
+        mocker.patch(
+            "sys.argv",
+            ["prtvol2csv", "--debug", "--dir", ".", str(prtfile_flow)],
+        )
+        prtvol2csv.main()
+
+        # Extra output for debugging, if test fails
+        for i, warning in enumerate(warnings_record):
+            print(f"{i + 1} Recorded warnings: {warning.message}")
+    assert len(warnings_record) == 2
+
+
 def test_find_prtfile(tmp_path):
     """Test location service for PRT files"""
     os.chdir(tmp_path)

{subscript-1.13.1 → subscript-1.14.0}/tests/testdata_field_statistics/config_example.yml

@@ -2,6 +2,7 @@ field_stat:
     nreal: 10
     iterations: [0, 3]
     geogrid_fields:
+        geogrid_name: "my_geogrid"
         use_zones: ["A", "B", "C"]
         zone_code_names:
             1: "A"

subscript-1.14.0/tests/testdata_prtvol2csv/0readme.txt

@@ -0,0 +1,17 @@
+Folder:  subscript/tests/testdata_prtvol2csv
+This folder contains test data for testdata_prtvol2csv.py
+
+Print files (.PRT) from Eclipse, 
+made with RPTSOL keyword with FIP=2 and FIP=3,
+and in addition FIPRESV for reservoir volumes.
+
+Both PRT files have reservoir volumes.
+One additional FIP vector in the second file, named FIPZON.
+
+DROGON_FIPNUM.PRT       - Eclipse version 2022.2, FIP=2 (FIPNUM only, 4 reports)
+DROGON_FIPZON.PRT       - Eclipse version 2022.2, FIP=3 (all FIP-vectors)
+DROGON_INACTIVE_FIPNUM.PRT -  with FIPNUM 5 as inactive
+DROGON_NO_INITIAL_BALANCE.PRT       - Eclipse version 2025.1, FIP=2 (FIPNUM only, no initial BALANCE report)
+                                    first BALANCE report after 6 months, no RESERVOIR VOLUMES reports
+DROGON_NO_INITIAL_BALANCE_FLOW.PRT  - OPM Flow version 2025.10-pre, no initial BALANCE report
+                                    FIP=3 (FIP*, all FIP vectors, one RESERVOIR VOLUMES report)