rock-physics-open 0.3.0__tar.gz → 0.3.1__tar.gz

rock_physics_open-0.3.1/.github/release-please-manifest.json

@@ -0,0 +1 @@
+{".":"0.3.1"}

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [0.3.1](https://github.com/equinor/rock-physics-open/compare/v0.3.0...v0.3.1) (2025-10-28)
+
+
+### Bug Fixes
+
+* Add static typing to std_functions and various_utilities ([1ed5353](https://github.com/equinor/rock-physics-open/commit/1ed5353d0886e0d7625ae1e998535bd5c78b9e31))
+* catch cases with non-consistent input lengths ([7843c8e](https://github.com/equinor/rock-physics-open/commit/7843c8ed3e9d4144bbe7079d314af20c087d48be))
+* make proper reference to cell in numpy array with ndim > 0 ([0abca8f](https://github.com/equinor/rock-physics-open/commit/0abca8fcb82a5d35a990857d4ecbd2f050077b08))
+* remove redundant prototypes ([7843c8e](https://github.com/equinor/rock-physics-open/commit/7843c8ed3e9d4144bbe7079d314af20c087d48be))
+
 ## [0.3.0](https://github.com/equinor/rock-physics-open/compare/v0.2.3...v0.3.0) (2025-10-21)
 
 

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rock_physics_open
-Version: 0.3.0
+Version: 0.3.1
 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>, Sivert Utne <sutn@equinor.com>, Einar Wigum Arbo <earb@equinor.com>
@@ -76,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.3.0",
+    "rock-physics-open == 0.3.1",
 ]
 ```
 <!-- x-release-please-end-version -->

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/README.md

@@ -44,7 +44,7 @@ Alternatively, you can update the dependencies in your `pyproject.toml` file:
 <!-- x-release-please-start-version -->
 ```toml
 dependencies = [
-    "rock-physics-open == 0.3.0",
+    "rock-physics-open == 0.3.1",
 ]
 ```
 <!-- x-release-please-end-version -->

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/pyproject.toml

@@ -1,9 +1,5 @@
 [build-system]
-requires = [
-    "setuptools >= 69.5.1",
-    "setuptools_scm[toml] >= 7.1.0",
-    "wheel"
-]
+requires = ["setuptools >= 69.5.1", "setuptools_scm[toml] >= 7.1.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
@@ -36,7 +32,14 @@ maintainers = [
 ]
 readme = "README.md"
 requires-python = ">=3.11"
-keywords = ["energy", "subsurface", "seismic", "rock physics", "scientific", "engineering"]
+keywords = [
+    "energy",
+    "subsurface",
+    "seismic",
+    "rock physics",
+    "scientific",
+    "engineering",
+]
 classifiers = [
     "Intended Audience :: Science/Research",
     "Topic :: Scientific/Engineering",
@@ -56,7 +59,7 @@ dependencies = [
     "matplotlib >= 3.7.1",
     "scipy >= 1.10.1, < 2",
     "scikit-learn >= 1.2.2",
-    "sympy >= 1.13.3", # TODO: remove? (only used 1 place in span_wagner co2 equations)
+    "sympy >= 1.13.3",       # TODO: remove? (only used 1 place in span_wagner co2 equations)
     "tmatrix >= 1.0.0",
 ]
 
@@ -80,23 +83,23 @@ dev = [
 
 [tool.ruff]
 lint.select = [
-    "C",   # Complexity
-    "E",   # Errors
-    "F",   # Flake (unused variables etc.)
-    "I",   # Imports
-    "NPY", # Numpy
-    "PIE", # Python idioms and style
+    "C",       # Complexity
+    "E",       # Errors
+    "F",       # Flake (unused variables etc.)
+    "I",       # Imports
+    "NPY",     # Numpy
+    "PIE",     # Python idioms and style
     "PLR1711", # Redundant Return
-    "PT",  # PyTest
-    "Q",   # Quotes
-    "RET", # Return statements
-    "RSE", # Raising exceptions
-    "SIM", # Code simplification
-    "W",   # Warnings
+    "PT",      # PyTest
+    "Q",       # Quotes
+    "RET",     # Return statements
+    "RSE",     # Raising exceptions
+    "SIM",     # Code simplification
+    "W",       # Warnings
 ]
 lint.ignore = [
-    "C901",   # Complex Code (too many branches/statements)
-    "E501",   # Line Too Long
+    "C901", # Complex Code (too many branches/statements)
+    "E501", # Line Too Long
 ]
 line-length = 88
 
@@ -117,6 +120,8 @@ pythonVersion = "3.11"
 include = [
     # Currently only enabling on general utilities and the corresponding tests
     "src/rock_physics_open/equinor_utilities/gen_utilities/*.py",
+    "src/rock_physics_open/equinor_utilities/various_utilities/*.py",
+    "src/rock_physics_open/equinor_utilities/std_functions/*.py",
     "tests/gen_utilities_tests/*.py",
 ]
 exclude = ["src/**/version.py"]

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/machine_learning_utilities/__init__.py

@@ -1,14 +1,6 @@
 from .dummy_vars import generate_dummy_vars
 from .exponential_model import ExponentialPressureModel
-from .friable_pressure_models import (
-    FriableDryBulkModulusPressureModel,
-    FriableDryShearModulusPressureModel,
-)
 from .import_ml_models import import_model
-from .patchy_cement_pressure_models import (
-    PatchyCementDryBulkModulusPressureModel,
-    PatchyCementDryShearModulusPressureModel,
-)
 from .polynomial_model import PolynomialPressureModel
 from .run_regression import run_regression
 from .sigmoidal_model import SigmoidalPressureModel
@@ -20,8 +12,4 @@ __all__ = [
     "ExponentialPressureModel",
     "PolynomialPressureModel",
     "SigmoidalPressureModel",
-    "FriableDryBulkModulusPressureModel",
-    "FriableDryShearModulusPressureModel",
-    "PatchyCementDryShearModulusPressureModel",
-    "PatchyCementDryBulkModulusPressureModel",
 ]

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/machine_learning_utilities/import_ml_models.py

@@ -1,12 +1,4 @@
 from .exponential_model import ExponentialPressureModel
-from .friable_pressure_models import (
-    FriableDryBulkModulusPressureModel,
-    FriableDryShearModulusPressureModel,
-)
-from .patchy_cement_pressure_models import (
-    PatchyCementDryBulkModulusPressureModel,
-    PatchyCementDryShearModulusPressureModel,
-)
 from .polynomial_model import PolynomialPressureModel
 from .sigmoidal_model import SigmoidalPressureModel
 
@@ -47,14 +39,6 @@ def import_model(model_file_name):
         models = ExponentialPressureModel.load(mod_dict["nn_mod"])
     elif mod_dict["model_type"] == "Polynomial":
         models = PolynomialPressureModel.load(mod_dict["nn_mod"])
-    elif mod_dict["model_type"] == "FriableDryBulk":
-        models = FriableDryBulkModulusPressureModel.load(mod_dict["nn_mod"])
-    elif mod_dict["model_type"] == "FriableDryShear":
-        models = FriableDryShearModulusPressureModel.load(mod_dict["nn_mod"])
-    elif mod_dict["model_type"] == "PatchyCementDryBulk":
-        models = PatchyCementDryBulkModulusPressureModel.load(mod_dict["nn_mod"])
-    elif mod_dict["model_type"] == "PatchyCementDryShear":
-        models = PatchyCementDryShearModulusPressureModel.load(mod_dict["nn_mod"])
     else:
         raise ValueError("unknown model type {}".format(mod_dict["model_type"]))
 

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/machine_learning_utilities/run_regression.py

@@ -108,7 +108,9 @@ def _perform_regression(
     return res_frame
 
 
-def run_regression(inp_df, vp_model_file_name, vs_model_file_name, model_dir=None):
+def run_regression(
+    inp_df, first_model_file_name, second_model_file_name, model_dir=None
+):
     """
     Estimate Vp and Vs by neural network regression with multiple inputs.
 
@@ -116,9 +118,9 @@ def run_regression(inp_df, vp_model_file_name, vs_model_file_name, model_dir=Non
     ----------
     inp_df : pd.DataFrame
         Input logs required for the regression.
-    vp_model_file_name : str
+    first_model_file_name : str
         Full file name for vp model.
-    vs_model_file_name : str
+    second_model_file_name : str
         Full file name for vs model.
     model_dir : str
         Directory.
@@ -139,7 +141,7 @@ def run_regression(inp_df, vp_model_file_name, vs_model_file_name, model_dir=Non
         category_var,
         column_names,
         column_units,
-    ) = _read_models(vp_model_file_name, vs_model_file_name, model_dir=model_dir)
+    ) = _read_models(first_model_file_name, second_model_file_name, model_dir=model_dir)
     return _perform_regression(
         inp_df,
         column_names,

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/std_functions/backus_ave.py

@@ -1,7 +1,22 @@
 import numpy as np
+import numpy.typing as npt
 
 
-def backus_average(vp1, vs1, rho1, vp2, vs2, rho2, f1):
+def backus_average(
+    vp1: npt.NDArray[np.float64],
+    vs1: npt.NDArray[np.float64],
+    rho1: npt.NDArray[np.float64],
+    vp2: npt.NDArray[np.float64],
+    vs2: npt.NDArray[np.float64],
+    rho2: npt.NDArray[np.float64],
+    f1: npt.NDArray[np.float64],
+) -> tuple[
+    npt.NDArray[np.float64],
+    npt.NDArray[np.float64],
+    npt.NDArray[np.float64],
+    npt.NDArray[np.float64],
+    npt.NDArray[np.float64],
+]:
     """
     Backus average for a combination of two phases. The individual phases are isotropic
     but the resulting effective medium is not.

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/std_functions/dvorkin_nur.py

@@ -1,9 +1,17 @@
 import numpy as np
+import numpy.typing as npt
 
 
 def dvorkin_contact_cement(
-    frac_cem, por0_sst, mu0_sst, k0_sst, mu0_cem, k0_cem, vs_red, c
-):
+    frac_cem: npt.NDArray[np.float64],
+    por0_sst: npt.NDArray[np.float64],
+    mu0_sst: npt.NDArray[np.float64],
+    k0_sst: npt.NDArray[np.float64],
+    mu0_cem: npt.NDArray[np.float64],
+    k0_cem: npt.NDArray[np.float64],
+    vs_red: npt.NDArray[np.float64],
+    c: float,
+) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
     """
     Dvorkin-Nur contact cement model for estimation of elastic moduli.
 

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/std_functions/gassmann.py

@@ -1,11 +1,18 @@
 import warnings
+from typing import cast
 
 import numpy as np
+import numpy.typing as npt
 
 from rock_physics_open.equinor_utilities.gen_utilities import dim_check_vector
 
 
-def gassmann(k_dry, por, k_fl, k_min):
+def gassmann(
+    k_dry: npt.NDArray[np.float64],
+    por: npt.NDArray[np.float64],
+    k_fl: npt.NDArray[np.float64],
+    k_min: npt.NDArray[np.float64],
+) -> npt.NDArray[np.float64]:
     """
     Fluid substitution according to the Gassmann equation.
 
@@ -25,7 +32,10 @@ def gassmann(k_dry, por, k_fl, k_min):
     np.ndarray
         k_sat: bulk modulus for saturated rock [Pa]
     """
-    k_dry, por, k_fl, k_min = dim_check_vector((k_dry, por, k_fl, k_min))
+    k_dry, por, k_fl, k_min = cast(
+        list[npt.NDArray[np.float64]],
+        dim_check_vector((k_dry, por, k_fl, k_min)),
+    )
 
     idx = np.logical_or(k_dry == k_min, por == 0)
     k_sat = np.ones(k_dry.shape) * np.nan
@@ -42,7 +52,13 @@ def gassmann(k_dry, por, k_fl, k_min):
     return k_sat
 
 
-def gassmann2(k_sat_1, k_fl_1, k_fl_2, por, k_min):
+def gassmann2(
+    k_sat_1: npt.NDArray[np.float64],
+    k_fl_1: npt.NDArray[np.float64],
+    k_fl_2: npt.NDArray[np.float64],
+    por: npt.NDArray[np.float64],
+    k_min: npt.NDArray[np.float64],
+) -> npt.NDArray[np.float64]:
     """
     Fluid substitution by Gassmann method with substitution of one fluid to another
 
@@ -64,8 +80,9 @@ def gassmann2(k_sat_1, k_fl_1, k_fl_2, por, k_min):
     np.ndarray
         k_sat_2: bulk modulus of rock saturated with replaced fluid [Pa]
     """
-    k_sat_1, k_fl_1, k_fl_2, por, k_min = dim_check_vector(
-        (k_sat_1, k_fl_1, k_fl_2, por, k_min)
+    k_sat_1, k_fl_1, k_fl_2, por, k_min = cast(
+        list[npt.NDArray[np.float64]],
+        dim_check_vector((k_sat_1, k_fl_1, k_fl_2, por, k_min)),
     )
 
     idx = np.any(
@@ -96,7 +113,12 @@ def gassmann2(k_sat_1, k_fl_1, k_fl_2, por, k_min):
     return k_sat_2
 
 
-def gassmann_dry(k_sat, por, k_fl, k_min):
+def gassmann_dry(
+    k_sat: npt.NDArray[np.float64],
+    por: npt.NDArray[np.float64],
+    k_fl: npt.NDArray[np.float64],
+    k_min: npt.NDArray[np.float64],
+) -> npt.NDArray[np.float64]:
     """
     Dry rock properties of saturated rock by Gassmann equation
 
@@ -116,7 +138,10 @@ def gassmann_dry(k_sat, por, k_fl, k_min):
     np.ndarray
         k_dry: dry rock bulk modulus [Pa]
     """
-    k_sat, por, k_fl, k_min = dim_check_vector((k_sat, por, k_fl, k_min))
+    k_sat, por, k_fl, k_min = cast(
+        list[npt.NDArray[np.float64]],
+        dim_check_vector((k_sat, por, k_fl, k_min)),
+    )
 
     idx = np.any(np.array([k_sat == k_min, por == 0, k_fl == k_min]), axis=0)
     k_dry = np.ones(k_sat.shape)

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/std_functions/hashin_shtrikman.py

@@ -1,9 +1,18 @@
+from typing import Literal, cast
+
 import numpy as np
+import numpy.typing as npt
 
 from rock_physics_open.equinor_utilities.gen_utilities import dim_check_vector
 
 
-def hashin_shtrikman(k1, mu1, k2, mu2, f):
+def hashin_shtrikman(
+    k1: npt.NDArray[np.float64],
+    mu1: npt.NDArray[np.float64],
+    k2: npt.NDArray[np.float64],
+    mu2: npt.NDArray[np.float64],
+    f: npt.NDArray[np.float64],
+) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
     """
     Hashin-Sktrikman upper or lower according to ordering of phases.
 
@@ -34,7 +43,13 @@ def hashin_shtrikman(k1, mu1, k2, mu2, f):
     return k, mu
 
 
-def hashin_shtrikman_average(k1, mu1, k2, mu2, f):
+def hashin_shtrikman_average(
+    k1: npt.NDArray[np.float64],
+    mu1: npt.NDArray[np.float64],
+    k2: npt.NDArray[np.float64],
+    mu2: npt.NDArray[np.float64],
+    f: npt.NDArray[np.float64],
+) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
     """
     Average of Hashin-Shtrikman upper and lower bound.
 
@@ -66,7 +81,14 @@ def hashin_shtrikman_average(k1, mu1, k2, mu2, f):
     return k_av, mu_av
 
 
-def hashin_shtrikman_walpole(k1, mu1, k2, mu2, f1, bound="lower"):
+def hashin_shtrikman_walpole(
+    k1: npt.NDArray[np.float64],
+    mu1: npt.NDArray[np.float64],
+    k2: npt.NDArray[np.float64],
+    mu2: npt.NDArray[np.float64],
+    f1: npt.NDArray[np.float64],
+    bound: Literal["upper", "lower"] = "lower",
+) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
     """
     Hashin-Shtrikman upper bound is obtained when the stiffest material is
     termed 1 and vice versa for lower bound. Tricky in cases like Quartz -
@@ -94,7 +116,10 @@ def hashin_shtrikman_walpole(k1, mu1, k2, mu2, f1, bound="lower"):
         k, mu : np.ndarray.
         k: effective bulk modulus [Pa], mu: effective shear modulus [Pa].
     """
-    k1, mu1, k2, mu2, f1 = dim_check_vector((k1, mu1, k2, mu2, f1))
+    k1, mu1, k2, mu2, f1 = cast(
+        list[npt.NDArray[np.float64]],
+        dim_check_vector((k1, mu1, k2, mu2, f1)),
+    )
     if bound.lower() not in ["lower", "upper"]:
         raise ValueError(f'{__file__}: bound must be one of "lower" or "upper"')
 
@@ -138,7 +163,10 @@ def hashin_shtrikman_walpole(k1, mu1, k2, mu2, f1, bound="lower"):
     return k, mu
 
 
-def multi_hashin_shtrikman(*coeffs, mode="average"):
+def multi_hashin_shtrikman(
+    *coeffs: npt.NDArray[np.float64],
+    mode: Literal["average", "upper", "lower"] = "average",
+) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
     """
     Hashin-Shtrikman effective medium calculation for multi-mineral case.
 
@@ -163,8 +191,9 @@ def multi_hashin_shtrikman(*coeffs, mode="average"):
     k_arr = np.array(coeffs[::3])
     mu_arr = np.array(coeffs[1::3])
     f = np.array(coeffs[2::3])
-
-    if not np.all(np.around(np.sum(f, axis=0), decimals=6) == 1.0):
+    if not np.all(
+        cast(npt.NDArray[np.float64], np.around(np.sum(f, axis=0), decimals=6)) == 1.0
+    ):
         raise ValueError("multi_hashin_shtrikman: all fractions do not add up to 1.0")
 
     if mode.lower() not in ["average", "upper", "lower"]:

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/std_functions/hertz_mindlin.py

@@ -1,7 +1,15 @@
 import numpy as np
+import numpy.typing as npt
 
 
-def hertz_mindlin(k, mu, phi_c, p, shear_red, coord=None):
+def hertz_mindlin(
+    k: npt.NDArray[np.float64],
+    mu: npt.NDArray[np.float64],
+    phi_c: npt.NDArray[np.float64],
+    p: npt.NDArray[np.float64],
+    shear_red: npt.NDArray[np.float64] | float,
+    coord: float | None = None,
+) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
     """
     Hertz-Mindlin Pressure-induced moduli increase at critical porosity.
 

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/std_functions/moduli_velocity.py

@@ -1,4 +1,16 @@
-def moduli(vp, vs, rhob):
+from typing import TypeVar, cast
+
+import numpy as np
+import numpy.typing as npt
+
+_T = TypeVar("_T", npt.NDArray[np.float64], float)
+
+
+def moduli(
+    vp: _T,
+    vs: _T,
+    rhob: _T,
+) -> tuple[_T, _T]:
     """
     Calculate isotropic moduli from velocity and density.
 
@@ -23,7 +35,11 @@ def moduli(vp, vs, rhob):
     return k, mu
 
 
-def velocity(k, mu, rhob):
+def velocity(
+    k: _T,
+    mu: _T,
+    rhob: _T,
+) -> tuple[_T, _T, _T, _T]:
     """
     Calculate velocity, acoustic impedance and vp/vs ratio from elastic moduli and density.
 
@@ -43,9 +59,9 @@ def velocity(k, mu, rhob):
         vp: pressure wave velocity [m/s], vs: shear wave velocity [m/s], ai: acoustic impedance [m/s x kg/m^3],
         vp_vs: velocity ratio [fraction].
     """
-    vs = (mu / rhob) ** 0.5
-    vp = ((k + 4 / 3 * mu) / rhob) ** 0.5
-    ai = vp * rhob
-    vp_vs = vp / vs
+    vs = cast(_T, (mu / rhob) ** 0.5)
+    vp = cast(_T, ((k + 4 / 3 * mu) / rhob) ** 0.5)
+    ai = cast(_T, vp * rhob)
+    vp_vs = cast(_T, vp / vs)
 
     return vp, vs, ai, vp_vs

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/std_functions/reflection_eq.py

@@ -1,7 +1,17 @@
+from typing import Literal
+
 import numpy as np
+import numpy.typing as npt
 
 
-def _refl_models(vp, vs, rho, theta, k=2.0, mod="aki_richards"):
+def _refl_models(
+    vp: npt.NDArray[np.float64],
+    vs: npt.NDArray[np.float64],
+    rho: npt.NDArray[np.float64],
+    theta: npt.NDArray[np.float64],
+    k: npt.NDArray[np.float64] | float = 2.0,
+    mod: Literal["aki_richards", "smith_gidlow"] = "aki_richards",
+) -> npt.NDArray[np.float64]:
     """Calculate reflect coeff.
 
     Parameters
@@ -14,7 +24,7 @@ def _refl_models(vp, vs, rho, theta, k=2.0, mod="aki_richards"):
         rho array.
     theta : float, np.ndarray
         Theta value.
-    k : float, optional
+    k : float, np.ndarray, optional
         By default 2.0.
     mod : str, optional
         By default 'aki_richards'.
@@ -47,7 +57,13 @@ def _refl_models(vp, vs, rho, theta, k=2.0, mod="aki_richards"):
     return reflect_coeff
 
 
-def aki_richards(vp, vs, rho, theta, k=2.0):
+def aki_richards(
+    vp: npt.NDArray[np.float64],
+    vs: npt.NDArray[np.float64],
+    rho: npt.NDArray[np.float64],
+    theta: npt.NDArray[np.float64],
+    k: npt.NDArray[np.float64] | float = 2.0,
+) -> npt.NDArray[np.float64]:
     """
     Linearised Zoeppritz equation according to Aki and Richards.
 
@@ -61,7 +77,7 @@ def aki_richards(vp, vs, rho, theta, k=2.0):
         Density [kg/m^3].
     theta : np.ndarray
         Angle of incident ray [radians].
-    k : float
+    k : float, np.ndarray
         Background vp/vs [unitless].
 
     Returns
@@ -72,7 +88,13 @@ def aki_richards(vp, vs, rho, theta, k=2.0):
     return _refl_models(vp, vs, rho, theta, k, mod="aki_richards")
 
 
-def smith_gidlow(vp, vs, rho, theta, k=2.0):
+def smith_gidlow(
+    vp: npt.NDArray[np.float64],
+    vs: npt.NDArray[np.float64],
+    rho: npt.NDArray[np.float64],
+    theta: npt.NDArray[np.float64],
+    k: npt.NDArray[np.float64] | float = 2.0,
+) -> npt.NDArray[np.float64]:
     """
     Linearised Zoeppritz equation according to Smith and Gidlow.
 
@@ -86,7 +108,7 @@ def smith_gidlow(vp, vs, rho, theta, k=2.0):
         Density [kg/m^3].
     theta : np.ndarray
         Angle of incident ray [radians].
-    k : float
+    k : float, np.ndarray
         Background vp/vs [unitless].
 
     Returns

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/std_functions/rho.py

@@ -1,9 +1,14 @@
 from warnings import warn
 
 import numpy as np
+import numpy.typing as npt
 
 
-def rho_b(phi, rho_f, rho_mat):
+def rho_b(
+    phi: npt.NDArray[np.float64],
+    rho_f: npt.NDArray[np.float64],
+    rho_mat: npt.NDArray[np.float64],
+) -> npt.NDArray[np.float64]:
     """
     Calculate bulk density from porosity, fluid density and matrix density.
 
@@ -24,7 +29,12 @@ def rho_b(phi, rho_f, rho_mat):
     return phi * rho_f + (1 - phi) * rho_mat
 
 
-def rho_m(frac_cem, phi, rho_cem, rho_min):
+def rho_m(
+    frac_cem: npt.NDArray[np.float64],
+    phi: npt.NDArray[np.float64],
+    rho_cem: npt.NDArray[np.float64],
+    rho_min: npt.NDArray[np.float64],
+) -> npt.NDArray[np.float64]:
     """
     Calculates matrix density as a combination of cement fraction and minerals
     fracCem is defined as cement fraction relative to total volume.

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/std_functions/voigt_reuss_hill.py

@@ -1,7 +1,14 @@
 import numpy as np
+import numpy.typing as npt
 
 
-def voigt(k1, mu1, k2, mu2, f1):
+def voigt(
+    k1: npt.NDArray[np.float64],
+    mu1: npt.NDArray[np.float64],
+    k2: npt.NDArray[np.float64],
+    mu2: npt.NDArray[np.float64],
+    f1: npt.NDArray[np.float64],
+) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
     """
     Effective media calculation of a mixture of two phases using the Voigt bound.
 
@@ -31,7 +38,13 @@ def voigt(k1, mu1, k2, mu2, f1):
     return k_v, mu_v
 
 
-def voigt_reuss_hill(k1, mu1, k2, mu2, f1):
+def voigt_reuss_hill(
+    k1: npt.NDArray[np.float64],
+    mu1: npt.NDArray[np.float64],
+    k2: npt.NDArray[np.float64],
+    mu2: npt.NDArray[np.float64],
+    f1: npt.NDArray[np.float64],
+) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
     """
     Effective media calculation of a mixture of two phases using the Voigt-Reuss-Hill average.
 
@@ -63,7 +76,9 @@ def voigt_reuss_hill(k1, mu1, k2, mu2, f1):
     return k_vrh, mu_vrh
 
 
-def multi_voigt_reuss_hill(*varargin):
+def multi_voigt_reuss_hill(
+    *varargin: npt.NDArray[np.float64],
+) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
     """
     Voigt-Reuss-Hill with multiple mineral input.
 
@@ -97,7 +112,13 @@ def multi_voigt_reuss_hill(*varargin):
     return k, mu
 
 
-def reuss(k1, mu1, k2, mu2, f1):
+def reuss(
+    k1: npt.NDArray[np.float64],
+    mu1: npt.NDArray[np.float64],
+    k2: npt.NDArray[np.float64],
+    mu2: npt.NDArray[np.float64],
+    f1: npt.NDArray[np.float64],
+) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
     """
     Effective media calculation of a mixture of two phases using the Reuss bound.
 

{rock_physics_open-0.3.0 → rock_physics_open-0.3.1}/src/rock_physics_open/equinor_utilities/std_functions/walton.py

@@ -1,7 +1,14 @@
 import numpy as np
+import numpy.typing as npt
 
 
-def walton_smooth(k, mu, phi, p_eff, coord=None):
+def walton_smooth(
+    k: npt.NDArray[np.float64],
+    mu: npt.NDArray[np.float64],
+    phi: npt.NDArray[np.float64],
+    p_eff: npt.NDArray[np.float64],
+    coord: float | npt.NDArray[np.float64] | None = None,
+) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
     """
     Walton Smooth Pressure-induced moduli increase at critical porosity.