fmu-pem 0.0.3__py3-none-any.whl → 0.0.4__py3-none-any.whl

fmu/pem/__init__.py

@@ -11,9 +11,11 @@ except (ImportError, ModuleNotFoundError):
 else:
     INTERNAL_EQUINOR = True
 
+from .__main__ import main as pem
 from .run_pem import pem_fcn
 
 __all__ = [
     "pem_fcn",
+    "pem",
     "INTERNAL_EQUINOR",
 ]

fmu/pem/__main__.py

@@ -1,13 +1,17 @@
 # pylint: disable=missing-module-docstring
 import argparse
+import sys
 from pathlib import Path
+from typing import Any
 from warnings import warn
 
-from .pem_utilities import restore_dir
+from .pem_utilities import get_global_params_and_dates, read_pem_config, restore_dir
 from .run_pem import pem_fcn
 
 
-def main():
+def main(args_list=None):
+    if args_list is None:
+        args_list = sys.argv[1:]
     parser = argparse.ArgumentParser(__file__)
     parser.add_argument(
         "-c",
@@ -45,7 +49,29 @@ def main():
         help="For ERT run: Absolute directory name for model file, pre-experiment. Not "
         "needed for command line run",
     )
-    args = parser.parse_args()
+    parser.add_argument(
+        "-q",
+        "--mod-date-prefix",
+        type=str,
+        required=True,
+        help="Global seismic section: Prefix for seismic dates for modelled data",
+    )
+    parser.add_argument(
+        "-r",
+        "--run-from-rms",
+        type=bool,
+        required=False,
+        default=False,
+        help="Is PEM run as part of an RMS workflow?",
+    )
+    parser.add_argument(
+        "-s",
+        "--rms-project",
+        required=False,
+        default=None,
+        help="In case PEM is called from RMS: RMS project",
+    )
+    args = parser.parse_args(args_list)
     cwd = args.config_dir.absolute()
     if str(cwd).endswith("sim2seis/model"):
         run_folder = cwd
@@ -57,11 +83,22 @@ def main():
             warn(f"PEM model should be run from the sim2seis/model folder. {e}")
             run_folder = cwd
     with restore_dir(run_folder):
+        # Read and validate all PEM parameters
+        config = read_pem_config(yaml_file=run_folder / args.config_file)
+
+        # Read necessary part of global configurations and parameters
+        config.update_with_global(
+            get_global_params_and_dates(
+                global_config_dir=(run_folder / args.global_dir).resolve(),
+                global_conf_file=args.global_file,
+                mod_prefix=args.mod_date_prefix,
+            )
+        )
         pem_fcn(
+            config=config,
             config_dir=run_folder,
-            pem_config_file_name=args.config_file,
-            global_config_dir=args.global_dir,
-            global_config_file=args.global_file,
+            run_from_rms=args.run_from_rms,
+            proj=args.rms_project,
         )
 
 

fmu/pem/forward_models/pem_model.py

@@ -29,6 +29,8 @@ class PetroElasticModel(ForwardModelStepPlugin):
                 "<GLOBAL_FILE>",
                 "--model-dir",
                 "<MODEL_DIR>",
+                "--mod-date-prefix",
+                "<MOD_DATE_PREFIX>",
             ],
         )
 
@@ -40,6 +42,7 @@ class PetroElasticModel(ForwardModelStepPlugin):
     def validate_pre_experiment(self, fm_step_json: ForwardModelStepJSON) -> None:
         # Parse YAML parameter file by pydantic pre-experiment to catch errors at an
         # early stage
+
         config_file = Path(fm_step_json["argList"][3])
         model_dir = Path(fm_step_json["argList"][9])
         try:
@@ -58,7 +61,7 @@ class PetroElasticModel(ForwardModelStepPlugin):
             examples="""
 .. code-block:: console
 
-  FORWARD_MODEL PEM(<CONFIG_DIR>=../../sim2seis/model, <CONFIG_FILE>=new_pem.yml, <GLOBAL_DiR>=../../fmuconfig/output, <GLOBAL_FILE>=global_variables.yml, <MODEL_DIR>=/my_fmu_structure/sim2seis/model)
+  FORWARD_MODEL PEM(<CONFIG_DIR>=../../sim2seis/model, <CONFIG_FILE>=new_pem.yml, <GLOBAL_DiR>=../../fmuconfig/output, <GLOBAL_FILE>=global_variables.yml, <MODEL_DIR>=/my_fmu_structure/sim2seis/model, <MOD_DATE_PREFIX>=HIST)
 
 """,  # noqa: E501,
         )

fmu/pem/pem_utilities/__init__.py

