Added new keyword to define geomodel name (#801)

* Added new keyword to define geomodel name

* update after review

Author: oddvarlia

src/subscript/field_statistics/field_statistics.py

@@ -37,7 +37,7 @@
 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 @@
 
     # 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 @@
         # 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 @@
         # 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,17 +612,20 @@ 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")
         subgrids = grid.subgrids if grid.subgrids else None
     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}"

tests/test_field_statistics.py

@@ -35,6 +35,7 @@
     "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 @@ def test_check_use_zones_errors(zone_code_names, zone_names, expected_error):
     "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 @@ def test_check_use_zones_errors(zone_code_names, zone_names, expected_error):
     "nreal": 10,
     "iterations": [0],
     "geogrid_fields": {
+        "geogrid_name": "geogrid",
         "zone_code_names": {
             1: "A",
             2: "B",
@@ -736,6 +748,7 @@ def test_check_use_zones_errors(zone_code_names, zone_names, expected_error):
     "nreal": 10,
     "iterations": [0],
     "geogrid_fields": {
+        "geogrid_name": "geogrid",
         "zone_code_names": {
             1: "A",
             2: "B",
@@ -761,6 +774,7 @@ def test_check_use_zones_errors(zone_code_names, zone_names, expected_error):
     "nreal": 10,
     "iterations": [0],
     "geogrid_fields": {
+        "geogrid_name": "geogrid",
         "zone_code_names": {
             1: "A",
             2: "B",
@@ -785,6 +799,7 @@ def test_check_use_zones_errors(zone_code_names, zone_names, expected_error):
     "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,
         _,

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"