rock-physics-open 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

rock_physics_open/fluid_models/oil_model/oil_properties.py

@@ -17,13 +17,13 @@ def oil_properties(
     gas_gravity: np.ndarray | float,
 ) -> np.ndarray | float:
     """
-    :param temperature: Temperature (Celsius) of oil.
-    :param pressure: Pressure (Pa) of oil
+    :param temperature: Temperature [°C] of oil.
+    :param pressure: Pressure [Pa] of oil
     :param rho0: Density of the oil without dissolved gas at 15.6 degrees Celsius and
-                 atmospheric pressure. (kg/m^3)
+                 atmospheric pressure. [kg/m^3]
     :param gas_oil_ratio: The volume ratio of gas to oil [l/l]
     :param gas_gravity: Gas Gravity, molar mass of gas relative to air molar mas.
-    :return: vel_oil, den_oil, k_oil
+    :return: vel_oil [m/s], den_oil [kg/m^3], k_oil [Pa]
     """
     # Since live_oil with gas_oil_ratio=0.0 is not equal to dead oil
     # we use an apodization function to interpolate between the two
@@ -41,10 +41,11 @@ def oil_properties(
         window = np.clip((np.abs(x) - length / 2) / (length / 2), 0, 1)
         return 1 - window
 
-    loil_den, loil_vel = live_oil(
-        temperature, pressure, rho0, gas_oil_ratio, gas_gravity
-    )
-    doil_den, doil_vel = dead_oil(temperature, pressure, rho0)
+    (
+        loil_vel,
+        loil_den,
+    ) = live_oil(temperature, pressure, rho0, gas_oil_ratio, gas_gravity)
+    doil_vel, doil_den = dead_oil(temperature, pressure, rho0)
     window = triangular_window(gas_oil_ratio)
     den_oil = doil_den * window + (1 - window) * loil_den
     vel_oil = doil_vel * window + (1 - window) * loil_vel
@@ -59,20 +60,16 @@ def dead_oil(
 ) -> tuple[np.ndarray | float, np.ndarray | float]:
     """
     :param reference_density: Density of the oil without dissolved gas
-        at 15.6 degrees Celsius and atmospheric pressure. kg/m3
+        at 15.6 degrees Celsius and atmospheric pressure. [kg/m^3]
     :param gas_oil_ratio: The volume ratio of gas to oil [l/l]
     :param gas_gravity: molar mass of gas relative to air molar mas.
-    :param pressure: Pressure (Pa) of oil
-    :param temperature: Temperature (Celsius) of oil.
-    :return: dead_oil_density, dead_oil_velocity
+    :param pressure: Pressure [Pa] of oil
+    :param temperature: Temperature [°C] of oil.
+    :return: dead_oil_density [kg/m^3], dead_oil_velocity [m/s]
     """
-    dead_oil_den = 1000 * dead_oil_density(
-        temperature, pressure * 1e-6, reference_density / 1000
-    )
-    dead_oil_vel = dead_oil_velocity(
-        temperature, pressure * 1e-6, reference_density / 1000
-    )
-    return dead_oil_den, dead_oil_vel
+    dead_oil_den = dead_oil_density(temperature, pressure, reference_density)
+    dead_oil_vel = dead_oil_velocity(temperature, pressure, reference_density)
+    return dead_oil_vel, dead_oil_den
 
 
 def live_oil(
@@ -84,12 +81,12 @@ def live_oil(
 ) -> tuple[np.ndarray | float, np.ndarray | float]:
     """
     :param reference_density: Density of the oil without dissolved gas
-        at 15.6 degrees Celsius and atmospheric pressure. (kg/m^3)
+        at 15.6 degrees Celsius and atmospheric pressure. [kg/m^3]
     :param gas_oil_ratio: The volume ratio of gas to oil [l/l]
     :param gas_gravity: molar mass of gas relative to air molar mas.
-    :param pressure: Pressure (Pa) of oil
-    :param temperature: Temperature (Celsius) of oil.
-    :return: live_oil_density, live_oil_velocity
+    :param pressure: Pressure [Pa] of oil
+    :param temperature: Temperature [°C] of oil.
+    :return: live_oil_density , live_oil_velocity
     """
     if np.any(
         pressure
@@ -99,18 +96,51 @@ def live_oil(
             "Pressure is below bubble point of oil, estimated elastic properties can be inaccurate",
             stacklevel=1,
         )
-    live_oil_den = 1000 * live_oil_density(
+    live_oil_den = live_oil_density(
         temperature,
-        pressure * 1e-6,
-        reference_density / 1000,
+        pressure,
+        reference_density,
         gas_oil_ratio,
         gas_gravity,
     )
     live_oil_vel = live_oil_velocity(
         temperature,
-        pressure * 1e-6,
-        reference_density / 1000,
+        pressure,
+        reference_density,
         gas_oil_ratio,
         gas_gravity,
     )
-    return live_oil_den, live_oil_vel
+    return (
+        live_oil_vel,
+        live_oil_den,
+    )
+
+
+def oil_viscosity(
+    temperature: np.ndarray | float,
+    pressure: np.ndarray | float,
+    reference_density: np.ndarray | float,
+) -> np.ndarray | float:
+    """
+    Calculate dead oil viscosity. If dissolved gas is present in the oil, the reference density
+    should be substituted by live oil density.
+
+    Equations 25a, 25b, 26a & 26b in Batzle and Wang 1992
+
+    Based on Beggs and Robinson 1975
+
+    :param temperature: Temperature [°C] of oil
+    :param pressure: Pressure [Pa] of oil
+    :param reference_density: Density of the oil without dissolved gas
+    """
+    # Change unit in pressure to MPa
+    pressure_mpa = pressure / 1.0e6
+    # Change unit in density to g/cc
+    density_gcc = reference_density / 1000.0
+
+    y_factor = 10 ** (5.693 - 2.863 / density_gcc)
+    eta_t = -1.0 + 10 ** (0.505 * y_factor * (17.8 + temperature) ** -1.163)
+    i_factor = 10 ** (
+        18.6 * (0.1 * np.log10(eta_t) + (np.log10(eta_t) + 2) ** -0.1 - 0.985)
+    )
+    return eta_t + 0.145 * pressure_mpa * i_factor

rock_physics_open/sandstone_models/__init__.py

@@ -22,6 +22,7 @@ from .patchy_cement_fluid_substitution_model import (
 from .patchy_cement_model import (
     constant_cement_model_pcm,
     patchy_cement_model_cem_frac,
+    patchy_cement_model_dry,
     patchy_cement_model_weight,
 )
 from .patchy_cement_optimisation import (
@@ -48,6 +49,7 @@ __all__ = [
     "friable_shaly_sand_sandy_shale_model",
     "patchy_cement_pressure_fluid_substitution",
     "constant_cement_model_pcm",
+    "patchy_cement_model_dry",
     "patchy_cement_model_cem_frac",
     "patchy_cement_model_weight",
     "patchy_cement_model_optimisation",

rock_physics_open/sandstone_models/constant_cement_optimisation.py

@@ -1,7 +1,10 @@
 import numpy as np
 
 from rock_physics_open.equinor_utilities import gen_utilities
-from rock_physics_open.t_matrix_models import gen_opt_routine, save_opt_params
+from rock_physics_open.equinor_utilities.optimisation_utilities import (
+    gen_opt_routine,
+    save_opt_params,
+)
 
 from .curvefit_sandstone_models import curvefit_constant_cement
 

rock_physics_open/sandstone_models/friable_optimisation.py

@@ -1,7 +1,10 @@
 import numpy as np
 
 from rock_physics_open.equinor_utilities import gen_utilities
-from rock_physics_open.t_matrix_models import gen_opt_routine, save_opt_params
+from rock_physics_open.equinor_utilities.optimisation_utilities import (
+    gen_opt_routine,
+    save_opt_params,
+)
 
 from .curvefit_sandstone_models import curvefit_friable
 

rock_physics_open/sandstone_models/patchy_cement_model.py

@@ -213,6 +213,93 @@ def patchy_cement_model_cem_frac(
         vpvs : Saturated rock velocity ratio [ratio].
     """
 
+    k_dry, mu, _ = patchy_cement_model_dry(
+        k_min,
+        mu_min,
+        rho_min,
+        k_cem,
+        mu_cem,
+        rho_cem,
+        phi,
+        p_eff,
+        frac_cem,
+        phi_c,
+        coord_num_func,
+        n,
+        shear_red,
+    )
+    k_zero, mu_zero = std_functions.hashin_shtrikman_walpole(
+        k_cem, mu_cem, k_min, mu_min, FRAC_CEM_UP, bound="lower"
+    )
+
+    k = std_functions.gassmann(k_dry, phi, k_fl, k_zero)
+
+    rhob = phi * rho_fl + (1 - phi - frac_cem) * rho_min + frac_cem * rho_cem
+
+    vp, vs, ai, vpvs = std_functions.velocity(k, mu, rhob)
+
+    return vp, vs, rhob, ai, vpvs
+
+
+def patchy_cement_model_dry(
+    k_min,
+    mu_min,
+    rho_min,
+    k_cem,
+    mu_cem,
+    rho_cem,
+    phi,
+    p_eff,
+    frac_cem,
+    phi_c,
+    coord_num_func,
+    n,
+    shear_red,
+):
+    """
+    Patchy cement model for sands that are a combination of friable model and constant cement model. No fluid or
+    pressure substitution. In this implementation of the patchy cement model the given cement fraction for the constant
+    cement model defines the upper bound, and the effective pressure for the friable model defines the lower bound
+
+    Parameters
+    ----------
+    k_min : np.ndarray
+        Mineral bulk modulus [Pa].
+    mu_min : np.ndarray
+        Mineral shear modulus [Pa].
+    rho_min : np.ndarray
+        Mineral bulk density [kg/m^3].
+    k_cem : np.ndarray
+        Sandstone cement bulk modulus [Pa].
+    mu_cem : np.ndarray
+        Sandstone cement shear modulus [Pa].
+    rho_cem : np.ndarray
+        Cement bulk density [kg/m^3].
+    phi : np.ndarray
+        Total porosity [fraction].
+    p_eff : np.ndarray
+        Effective pressure [Pa].
+    frac_cem : float
+        Upper bound cement volume fraction [fraction].
+    shear_red : float
+        Shear reduction factor for sandstone [fraction].
+    phi_c : float
+        Critical porosity [fraction].
+    n : float
+        Coordination number [unitless].
+    coord_num_func : str
+        Indication if coordination number should be calculated from porosity or kept constant, either "ConstVal" or
+        "PoreBased" [default]
+
+    Returns
+    -------
+    tuple
+        k:dry, mu, rho_dry : (np.ndarray, np.ndarray, np.ndarray).
+        k_dry: dry rock bulk modulus [Pa],
+        mu : dry rock shear modulus [Pa],
+        rho_dry : dry rock density [kg/m3].,
+    """
+
     k_zero, mu_zero = std_functions.hashin_shtrikman_walpole(
         k_cem, mu_cem, k_min, mu_min, FRAC_CEM_UP, bound="lower"
     )
@@ -277,10 +364,6 @@ def patchy_cement_model_cem_frac(
     k_dry = k_fri + weight_k * (k_up - k_fri)
     mu = mu_fri + weight_mu * (mu_up - mu_fri)
 
-    k = std_functions.gassmann(k_dry, phi, k_fl, k_zero)
-
-    rhob = phi * rho_fl + (1 - phi - frac_cem) * rho_min + frac_cem * rho_cem
+    rho_dry = (1 - phi - frac_cem) * rho_min + frac_cem * rho_cem
 
-    vp, vs, ai, vpvs = std_functions.velocity(k, mu, rhob)
-
-    return vp, vs, rhob, ai, vpvs
+    return k_dry, mu, rho_dry

rock_physics_open/sandstone_models/patchy_cement_optimisation.py

@@ -1,7 +1,10 @@
 import numpy as np
 
 from rock_physics_open.equinor_utilities import gen_utilities
-from rock_physics_open.t_matrix_models import gen_opt_routine, save_opt_params
+from rock_physics_open.equinor_utilities.optimisation_utilities import (
+    gen_opt_routine,
+    save_opt_params,
+)
 
 from .curvefit_sandstone_models import (
     curvefit_patchy_cement,

rock_physics_open/t_matrix_models/__init__.py

@@ -1,10 +1,4 @@
 from .carbonate_pressure_substitution import carbonate_pressure_model
-from .opt_subst_utilities import (
-    gen_opt_routine,
-    opt_param_info,
-    opt_param_to_ascii,
-    save_opt_params,
-)
 from .parse_t_matrix_inputs import parse_t_matrix_inputs
 from .run_t_matrix import run_t_matrix
 from .t_matrix_C import t_matrix_porosity_c_alpha_v
@@ -26,10 +20,6 @@ from .t_matrix_vector import (
 
 __all__ = [
     "carbonate_pressure_model",
-    "gen_opt_routine",
-    "opt_param_info",
-    "opt_param_to_ascii",
-    "save_opt_params",
     "parse_t_matrix_inputs",
     "run_t_matrix",
     "t_matrix_porosity_c_alpha_v",

rock_physics_open/t_matrix_models/carbonate_pressure_substitution.py

@@ -1,6 +1,6 @@
 import pandas as pd
 
-from rock_physics_open.equinor_utilities.machine_learning_utilities import (
+from rock_physics_open.equinor_utilities.machine_learning_utilities.run_regression import (
     run_regression,
 )
 

rock_physics_open/t_matrix_models/curvefit_t_matrix_exp.py

@@ -1,11 +1,10 @@
 import numpy as np
 
 from rock_physics_open.equinor_utilities.gen_utilities import dim_check_vector
+from rock_physics_open.equinor_utilities.optimisation_utilities import opt_param_info
 from rock_physics_open.equinor_utilities.std_functions import hashin_shtrikman_average
 from rock_physics_open.t_matrix_models import t_matrix_porosity_c_alpha_v
 
-from .opt_subst_utilities import opt_param_info
-
 
 def curvefit_t_matrix_exp(
     x_data,

rock_physics_open/t_matrix_models/t_matrix_opt_fluid_sub_exp.py

@@ -1,15 +1,15 @@
 import numpy as np
 
 from rock_physics_open.equinor_utilities import gen_utilities
-
-from .curvefit_t_matrix_exp import curvefit_t_matrix_exp
-from .opt_subst_utilities import (
+from rock_physics_open.equinor_utilities.optimisation_utilities import (
     gen_mod_routine,
     gen_sub_routine,
     load_opt_params,
     opt_param_info,
 )
 
+from .curvefit_t_matrix_exp import curvefit_t_matrix_exp
+
 
 def run_t_matrix_with_opt_params_exp(
     fl_k_orig,

rock_physics_open/t_matrix_models/t_matrix_opt_fluid_sub_petec.py

@@ -1,9 +1,13 @@
 import numpy as np
 
 from rock_physics_open.equinor_utilities import gen_utilities
+from rock_physics_open.equinor_utilities.optimisation_utilities import (
+    gen_mod_routine,
+    gen_sub_routine,
+    load_opt_params,
+)
 
 from .curvefit_t_matrix_min import curve_fit_2_inclusion_sets
-from .opt_subst_utilities import gen_mod_routine, gen_sub_routine, load_opt_params
 
 
 def run_t_matrix_with_opt_params_petec(

rock_physics_open/t_matrix_models/t_matrix_opt_forward_model_exp.py

@@ -1,9 +1,13 @@
 import numpy as np
 
 from rock_physics_open.equinor_utilities import gen_utilities
+from rock_physics_open.equinor_utilities.optimisation_utilities import (
+    gen_mod_routine,
+    load_opt_params,
+    opt_param_info,
+)
 
 from .curvefit_t_matrix_exp import curvefit_t_matrix_exp
-from .opt_subst_utilities import gen_mod_routine, load_opt_params, opt_param_info
 
 
 def run_t_matrix_forward_model_with_opt_params_exp(

rock_physics_open/t_matrix_models/t_matrix_opt_forward_model_min.py

@@ -1,9 +1,12 @@
 import numpy as np
 
 from rock_physics_open.equinor_utilities import gen_utilities
+from rock_physics_open.equinor_utilities.optimisation_utilities import (
+    gen_mod_routine,
+    load_opt_params,
+)
 
 from .curvefit_t_matrix_min import curve_fit_2_inclusion_sets
-from .opt_subst_utilities import gen_mod_routine, load_opt_params
 
 
 def run_t_matrix_forward_model_with_opt_params_petec(

rock_physics_open/t_matrix_models/t_matrix_parameter_optimisation_exp.py

@@ -1,9 +1,13 @@
 import numpy as np
 
 from rock_physics_open.equinor_utilities import gen_utilities
+from rock_physics_open.equinor_utilities.optimisation_utilities import (
+    gen_opt_routine,
+    opt_param_info,
+    save_opt_params,
+)
 
 from .curvefit_t_matrix_exp import curvefit_t_matrix_exp
-from .opt_subst_utilities import gen_opt_routine, opt_param_info, save_opt_params
 from .t_matrix_parameter_optimisation_min import DEF_VP_VS_RATIO
 
 

rock_physics_open/t_matrix_models/t_matrix_parameter_optimisation_min.py

@@ -1,9 +1,12 @@
 import numpy as np
 
 from rock_physics_open.equinor_utilities import gen_utilities
+from rock_physics_open.equinor_utilities.optimisation_utilities import (
+    gen_opt_routine,
+    save_opt_params,
+)
 
 from .curvefit_t_matrix_min import curve_fit_2_inclusion_sets
-from .opt_subst_utilities import gen_opt_routine, save_opt_params
 
 # Trade-off between calcite, dolomite and quartz, vs is weighted by this in order to make it count as much as vp
 # in the optimisation

rock_physics_open/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 = '0.2.1'
-__version_tuple__ = version_tuple = (0, 2, 1)
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)
+
+__commit_id__ = commit_id = None

{rock_physics_open-0.2.1.dist-info → rock_physics_open-0.3.0.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: rock_physics_open
-Version: 0.2.1
+Version: 0.3.0
 Summary: Equinor Rock Physics Module
 Author-email: Harald Flesche <hfle@equinor.com>, Eivind Jahren <ejah@equinor.com>, Jimmy Zurcher <jiz@equinor.com>
-Maintainer-email: Harald Flesche <hfle@equinor.com>, Eirik Ola Aksnes <eoaksnes@equinor.com>, Christopher Collin Løkken <chcl@equinor.com>, Sivert Utne <sutn@equinor.com>
+Maintainer-email: Harald Flesche <hfle@equinor.com>, Eirik Ola Aksnes <eoaksnes@equinor.com>, Sivert Utne <sutn@equinor.com>, Einar Wigum Arbo <earb@equinor.com>
 Project-URL: Repository, https://github.com/equinor/rock-physics-open
 Project-URL: Homepage, https://github.com/equinor/rock-physics-open
 Project-URL: Changelog, https://github.com/equinor/rock-physics-open/blob/main/CHANGELOG.md
@@ -16,6 +16,7 @@ Classifier: Topic :: Utilities
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Natural Language :: English
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -27,11 +28,6 @@ Requires-Dist: scipy<2,>=1.10.1
 Requires-Dist: scikit-learn>=1.2.2
 Requires-Dist: sympy>=1.13.3
 Requires-Dist: tmatrix>=1.0.0
-Provides-Extra: tests
-Requires-Dist: pytest>=8.3.5; extra == "tests"
-Requires-Dist: pytest-cov>=6.1.1; extra == "tests"
-Requires-Dist: ruff>=0.11.6; extra == "tests"
-Requires-Dist: pre-commit>=4.2.0; extra == "tests"
 Dynamic: license-file
 
 <div align="center">
@@ -80,7 +76,7 @@ Alternatively, you can update the dependencies in your `pyproject.toml` file:
 <!-- x-release-please-start-version -->
 ```toml
 dependencies = [
-    "rock-physics-open == 0.2.1",
+    "rock-physics-open == 0.3.0",
 ]
 ```
 <!-- x-release-please-end-version -->