fmu-pem 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

fmu/pem/pem_functions/density.py

@@ -35,7 +35,7 @@ def estimate_bulk_density(
     Raises:
         ValueError: If fluid_props is an empty list.
     """
-    if config.rock_matrix.rpm == PatchyCementRPM:
+    if isinstance(config.rock_matrix.model, PatchyCementRPM):
         # Get cement mineral properties
         cement_mineral = config.rock_matrix.cement
         mineral = config.rock_matrix.minerals[cement_mineral]
@@ -44,7 +44,7 @@ def estimate_bulk_density(
             mineral.bulk_modulus, mineral.shear_modulus, mineral.density, init_prop.poro
         )
         rel_frac_cem = (
-            config.rock_matrix.rpm.parameters.cement_fraction / init_prop.poro
+            config.rock_matrix.model.parameters.cement_fraction / init_prop.poro
         )
         rho_m = (
             rel_frac_cem * cement_properties.dens

fmu/pem/pem_functions/effective_pressure.py

@@ -11,7 +11,7 @@ from fmu.pem.pem_utilities import (
     SimRstProperties,
     to_masked_array,
 )
-from fmu.pem.pem_utilities.enum_defs import OverburdenPressure
+from fmu.pem.pem_utilities.enum_defs import OverburdenPressureTypes
 
 from .density import estimate_bulk_density
 
@@ -44,13 +44,14 @@ def estimate_pressure(
     # Saturated rock bulk density bulk
     bulk_density = estimate_bulk_density(config, sim_init, fluid_props, matrix_props)
 
-    ovb = config.pressure.overburden
-    if ovb.type == OverburdenPressure.CONSTANT:
+    # ovb = config.pressure.overburden
+    ovb = config.pressure
+    if ovb.type == OverburdenPressureTypes.CONSTANT:
         eff_pres = [
             estimate_effective_pressure(
                 formation_pressure=sim_date.pressure * 1.0e5,
                 bulk_density=dens,
-                reference_overburden_pressure=ovb.constant,
+                reference_overburden_pressure=ovb.value,
             )
             for (sim_date, dens) in zip(sim_rst, bulk_density)
         ]
@@ -60,8 +61,8 @@ def estimate_pressure(
                 formation_pressure=sim_date.pressure * 1.0e5,
                 bulk_density=dens,
                 reference_overburden_pressure=overburden_pressure_from_trend(
-                    inter=ovb.trend.intercept,
-                    grad=ovb.trend.gradient,
+                    inter=ovb.intercept,
+                    grad=ovb.gradient,
                     depth=sim_init.depth,
                 ),
             )

fmu/pem/pem_functions/estimate_saturated_rock.py

@@ -40,7 +40,7 @@ def estimate_saturated_rock(
     Returns:
         saturated rock properties per restart date
     """
-    if isinstance(config.rock_matrix.rpm, PatchyCementRPM):
+    if isinstance(config.rock_matrix.model, PatchyCementRPM):
         # Patchy cement model
         cement = config.rock_matrix.minerals[config.rock_matrix.cement]
         cement_properties = estimate_cement(
@@ -57,7 +57,7 @@ def estimate_saturated_rock(
             eff_pres,
             config,
         )
-    elif isinstance(config.rock_matrix.rpm, FriableRPM):
+    elif isinstance(config.rock_matrix.model, FriableRPM):
         # Friable sandstone model
         sat_rock_props = run_friable(
             matrix_props,
@@ -66,7 +66,7 @@ def estimate_saturated_rock(
             eff_pres,
             config,
         )
-    elif isinstance(config.rock_matrix.rpm, RegressionModels):
+    elif isinstance(config.rock_matrix.model, RegressionModels):
         # Regression models for dry rock properties, saturation by Gassmann
         sat_rock_props = run_regression_models(
             matrix_props,

fmu/pem/pem_functions/fluid_properties.py

@@ -22,7 +22,7 @@ from fmu.pem.pem_utilities import (
     reverse_filter_and_restore,
     to_masked_array,
 )
-from fmu.pem.pem_utilities.enum_defs import CO2Models, FluidMixModel
+from fmu.pem.pem_utilities.enum_defs import CO2Models, FluidMixModel, TemperatureMethod
 
 
 def effective_fluid_properties(
@@ -61,8 +61,6 @@ def effective_fluid_properties(
 
         # Convert pressure from bar to Pa
         pres = 1.0e5 * prop.pressure
-        mix_model = fluid_params.mix_method
-        brie_exp = fluid_params.brie_exponent
 
         # Salinity and temperature are either taken as constants from config file or
         # from eclipse simulator model
@@ -73,10 +71,17 @@ def effective_fluid_properties(
             salinity = to_masked_array(fluid_params.brine.salinity, sat_wat)
         # Temperature will normally be set as a constant. It can come from eclipse in
         # the case a compositional fluid model is run.
-        if fluid_params.temperature_from_sim:
-            temp = prop.temp
+        if fluid_params.temperature.type == TemperatureMethod.FROMSIM:
+            if hasattr(prop, "temp") and prop.temp is not None:
+                temp = prop.temp
+            else:
+                raise ValueError(
+                    "eclipse simulation restart file does not have "
+                    "temperature attribute. Constant temperature must "
+                    "be set in parameter file"
+                )
         else:
-            temp = to_masked_array(fluid_params.temperature, sat_wat)
+            temp = to_masked_array(fluid_params.temperature.temperature_value, sat_wat)
 
         # Gas gravity has to be expanded to a masked array if it comes as a float
         if isinstance(fluid_params.gas.gas_gravity, float):
@@ -217,7 +222,7 @@ def effective_fluid_properties(
 
         gas = dict(zip(fluid_keys, gas_props))
 
-        if mix_model == FluidMixModel.WOOD:
+        if fluid_params.fluid_mix_method == FluidMixModel.WOOD:
             mixed_fluid_bulk_modulus = multi_wood(
                 [sat_wat, sat_gas, sat_oil],
                 [brine["bulk_modulus"], gas["bulk_modulus"], oil["bulk_modulus"]],
@@ -230,7 +235,7 @@ def effective_fluid_properties(
                 brine["bulk_modulus"],
                 sat_oil,
                 oil["bulk_modulus"],
-                brie_exp,
+                fluid_params.fluid_mix_method.brie_exponent,
             )
         mixed_fluid_density = (
             sat_wat * brine["density"]

fmu/pem/pem_functions/regression_models.py

@@ -200,14 +200,14 @@ def run_regression_models(
             )
         if not multiple_lithologies:
             dry_props = dry_rock_regression(
-                tmp_por, tmp_min_rho, config.rock_matrix.rpm.parameters.sandstone
+                tmp_por, tmp_min_rho, config.rock_matrix.model.parameters.sandstone
             )
         else:
             dry_props_sand = dry_rock_regression(
-                tmp_por, tmp_min_rho, config.rock_matrix.rpm.parameters.sandstone
+                tmp_por, tmp_min_rho, config.rock_matrix.model.parameters.sandstone
             )
             dry_props_shale = dry_rock_regression(
-                tmp_por, tmp_min_rho, config.rock_matrix.rpm.parameters.shale
+                tmp_por, tmp_min_rho, config.rock_matrix.model.parameters.shale
             )
             dry_rho = (
                 dry_props_sand.dens * (1.0 - tmp_vsh) + dry_props_shale.dens * tmp_vsh

fmu/pem/pem_functions/run_friable_model.py

@@ -41,7 +41,7 @@ def run_friable(
     # effective_pressure can be lists
     fluid, pressure = _verify_inputs(fluid, pressure)
     saturated_props = []
-    friable_params = config.rock_matrix.rpm.parameters
+    friable_params = config.rock_matrix.model.parameters
     for fl_prop, pres in zip(fluid, pressure):
         (
             mask,
@@ -75,7 +75,7 @@ def run_friable(
             tmp_por,
             tmp_pres,
             friable_params.critical_porosity,
-            friable_params.coord_num_function,
+            friable_params.coordination_number_function.fcn,
             friable_params.coordination_number,
             friable_params.shear_reduction,
         )

fmu/pem/pem_functions/run_patchy_cement_model.py

@@ -43,7 +43,7 @@ def run_patchy_cement(
     # effective_pressure can be lists
     fluid, pressure = _verify_inputs(fluid, pressure)
     saturated_props = []
-    pat_cem_params = config.rock_matrix.rpm.parameters
+    pat_cem_params = config.rock_matrix.model.parameters
     for fl_prop, pres in zip(fluid, pressure):
         (
             mask,
@@ -88,7 +88,7 @@ def run_patchy_cement(
             tmp_pres,
             pat_cem_params.cement_fraction,
             pat_cem_params.critical_porosity,
-            pat_cem_params.coord_num_function,
+            pat_cem_params.coordination_number_function.fcn,
             pat_cem_params.coordination_number,
             pat_cem_params.shear_reduction,
         )

fmu/pem/pem_functions/run_t_matrix_and_pressure.py

@@ -73,7 +73,7 @@ def run_t_matrix_and_pressure_models(
     exp_parameter_file = config.paths.rel_path_pem / exp_parameter_file
 
     saturated_props = []
-    t_mat_params = config.rock_matrix.rpm.parameters
+    t_mat_params = config.rock_matrix.model.parameters
 
     if vsh is None and t_mat_params.t_mat_model_version == "EXP":
         raise ValueError("Shale volume must be provided for EXP model")

fmu/pem/pem_utilities/enum_defs.py

@@ -5,7 +5,7 @@ Define enumerated strings
 from enum import Enum
 
 
-class OverburdenPressure(str, Enum):
+class OverburdenPressureTypes(str, Enum):
     CONSTANT = "constant"
     TREND = "trend"
 
@@ -52,3 +52,19 @@ class RPMType(str, Enum):
 class VolumeFractions(str, Enum):
     NTG_SIM = "ntg_sim"
     VOL_FRAC = "fraction_files"
+
+
+class GasModels(str, Enum):
+    GLOBAL = "Global"
+    LIGHT = "Light"
+    HC2016 = "HC2016"
+
+
+class CoordinationNumberFunction(str, Enum):
+    PORBASED = "PorBased"
+    CONSTANT = "ConstVal"
+
+
+class TemperatureMethod(str, Enum):
+    CONSTANT = "constant"
+    FROMSIM = "from_sim"

fmu/pem/pem_utilities/import_routines.py

@@ -92,7 +92,8 @@ def read_sim_grid_props(
 
     init_props = read_init_properties(init_property_file, sim_grid)
 
-    RST_PROPS = ["SWAT", "SGAS", "SOIL", "RS", "RV", "PRESSURE", "SALT"]
+    # TEMP will only be available for eclipse-300
+    RST_PROPS = ["SWAT", "SGAS", "SOIL", "RS", "RV", "PRESSURE", "SALT", "TEMP"]
 
     # Restart properties - set strict to False, False in case RV is not included in
     # the UNRST file

fmu/pem/pem_utilities/pem_config_validation.py

@@ -6,9 +6,9 @@ from typing import Any, Dict, List, Literal, Optional, Self, Union
 import numpy as np
 from pydantic import (
     BaseModel,
+    ConfigDict,
     DirectoryPath,
     Field,
-    FilePath,
     field_validator,
     model_validator,
 )
@@ -20,8 +20,10 @@ from fmu.pem import INTERNAL_EQUINOR
 from .enum_defs import (
     CO2Models,
     FluidMixModel,
+    GasModels,
     MineralMixModel,
-    OverburdenPressure,
+    OverburdenPressureTypes,
+    TemperatureMethod,
     VolumeFractions,
 )
 from .rpm_models import MineralProperties, PatchyCementRPM, RegressionRPM, TMatrixRPM
@@ -43,7 +45,7 @@ class FractionFiles(BaseModel):
         default=Path("../../sim2seis/input/pem"),
         description="Directory for volume fractions",
     )
-    fractions_grid_file_name: FilePath = Field(
+    fractions_grid_file_name: Path = Field(
         description="Grid definition of the volume fractions"
     )
     fractions_prop_file_names: list[Path] = Field(description="Volume fractions")
@@ -54,6 +56,21 @@ class FractionFiles(BaseModel):
         "they have to represent real volume fractions, and this will be ignored",
     )
 
+    @model_validator(mode="after")
+    def check_fractions(self) -> Self:
+        full_fraction_grid = self.rel_path_fractions / self.fractions_grid_file_name
+        if not full_fraction_grid.exists():
+            raise FileNotFoundError(
+                f"fraction grid file is missing: {full_fraction_grid}"
+            )
+        for frac_prop in self.fractions_prop_file_names:
+            full_fraction_prop = self.rel_path_fractions / frac_prop
+            if not full_fraction_prop.exists():
+                raise FileNotFoundError(
+                    f"fraction prop file is missing: {full_fraction_prop}"
+                )
+        return self
+
 
 class RockMatrixProperties(BaseModel):
     """Configuration for rock matrix properties.
@@ -63,7 +80,9 @@ class RockMatrixProperties(BaseModel):
     and other lithologies.
     """
 
-    rpm: Union[PatchyCementRPM, TMatrixRPM, RegressionRPM] = Field(
+    model_config = ConfigDict(title="Rock matrix properties:")
+
+    model: Union[PatchyCementRPM, TMatrixRPM, RegressionRPM] = Field(
         description="Selection of parameter set for rock physics model"
     )
     minerals: Dict[str, MineralProperties] = Field(
@@ -174,23 +193,15 @@ class RockMatrixProperties(BaseModel):
 
 
 # Pressure
-class Trend(BaseModel):
+class OverburdenPressureTrend(BaseModel):
+    type: SkipJsonSchema[OverburdenPressureTypes] = "trend"
     intercept: float = Field(description="Intercept in pressure depth trend")
     gradient: float = Field(description="Gradient in pressure depth trend")
 
 
-class Overburden(BaseModel):
-    type: OverburdenPressure = Field(
-        description="Selection of 'trend' or 'constant' type for overburden pressure"
-    )
-    trend: Trend = Field(
-        description="Setting of intercept and gradient for pressure trend vs. depth"
-    )
-    constant: float = Field(description="Constant overburden pressure setting")
-
-
-class Pressure(BaseModel):
-    overburden: Overburden
+class OverburdenPressureConstant(BaseModel):
+    type: SkipJsonSchema[OverburdenPressureTypes] = "constant"
+    value: float = Field(description="Constant pressure")
 
 
 # Fluids
@@ -269,12 +280,34 @@ class Gas(BaseModel):
         le=0.87,
         description="Gas gravity is a ratio of gas molecular weight to that air",
     )
-    model: str = Field(
+    model: GasModels = Field(
         default="HC2016",
         description="Gas model is one of 'Global', 'Light', or 'HC2016' (default)",
     )
 
 
+class MixModelWood(BaseModel):
+    method: SkipJsonSchema[FluidMixModel] = "wood"
+
+
+class MixModelBrie(BaseModel):
+    method: SkipJsonSchema[FluidMixModel] = "brie"
+    brie_exponent: float = Field(
+        default=3.0,
+        description="Brie exponent selects the mixing curve shape, from linear mix to "
+        "harmonic mean",
+    )
+
+
+class ConstantTemperature(BaseModel):
+    type: SkipJsonSchema[TemperatureMethod] = "constant"
+    temperature_value: float
+
+
+class TemperatureFromSim(BaseModel):
+    type: SkipJsonSchema[TemperatureMethod] = "from_sim"
+
+
 # Note that CO2 does not require a separate definition here, as it's properties only
 # depend on temperature and pressure
 class Fluids(BaseModel):
@@ -285,18 +318,16 @@ class Fluids(BaseModel):
     gas: Gas = Field(description="Gas model parameters")
     condensate: Oil | None = Field(
         default=None,
+        title="Condensate properties",
         description="Condensate is defined by the same set of parameters as oil, "
         "optional setting for condensate cases",
     )
-    mix_method: FluidMixModel = Field(
+    fluid_mix_method: MixModelBrie | MixModelWood = Field(
+        default=MixModelBrie,
         description="Selection between Wood's or Brie model. Wood's model gives more "
-        "radical response to adding small amounts of gas in brine or oil"
+        "radical response to adding small amounts of gas in brine or oil",
     )
-    brie_exponent: int = Field(
-        description="Brie exponent selects the mixing curve shape, from linear mix to "
-        "harmonic mean"
-    )
-    temperature: float = Field(
+    temperature: ConstantTemperature | TemperatureFromSim = Field(
         description="In most cases it is sufficient with a constant temperature "
         "setting for the reservoir. If temperature is modelled in the "
         "simulation model, it is preferred to use that"
@@ -308,10 +339,6 @@ class Fluids(BaseModel):
         "between formation water and injected water. If salinity is "
         "modelled in the simulation model, it is preferred to use that",
     )
-    temperature_from_sim: bool = Field(
-        default=False,
-        description="Flag to use temperature estimate from simulation model",
-    )
     gas_saturation_is_co2: bool = Field(
         default=False,
         description="Eclipse model only provides one parameter for gas saturation, "
@@ -453,6 +480,7 @@ class Results(BaseModel):
 
 class PemConfig(BaseModel):
     paths: SkipJsonSchema[PemPaths] = Field(
+        default_factory=PemPaths,
         description="Default path settings exist, it is possible to override them, "
         "mostly relevant for input paths",
     )
@@ -463,7 +491,8 @@ class PemConfig(BaseModel):
     fluids: Fluids = Field(
         description="Settings related to fluid composition",
     )
-    pressure: Pressure = Field(
+    pressure: OverburdenPressureTrend | OverburdenPressureConstant = Field(
+        default=OverburdenPressureTrend,
         description="Definition of overburden pressure model - constant or trend",
     )
     results: Results = Field(
@@ -476,10 +505,14 @@ class PemConfig(BaseModel):
         "difference calculation is run - normal difference, percent "
         "difference or ratio"
     )
-    global_params: Optional[FromGlobal] = None
+    global_params: SkipJsonSchema[FromGlobal | None] = Field(
+        default=None,
+    )
 
     @field_validator("paths", mode="before")
-    def check_and_create_directories(cls, v):
+    def check_and_create_directories(cls, v: Dict, info: ValidationInfo):
+        if v is None:
+            return PemPaths()
         for key, path in v.items():
             if key == "rel_path_intermed_output" or key == "rel_path_output":
                 os.makedirs(path, exist_ok=True)

fmu/pem/pem_utilities/rpm_models.py

@@ -2,19 +2,40 @@
 Define RPM model types and their parameters
 """
 
-from enum import Enum
 from typing import List, Literal
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
+from pydantic.json_schema import SkipJsonSchema
 from typing_extensions import Annotated
 
-from fmu.pem.pem_utilities.enum_defs import RPMType
+from fmu.pem.pem_utilities.enum_defs import CoordinationNumberFunction, RPMType
 
 
 class MineralProperties(BaseModel):
-    bulk_modulus: Annotated[float, Field(gt=1.0e9)]
-    shear_modulus: Annotated[float, Field(gt=1.0e9)]
-    density: Annotated[float, Field(gt=1.0e3)]
+    bulk_modulus: float = Field(gt=1.0e9, lt=5.0e11, description="Units: Pa")
+    shear_modulus: float = Field(gt=1.0e9, lt=5.0e11, description="Units: Pa")
+    density: float = Field(gt=1.0e3, lt=1.0e4, description="Units: kg/m^3")
+
+
+class CoordinationNumberPorBased(BaseModel):
+    fcn: SkipJsonSchema[CoordinationNumberFunction] = Field(
+        default="PorBased",
+        description="Coordinate number is the number of grain-grain contacts. It is "
+        "normally assumed to be a function of porosity for friable sand",
+    )
+
+
+class CoordinationNumberConstVal(BaseModel):
+    fcn: SkipJsonSchema[CoordinationNumberFunction] = Field(
+        default="ConstVal",
+    )
+    coordination_number: float = Field(
+        default=9.0,
+        gt=2.0,
+        lt=16.0,
+        description="In case of a constant value for the number of grain contacts, "
+        "a value of 8-9 is common",
+    )
 
 
 class PatchyCementParams(BaseModel):
@@ -47,16 +68,13 @@ class PatchyCementParams(BaseModel):
         "between grains. Shear reduction of 1 means frictionless contact, "
         "and 0 means full friction",
     )
-    coord_num_function: Literal["ConstVal", "PorBased"] = Field(
-        default="PorBased",
+    coordination_number_function: (
+        CoordinationNumberPorBased | CoordinationNumberConstVal
+    ) = Field(
+        default_factory=CoordinationNumberPorBased,
         description="Coordinate number is the number of grain-grain contacts. It is "
         "normally assumed to be a function of porosity for friable sand",
     )
-    coordination_number: float = Field(
-        default=9.0,
-        description="In case of a constant value for the number of grain contacts, "
-        "a value of 8-9 is common",
-    )
 
 
 class TMatrixParams(BaseModel):
@@ -98,8 +116,10 @@ class TMatrixParams(BaseModel):
 
 
 class RhoRegressionMixin(BaseModel):
-    rho_weights: List[float] | None = Field(
-        default=None,
+    rho_weights: List[float] = Field(
+        default=[
+            1.0,
+        ],
         description="List of float values for polynomial regression for density "
         "based on porosity",
     )
@@ -108,7 +128,8 @@ class RhoRegressionMixin(BaseModel):
         description="Matrix density is normally estimated from "
         "mineral composition and the density of each mineral. "
         "Setting this to True will estimate matrix "
-        "density based on porosity alone",
+        "density based on porosity alone. In that case, check the "
+        "rho regression parameters",
     )
 
 
@@ -123,7 +144,7 @@ class VpVsRegressionParams(RhoRegressionMixin):
         description="List of float values for polynomial regression for Vs "
         "based on porosity",
     )
-    mode: Literal["vp_vs"] = Field(
+    mode: SkipJsonSchema[Literal["vp_vs"]] = Field(
         default="vp_vs",
         description="Regression mode mode must be set to 'vp_vs' for "
         "estimation of Vp and Vs based on porosity",
@@ -141,7 +162,7 @@ class KMuRegressionParams(RhoRegressionMixin):
         description="List of float values for polynomial regression for shear modulus "
         "based on porosity",
     )
-    mode: Literal["k_mu"] = Field(
+    mode: SkipJsonSchema[Literal["k_mu"]] = Field(
         default="k_mu",
         description="Regression mode mode must be set to 'k_mu' for "
         "estimation of bulk and shear modulus based on porosity",
@@ -158,20 +179,24 @@ class RegressionModels(BaseModel):
 
 
 class PatchyCementRPM(BaseModel):
-    model: Literal[RPMType.PATCHY_CEMENT]
+    model_config = ConfigDict(title="Patchy Cement Model")
+    model: SkipJsonSchema[Literal[RPMType.PATCHY_CEMENT]]
     parameters: PatchyCementParams
 
 
 class FriableRPM(BaseModel):
-    model: Literal[RPMType.FRIABLE]
+    model_config = ConfigDict(title="Friable Sand Model")
+    model: SkipJsonSchema[Literal[RPMType.FRIABLE]]
     parameters: PatchyCementParams
 
 
 class TMatrixRPM(BaseModel):
-    model: Literal[RPMType.T_MATRIX]
+    model_config = ConfigDict(title="T-Matrix Inclusion Model")
+    model: SkipJsonSchema[Literal[RPMType.T_MATRIX]]
     parameters: TMatrixParams
 
 
 class RegressionRPM(BaseModel):
-    model: Literal[RPMType.REGRESSION]
+    model_config = ConfigDict(title="Regression Model")
+    model: SkipJsonSchema[Literal[RPMType.REGRESSION]]
     parameters: RegressionModels

fmu/pem/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.0.1'
-__version_tuple__ = version_tuple = (0, 0, 1)
+__version__ = version = '0.0.2'
+__version_tuple__ = version_tuple = (0, 0, 2)

{fmu_pem-0.0.1.dist-info → fmu_pem-0.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu-pem
-Version: 0.0.1
+Version: 0.0.2
 Summary: pem
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -686,12 +686,8 @@ Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Utilities
 Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Natural Language :: English
-Requires-Python: >=3.8
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy>=1.24.3
@@ -719,13 +715,19 @@ Requires-Dist: sphinx-togglebutton; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
 Dynamic: license-file
 
-# How to use fmu-pem
+> [!WARNING]
+> `fmu-pem` is not yet qualified technology, and as of today only applicable for selected pilot test fields.
 
-Petro-elastic model (PEM) for [fmu-sim2seis](https://github.com/equinor/fmu-sim2seis)
-based on the [rock-physics-open](https://github.com/equinor/rock-physics-open)
-library.
+**[📚 User documentation](https://equinor.github.io/fmu-pem/)**
 
-## Installation
+## What is fmu-pem?
+
+Petro-elastic model (PEM) for use in e.g. [fmu-sim2seis](https://github.com/equinor/fmu-sim2seis)
+based on the [rock-physics-open](https://github.com/equinor/rock-physics-open) library.
+
+## How to use fmu-pem?
+
+### Installation
 
 To install `fmu-pem`, first activate a virtual environment, then type:
 
@@ -736,7 +738,7 @@ pip install fmu-pem
 The PEM is controlled by parameter settings in a *yaml-file*, given as part of the
 command line arguments, or by the workflow parameter if it is run as an ERT forward model.
 
-## Calibration of rock physics models
+### Calibration of rock physics models
 
 Calibration of the rock physics models is normally carried out in
 [RokDoc](https://www.ikonscience.com/rokdoc-geoprediction-software-platform/)
@@ -752,17 +754,13 @@ from LFP logs, if they are available.
 > pip install "git+ssh://git@github.com/equinor/rock-physics"`
 > ```
 
-## User interface
-
-Users can visit https://equinor.github.io/fmu-pem/ in order to get help configuring the `fmu-pem` input data.
-
-# How to develop fmu-pem
+## How to develop fmu-pem?
 
 Developing the user interface can be done by:
 ```bash
-cd ./user-interface-config
+cd ./documentation
 npm ci  # Install dependencies
 npm run create-json-schema  # Extract JSON schema from Python code
-npm run dev  # Start local development server
+npm run docs:dev  # Start local development server
 ```
 The JSON schema itself (type, title, description etc.) comes from the corresponding Pydantic models in the Python code.

{fmu_pem-0.0.1.dist-info → fmu_pem-0.0.2.dist-info}/RECORD

@@ -2,36 +2,36 @@ fmu/__init__.py,sha256=YWSE22UTDSocfqQHxEeXrRkdlA63t_aayQVdJkycwYs,83
 fmu/pem/__init__.py,sha256=FhNaFibcFZEK1Rz7IBRXBgxMHGNlcgrHaD4FtU4pDjs,421
 fmu/pem/__main__.py,sha256=L8HW2P6_AQX70gcgmMdbW0BouCQdI0OVab-U4QkcPOk,1361
 fmu/pem/run_pem.py,sha256=z6UAuEAJlSVcbTeC2q5q8_ToKe0HIgQPHZfjRWSg6PI,3218
-fmu/pem/version.py,sha256=vgltXBYF55vNcC2regxjGN0_cbebmm8VgcDdQaDapWQ,511
+fmu/pem/version.py,sha256=wO7XWlZte1hxA4mMvRc6zhNdGm74Nhhn2bfWRAxaKbI,511
 fmu/pem/forward_models/__init__.py,sha256=WuN66rmgfqrekCy3Ss9NHqsy-lZ4WGY-4VZa3jYDV2s,117
 fmu/pem/forward_models/pem_model.py,sha256=fKDD1-euwLBMr6rAjDYG0o-k7uKYRxG6De6bywF3AXI,2203
 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=G2tu5E1PFvlw36fLdmr2A4Xr9ZqbKMf104OU5ydh_3A,539
-fmu/pem/pem_functions/density.py,sha256=36A8yccsnVPXCpnIfuwNUf9FVvXDkCBpcn4UFuPngFE,1777
-fmu/pem/pem_functions/effective_pressure.py,sha256=3p_bFwgS-PtCN0hAaJXYLwdzuv2J5PHDLWhzyBQNfgU,6118
-fmu/pem/pem_functions/estimate_saturated_rock.py,sha256=azJjVwuUGCyiO-FIY-TYktR3PSBRoOB2ceY33PJyMsc,2756
-fmu/pem/pem_functions/fluid_properties.py,sha256=HCRay1blnWiK19N0nncoV6ftB-DHPC8d029Xsg4jaFw,10458
+fmu/pem/pem_functions/density.py,sha256=eiAvZC7L3LvD0VuJYKSKY_M1WpqnxUS935-kKsT8NyA,1791
+fmu/pem/pem_functions/effective_pressure.py,sha256=AoiMlBkCtERIZ3R0Nct07J7Rj5FaOEeEtS4u738KU-0,6141
+fmu/pem/pem_functions/estimate_saturated_rock.py,sha256=upWTEZ_FCi45FoG4aW5vRdX58VoEDRFlo1ZTyokQpw0,2762
+fmu/pem/pem_functions/fluid_properties.py,sha256=fRS922lwJxca4m12V9XOV5bSa2KaQzt6OQ2WLg0o9EE,10811
 fmu/pem/pem_functions/mineral_properties.py,sha256=ilf1TwE4DDev65TdHEuudxgLj41IRBWgSjXghNrCPak,8394
-fmu/pem/pem_functions/regression_models.py,sha256=7YfEiAbjxnP1UP1ugW8ay202grbumG4_vFppEpBkEDE,9085
-fmu/pem/pem_functions/run_friable_model.py,sha256=rT-LQ17gSrJS_l524LKiLnK5Q0Y5zx8lKRuO7GFd3fk,4258
-fmu/pem/pem_functions/run_patchy_cement_model.py,sha256=B-j-Aza2yT6qbBXIsR3HZmtjcBkONLqnq7AYbrgp_uU,4201
-fmu/pem/pem_functions/run_t_matrix_and_pressure.py,sha256=RmvFRm6QNvhpFp9Ar_ifWru6Yp0h-XnE9WS4lUR37Nk,6821
+fmu/pem/pem_functions/regression_models.py,sha256=fNpeKzVDhFniMTlWlypfcPsEx-ztfueR1Cuo7EspJhk,9091
+fmu/pem/pem_functions/run_friable_model.py,sha256=PzDZjJ3KDGUfwN0nht90lk8yM0RMXS1ZzwEztjdULzk,4274
+fmu/pem/pem_functions/run_patchy_cement_model.py,sha256=A8pIu3fHujoc5U382WK2R_q4GcG8D1F3wHKBRsV7k8Y,4217
+fmu/pem/pem_functions/run_t_matrix_and_pressure.py,sha256=GmGcEq38Oii2mI5tHBaJ7LutE67wKx6MyrtCMpdGWVk,6823
 fmu/pem/pem_utilities/__init__.py,sha256=r9vSDgrY4B2NwBK5PL-4GMD5o1aT2IpR1vaeOCgJ-tI,1687
 fmu/pem/pem_utilities/cumsum_properties.py,sha256=W2FtawYPZzdydGsVoOYCWIgOItNGKCRzhHzI5sUw05M,3769
 fmu/pem/pem_utilities/delta_cumsum_time.py,sha256=J83PSpO2xjxHP5tpDpleVxynt0eytqHLgbGzj79wTQI,3267
-fmu/pem/pem_utilities/enum_defs.py,sha256=nJWpvXBFRIE-f7A4AjsVwldM2fxSZGRXAYC0faEOckw,1067
+fmu/pem/pem_utilities/enum_defs.py,sha256=SFs_5lru3Br9xHqnUrWJyeJzLvE6JAAsI_MMaA6tjlU,1354
 fmu/pem/pem_utilities/export_routines.py,sha256=gZa3AscefV9h55JQXL7juQg5SpMvhnN5nbBHFU2VtCI,9879
 fmu/pem/pem_utilities/import_config.py,sha256=H6nH_MVnVhuS4q-4KWhoOvQbGzV5Jnw1-KlD1BRccmY,3232
-fmu/pem/pem_utilities/import_routines.py,sha256=PRnHn2wsHRewi2z3AlSNu9i3li9srfPNq_TS9qv89a4,5263
+fmu/pem/pem_utilities/import_routines.py,sha256=nj-yJYFlGno7p0k67SdjjQzUUbA92Bgfv5g7q9Nx8pA,5321
 fmu/pem/pem_utilities/pem_class_definitions.py,sha256=IOwzHfMsoPoGWIs1-I-kI2wVbhgR5TjZHygXOMsECMk,3282
-fmu/pem/pem_utilities/pem_config_validation.py,sha256=nxHCCLCOV0bODH7LfFjdbQRbe0zhLulKYcMgG1YnjjQ,17878
-fmu/pem/pem_utilities/rpm_models.py,sha256=TxW8lmIMluU1JsgGUT6nlR899mlVk8GgQx2p5ODnr78,5726
+fmu/pem/pem_utilities/pem_config_validation.py,sha256=8pUDTx0aGGpqBuTJth0adDTvbrODIvKifXqWy0J_WRU,19111
+fmu/pem/pem_utilities/rpm_models.py,sha256=UjqCGy-nbo2uPp-KlRdUmFRG9up2XVTlI8DplDTjIdU,6836
 fmu/pem/pem_utilities/update_grid.py,sha256=InGaWrgIH5G9xyGqazAxQmVHL0nve4B9dAttisBsIpU,1775
 fmu/pem/pem_utilities/utils.py,sha256=Gm_onSB7KuHZ0iKzx5TjHCOBYkatewSyEXgC9J-UA70,8871
-fmu_pem-0.0.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-fmu_pem-0.0.1.dist-info/METADATA,sha256=-3GgiilfNJq6zv7F6eD0fIZ5qYSIeFs6nlh2cL7VeBk,43944
-fmu_pem-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fmu_pem-0.0.1.dist-info/entry_points.txt,sha256=NSoFnob1PAE6FzRyNJZn5idocnCB1ptNg6R8zYf7Gnc,98
-fmu_pem-0.0.1.dist-info/top_level.txt,sha256=Z-FIY3pxn0UK2Wxi9IJ7fKoLSraaxuNGi1eokiE0ShM,4
-fmu_pem-0.0.1.dist-info/RECORD,,
+fmu_pem-0.0.2.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+fmu_pem-0.0.2.dist-info/METADATA,sha256=bJh3W1AKoDPrC4-CPet8xAoVpOKRRVkebtW6Rw0wpqM,43839
+fmu_pem-0.0.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fmu_pem-0.0.2.dist-info/entry_points.txt,sha256=NSoFnob1PAE6FzRyNJZn5idocnCB1ptNg6R8zYf7Gnc,98
+fmu_pem-0.0.2.dist-info/top_level.txt,sha256=Z-FIY3pxn0UK2Wxi9IJ7fKoLSraaxuNGi1eokiE0ShM,4
+fmu_pem-0.0.2.dist-info/RECORD,,