@@ -30,7 +30,6 @@ from .pem_config_validation import (
     MineralProperties,
     PemConfig,
     RockMatrixProperties,
-    possible_date_string,
 )
 from .update_grid import update_inactive_grid_cells
 from .utils import (
@@ -66,7 +65,6 @@ __all__ = [
     "input_num_string_to_list",
     "missing_num_areas",
     "num_boolean_array",
-    "possible_date_string",
     "read_pem_config",
     "read_sim_grid_props",
     "restore_dir",

fmu/pem/pem_utilities/import_config.py

@@ -45,6 +45,8 @@ def find_key_first(d: dict, key: str) -> str | None:
 def get_global_params_and_dates(
     global_config_dir: Path,
     global_conf_file: Path,
+    mod_prefix: str | None = None,
+    obs_prefix: str | None = None,
 ) -> dict:
     """Read global configuration parameters, simulation model dates and seismic dates
     for difference calculation
@@ -58,35 +60,41 @@ def get_global_params_and_dates(
         list of tuples with
                 strings of dates to calculate difference properties
     """
-    global_config_par = yaml_load(str(global_config_dir / global_conf_file))
-    # check if 'HIST' or 'PRED' is used
-    if "SEISMIC_PRED_DATES" in global_config_par["global"]["dates"]:
-        date_str = "SEISMIC_PRED_DATES"
-    else:
-        date_str = "SEISMIC_HIST_DATES"
-    if "SEISMIC_PRED_DIFFDATES" in global_config_par["global"]["dates"]:
-        diff_str = "SEISMIC_PRED_DIFFDATES"
-    else:
-        diff_str = "SEISMIC_HIST_DIFFDATES"
-    seismic_dates = [
-        str(sdate).replace("-", "")
-        for sdate in global_config_par["global"]["dates"][date_str]
-    ]
-    diff_dates = [
-        [str(sdate).replace("-", "") for sdate in datepairs]
-        for datepairs in global_config_par["global"]["dates"][diff_str]
-    ]
+    global_config_par = yaml_load(
+        str(global_config_dir / global_conf_file),
+    )
     grid_model_name = find_key_first(global_config_par["global"], "ECLGRIDNAME_PEM")
     if grid_model_name is None:
         raise ValueError(
             f"{__file__}: no value for ECLGRIDNAME_PEM in global config file"
         )
-    return {
-        "grid_model": grid_model_name,
-        "seis_dates": seismic_dates,
-        "diff_dates": diff_dates,
+    # Find the correct seismic dates references
+    dates_config = global_config_par["global"]["dates"]
+    return_dict = {
         "global_config": global_config_par,
+        "grid_model": grid_model_name,
+        "seismic": global_config_par["global"]["seismic"],
     }
+    if mod_prefix:
+        return_dict.update(
+            {
+                "mod_dates": dates_config.get(f"SEISMIC_{mod_prefix}_DATES", None),
+                "mod_diffdates": dates_config.get(
+                    f"SEISMIC_{mod_prefix}_DIFFDATES", None
+                ),
+            }
+        )
+    if obs_prefix:
+        return_dict.update(
+            {
+                "obs_dates": dates_config.get(f"SEISMIC_{obs_prefix}_DATES", None),
+                "obs_diffdates": dates_config.get(
+                    f"SEISMIC_{obs_prefix}_DIFFDATES", None
+                ),
+            }
+        )
+
+    return return_dict
 
 
 def read_pem_config(yaml_file: Path) -> PemConfig:

fmu/pem/pem_utilities/pem_config_validation.py

@@ -5,6 +5,7 @@ from typing import Any, Self
 
 import numpy as np
 from pydantic import (
+    AliasChoices,
     BaseModel,
     ConfigDict,
     DirectoryPath,
@@ -15,6 +16,7 @@ from pydantic import (
 from pydantic.json_schema import SkipJsonSchema
 from pydantic_core.core_schema import ValidationInfo
 
+from fmu.datamodels.fmu_results.global_configuration import GlobalConfiguration
 from fmu.pem import INTERNAL_EQUINOR
 
 from .enum_defs import (
@@ -556,53 +558,51 @@ class Fluids(BaseModel):
         return v
 
 
-def possible_date_string(date_strings: list[str]) -> bool:
-    """
-    Validate a list of date strings in YYYYMMDD format.
+def date_to_string(date_obj: date) -> str:
+    return date_obj.strftime(format="%Y%m%d")
 
-    Args:
-        date_strings: list of strings to validate
 
-    Returns:
-        bool: True if all strings are valid dates
+class SeismicSurvey(BaseModel):
+    ecldate: list[str]
+    time: dict[str, str] | None = None
+    depth: dict[str, str] | None = None
 
-    Raises:
-        ValueError: If any string is not a valid date in YYYYMMDD format
-    """
-    for date_string in date_strings:
-        if len(date_string) != 8:
-            raise ValueError(
-                f"Invalid date format: '{date_string}' must be exactly 8 characters"
-            )
-        try:
-            date(
-                year=int(date_string[0:4]),
-                month=int(date_string[4:6]),
-                day=int(date_string[6:]),
-            )
-        except ValueError:
-            raise ValueError(
-                f"Invalid date: '{date_string}' must be a valid date in YYYYMMDD format"
-            )
-    return True
+    @field_validator("ecldate", mode="before")
+    def convert_ecldate_strings(cls, v: list[date]) -> list[str]:
+        return [date_to_string(date) for date in v]
 
 
-class FromGlobal(BaseModel):
-    grid_model: str
-    seis_dates: list[str]
-    diff_dates: list[list[str]]
-    global_config: dict[str, Any]
+class SeismicSection(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
 
-    @field_validator("seis_dates", mode="before")
-    def check_date_string(cls, v: list[str]) -> list[str]:
-        possible_date_string(v)
-        return v
+    templatecube_4d: str = Field(
+        validation_alias=AliasChoices("4d_templatecube", "templatecube_4d"),
+        serialization_alias="4d_templatecube",
+    )
+    real_4d_cropped_path: Path
+    real_4d: dict[str, SeismicSurvey]
 
-    @field_validator("diff_dates", mode="before")
-    def check_diffdate_string(cls, v: list[list[str]]) -> list[list[str]]:
-        for ll in v:
-            possible_date_string(ll)
-        return v
+
+class FromGlobal(BaseModel):
+    grid_model: str
+    mod_dates: list[str] | None = None
+    mod_diffdates: list[list[str]] | None = None
+    obs_dates: list[str] | None = None
+    obs_diffdates: list[list[str]] | None = None
+    seismic: SeismicSection
+    global_config: GlobalConfiguration
+
+    @field_validator("mod_dates", "obs_dates", mode="before")
+    def make_date_strings(cls, v: list[date]) -> list[str] | None:
+        if v:
+            return [date_to_string(date) for date in v]
+        return None
+
+    @field_validator("mod_diffdates", "obs_diffdates", mode="before")
+    def make_diffdate_strings(cls, v: list[list[str]]) -> list[list[str]] | None:
+        if v:
+            return [[date_to_string(date) for date in diffdate] for diffdate in v]
+        return None
 
 
 class PemPaths(BaseModel):

fmu/pem/run_pem.py

@@ -6,10 +6,8 @@ from fmu.pem import pem_utilities as pem_utils
 
 
 def pem_fcn(
+    config: pem_utils.PemConfig,
     config_dir: Path,
-    pem_config_file_name: Path,
-    global_config_dir: Path,
-    global_config_file: Path,
     run_from_rms=False,
     proj=None,
 ) -> None:
@@ -18,24 +16,13 @@ def pem_fcn(
     yaml-file control the selections made in the PEM.
 
     """
-    # Read and validate all PEM parameters
-    config = pem_utils.read_pem_config(yaml_file=config_dir / pem_config_file_name)
-
-    # Read necessary part of global configurations and parameters
-    config.update_with_global(
-        pem_utils.get_global_params_and_dates(
-            global_config_dir=(config_dir / global_config_dir).resolve(),
-            global_conf_file=global_config_file,
-        )
-    )
-
     # Import Eclipse simulation grid - INIT and RESTART
     sim_grid, constant_props, time_step_props = pem_utils.read_sim_grid_props(
         rel_dir_sim_files=config.eclipse_files.rel_path_simgrid,
         egrid_file=config.eclipse_files.egrid_file,
         init_property_file=config.eclipse_files.init_property_file,
         restart_property_file=config.eclipse_files.restart_property_file,
-        seis_dates=config.global_params.seis_dates,
+        seis_dates=config.global_params.mod_dates,
         fipnum_name=config.alternative_fipnum_name,
     )
 
@@ -65,7 +52,7 @@ def pem_fcn(
         sim_rst=time_step_props,
         matrix_props=matrix_properties,
         fluid_props=fluid_properties,
-        sim_dates=config.global_params.seis_dates,
+        sim_dates=config.global_params.mod_dates,
         fipnum=constant_props.fipnum,
     )
 
@@ -89,8 +76,8 @@ def pem_fcn(
     # Calculate difference properties. Possible properties are all that vary with time
     diff_props, diff_date_strs = pem_utils.calculate_diff_properties(
         props=[time_step_props, eff_pres, sat_rock_props, sum_delta_time],
-        diff_dates=config.global_params.diff_dates,
-        seis_dates=config.global_params.seis_dates,
+        diff_dates=config.global_params.mod_diffdates,
+        seis_dates=config.global_params.mod_dates,
         diff_calculation=config.diff_calculation,
     )
 
@@ -108,7 +95,7 @@ def pem_fcn(
         rms_project=proj,
         sim_grid=sim_grid,
         grid_name=config.global_params.grid_model,
-        seis_dates=config.global_params.seis_dates,
+        seis_dates=config.global_params.mod_dates,
         save_to_rms=config.results.save_results_to_rms,
         save_to_disk=config.results.save_results_to_disk,
         save_intermediate=config.results.save_intermediate_results,

fmu/pem/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.3'
-__version_tuple__ = version_tuple = (0, 0, 3)
+__version__ = version = '0.0.4'
+__version_tuple__ = version_tuple = (0, 0, 4)
 
 __commit_id__ = commit_id = None

{fmu_pem-0.0.3.dist-info → fmu_pem-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu-pem
-Version: 0.0.3
+Version: 0.0.4
 Summary: pem
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -695,6 +695,7 @@ Requires-Dist: xtgeo>=4.7.1
 Requires-Dist: fmu-tools
 Requires-Dist: fmu-config
 Requires-Dist: fmu-dataio
+Requires-Dist: fmu-datamodels
 Requires-Dist: rock-physics-open>=0.3.3
 Requires-Dist: PyYAML>=6.0.1
 Requires-Dist: pydantic

{fmu_pem-0.0.3.dist-info → fmu_pem-0.0.4.dist-info}/RECORD

@@ -1,10 +1,10 @@
 fmu/__init__.py,sha256=YWSE22UTDSocfqQHxEeXrRkdlA63t_aayQVdJkycwYs,83
-fmu/pem/__init__.py,sha256=FhNaFibcFZEK1Rz7IBRXBgxMHGNlcgrHaD4FtU4pDjs,421
-fmu/pem/__main__.py,sha256=hWYNOkn7gG6jUifHIXbG8ZJmUEDkv251v6OgiaR7rcY,1858
-fmu/pem/run_pem.py,sha256=aMkOHDNg3wtdiZueDAGogrxyVI8Sk2RYHWeSe9AJVXk,4727
-fmu/pem/version.py,sha256=pBZsQt6tlL02W-ri--X_4JCubpAK7jjCSnOmUp_isjc,704
+fmu/pem/__init__.py,sha256=k-KRNGtW24pTPQv81c5DOYbW9Thy5xv514euStVRYtY,466
+fmu/pem/__main__.py,sha256=43ugEF49aHi33Yv5CSWo8NPfzKsZAhHQrc5_IfnIoEI,3013
+fmu/pem/run_pem.py,sha256=wmGTyQyh8wws5PwouiJf-rtvmrTu3-rzqQSuutEcXx4,4256
+fmu/pem/version.py,sha256=QlXZ5JTjE_pgpDaeHk0GTExkc75xUZFmd0hA7kGYCJ0,704
 fmu/pem/forward_models/__init__.py,sha256=WuN66rmgfqrekCy3Ss9NHqsy-lZ4WGY-4VZa3jYDV2s,117
-fmu/pem/forward_models/pem_model.py,sha256=Hj7ueEu5bOKA84ldx1oKEqOntBKYySmY0Y6Z7ghZPeI,2025
+fmu/pem/forward_models/pem_model.py,sha256=7aZOmW8IOolQLLIPNWPizciDDDe8QMUsFSyJhmU1G80,2124
 fmu/pem/hook_implementations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fmu/pem/hook_implementations/jobs.py,sha256=IQW5m7oeZ_MiemxXv-UGLCPeo4h3QT9oELPlWAzsN60,388
 fmu/pem/pem_functions/__init__.py,sha256=aGFW0Gmr1rZsmzZhKdll9ofWcgpobzsHxfCNwr2Ypqc,551
@@ -18,22 +18,22 @@ fmu/pem/pem_functions/regression_models.py,sha256=wUw5yIIeR5sGz7OqAp42K4lxLUOKr-
 fmu/pem/pem_functions/run_friable_model.py,sha256=R3Nb0nQML6k5QrPwDoB7oMHaTkB-rJjCSPnJ_gsrIIQ,6885
 fmu/pem/pem_functions/run_patchy_cement_model.py,sha256=M561C_4dfPW_Nxm0AgzCUdeQ9UVIrZGGhxBayII1IDQ,6667
 fmu/pem/pem_functions/run_t_matrix_model.py,sha256=Ctl5Lw1HJvNYdqKDUnqrOWRisVV2m1J4gJ6S2u8j-Xw,7875
-fmu/pem/pem_utilities/__init__.py,sha256=OjQz4PjT8Rj2WYnuIoRYSnUXgkSsQESLIT3rp14LP5c,2143
+fmu/pem/pem_utilities/__init__.py,sha256=p3Fv-wUDH_te9WUHSNj-WS08ly2asRr9iNN6Kw-2f1o,2089
 fmu/pem/pem_utilities/cumsum_properties.py,sha256=s3M0bMs6Dogg8cWzj5M6K5xifdRjhZse3dCWZL0_RCo,3431
 fmu/pem/pem_utilities/delta_cumsum_time.py,sha256=vDc7Hvl50qzUXbK4oKq30zlQ2fqMel9EmBO0lmeoDbo,3035
 fmu/pem/pem_utilities/enum_defs.py,sha256=R6Q0G6TQKe1MM4KTp1t_iCaFuCWEwLvIqV6tH3uxCms,2485
 fmu/pem/pem_utilities/export_routines.py,sha256=hteGM4flK8B7Jy4BNk5bU33-_jcNndFrm9RcnzfTdy4,10108
 fmu/pem/pem_utilities/fipnum_pvtnum_utilities.py,sha256=ypwTsyfqqBJ6d8WHY2HkKAdX9ZjHYLdQq_-3w2xEwVQ,7571
-fmu/pem/pem_utilities/import_config.py,sha256=eKV1LsajELCcTijLsGMzQg16XcicedCKmhhZJce-SQ4,3554
+fmu/pem/pem_utilities/import_config.py,sha256=Ms16Tth0-U28D9VIvExF9y-WVVaJSzY6Kkdh6RHVXOg,3700
 fmu/pem/pem_utilities/import_routines.py,sha256=EVHCS-LaHXKwVgDiE5BDvybJgPi0PjFado2m1O9ezo4,5104
 fmu/pem/pem_utilities/pem_class_definitions.py,sha256=Q_k5s_Zj8q_9TKdnxdJdOeN1UVGZbH997ngs8_5t0Es,5504
-fmu/pem/pem_utilities/pem_config_validation.py,sha256=ps_mFuwh2SgpsoSC_5IwlLpMaLDzx9BRyEYvgSf3CQw,27441
+fmu/pem/pem_utilities/pem_config_validation.py,sha256=6SOuNoobSy4y42Z8AAczCVh9nODSorBnHcCTknMy3GQ,27639
 fmu/pem/pem_utilities/rpm_models.py,sha256=S4BDv5aTaMHgk-nSYxBQ1I_SzkSGXVd6HNtoUViElwE,21212
 fmu/pem/pem_utilities/update_grid.py,sha256=Ay0XPGXBl5CtdL5keTGzs0AKp44LgsuqxwBVwmHZV_s,1838
 fmu/pem/pem_utilities/utils.py,sha256=dHfQLDfwG27eC86lHN12PrITuock8M5IH-gD7eWAtCE,10583
-fmu_pem-0.0.3.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-fmu_pem-0.0.3.dist-info/METADATA,sha256=t2TFRKI9Cq718cFQxGYnmzfK1_8s9PSSGKpJ141K_Xo,43848
-fmu_pem-0.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fmu_pem-0.0.3.dist-info/entry_points.txt,sha256=NSoFnob1PAE6FzRyNJZn5idocnCB1ptNg6R8zYf7Gnc,98
-fmu_pem-0.0.3.dist-info/top_level.txt,sha256=Z-FIY3pxn0UK2Wxi9IJ7fKoLSraaxuNGi1eokiE0ShM,4
-fmu_pem-0.0.3.dist-info/RECORD,,
+fmu_pem-0.0.4.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+fmu_pem-0.0.4.dist-info/METADATA,sha256=wakrxOg0kE20GH5s5rJ_OxX6bhDNRCiya6JEeSBfFr4,43878
+fmu_pem-0.0.4.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+fmu_pem-0.0.4.dist-info/entry_points.txt,sha256=NSoFnob1PAE6FzRyNJZn5idocnCB1ptNg6R8zYf7Gnc,98
+fmu_pem-0.0.4.dist-info/top_level.txt,sha256=Z-FIY3pxn0UK2Wxi9IJ7fKoLSraaxuNGi1eokiE0ShM,4
+fmu_pem-0.0.4.dist-info/RECORD,,

{fmu_pem-0.0.3.dist-info → fmu_pem-0.0.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any