rock-physics-open 0.2.3__py3-none-any.whl → 0.3.1__py3-none-any.whl

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/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/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/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/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/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/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/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.
 

rock_physics_open/equinor_utilities/std_functions/wood_brie.py

@@ -1,7 +1,18 @@
+from collections.abc import Sequence
+
 import numpy as np
+import numpy.typing as npt
 
 
-def brie(s_gas, k_gas, s_brine, k_brine, s_oil, k_oil, e):
+def brie(
+    s_gas: npt.NDArray[np.float64],
+    k_gas: npt.NDArray[np.float64],
+    s_brine: npt.NDArray[np.float64],
+    k_brine: npt.NDArray[np.float64],
+    s_oil: npt.NDArray[np.float64],
+    k_oil: npt.NDArray[np.float64],
+    e: float | npt.NDArray[np.float64],
+) -> npt.NDArray[np.float64]:
     """
     Brie function for effective bulk modulus of a mix of fluids.
 
@@ -36,7 +47,13 @@ def brie(s_gas, k_gas, s_brine, k_brine, s_oil, k_oil, e):
     return (k_liquid - k_gas) * (1 - s_gas) ** e + k_gas
 
 
-def wood(s1, k1, rho1, k2, rho2):
+def wood(
+    s1: npt.NDArray[np.float64],
+    k1: npt.NDArray[np.float64],
+    rho1: npt.NDArray[np.float64],
+    k2: npt.NDArray[np.float64],
+    rho2: npt.NDArray[np.float64],
+) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
     """
     Wood effective fluid properties for a mix of two fluids.
 
@@ -67,7 +84,7 @@ def wood(s1, k1, rho1, k2, rho2):
     return k, rho
 
 
-def multi_wood(fractions, bulk_moduli):
+def multi_wood(fractions: Sequence[float], bulk_moduli: Sequence[float]) -> float:
     assert len(fractions) == len(bulk_moduli)
     sum_fractions = sum(fractions)
     ratio_sum = sum(

rock_physics_open/equinor_utilities/various_utilities/display_result_statistics.py

@@ -1,10 +1,15 @@
 import os
 import sys
+from collections.abc import Sequence
+from typing import Any, Literal, cast
 
 import numpy as np
+import numpy.typing as npt
 
 
-def disp_result_stats(title: str, arr: list | tuple, names_arr: list, **kwargs):
+def disp_result_stats(
+    title: str, arr: Sequence[Any], names_arr: list[str], **kwargs: Any
+) -> None:
     """
     Display results utilizing tkinter.
 
@@ -17,17 +22,19 @@ def disp_result_stats(title: str, arr: list | tuple, names_arr: list, **kwargs):
     from tkinter import END, Entry, PhotoImage, Tk
 
     class Table:
-        def __init__(self, tk_root, no_rows, no_cols, info):
+        def __init__(
+            self, tk_root: Tk, no_rows: int, no_cols: int, info: npt.NDArray[Any]
+        ):
             # code for creating table
             str_len = np.vectorize(len)
-            text_justify = ["center", "left"]
-            text_weight = ["bold", "normal"]
+            text_justify: list[Literal["center", "left"]] = ["center", "left"]
+            text_weight: list[str] = ["bold", "normal"]
             for i in range(no_rows):
-                weigh = text_weight[np.sign(i)]
+                weigh = text_weight[cast(int, np.sign(i))]
                 for j in range(no_cols):
-                    just = text_justify[np.sign(i)]
+                    just = text_justify[cast(int, np.sign(i))]
                     max_len = np.max(str_len(info[:, j]))
-                    self.e = Entry(
+                    self.e: Entry = Entry(
                         tk_root,
                         width=max_len + 2,
                         fg="black",
@@ -57,7 +64,7 @@ def disp_result_stats(title: str, arr: list | tuple, names_arr: list, **kwargs):
             info_array[k + 1, 4] = f"{np.sum(np.isnan(np.asarray(arr[k])))}"
             info_array[k + 1, 5] = f"{np.sum(np.isinf(np.asarray(arr[k])))}"
 
-    Table(root, info_array.shape[0], info_array.shape[1], info_array)
+    _ = Table(root, info_array.shape[0], info_array.shape[1], info_array)
 
     root.update_idletasks()
     window_height = root.winfo_height()
@@ -78,6 +85,6 @@ def disp_result_stats(title: str, arr: list | tuple, names_arr: list, **kwargs):
         logo = PhotoImage(
             file=os.path.join(os.path.dirname(__file__), "Equinor_logo.gif")
         )
-        root.call("wm", "iconphoto", root._w, logo)
+        root.wm_iconphoto(True, logo)
 
     root.mainloop()

rock_physics_open/equinor_utilities/various_utilities/gassmann_dry_mod.py

@@ -1,7 +1,26 @@
+import numpy as np
+import numpy.typing as npt
+
 from rock_physics_open.equinor_utilities import std_functions
 
 
-def gassmann_dry_model(k_min, k_fl, rho_fl, k_sat, mu, rho_sat, por):
+def gassmann_dry_model(
+    k_min: npt.NDArray[np.float64],
+    k_fl: npt.NDArray[np.float64],
+    rho_fl: npt.NDArray[np.float64],
+    k_sat: npt.NDArray[np.float64],
+    mu: npt.NDArray[np.float64],
+    rho_sat: npt.NDArray[np.float64],
+    por: 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],
+    npt.NDArray[np.float64],
+    npt.NDArray[np.float64],
+]:
     """
     Gassmann model to go from saturated rock to dry state.
 
@@ -25,7 +44,7 @@ def gassmann_dry_model(k_min, k_fl, rho_fl, k_sat, mu, rho_sat, por):
     Returns
     -------
     tuple
-        vp_dry, vs_dry, rho_dry, ai_dry, vpvs_dry, k_dry, mu : (np.ndarray, np.ndarray, np.ndarray, np.ndarray, np.ndarray, np.ndarray, np.ndarray).
+        vp_dry, vs_dry, rho_dry, ai_dry, vpvs_dry, k_dry, mu : np.ndarray
         vp_dry, vs_dry:  dry velocities [m/s], rho_dry: dry density [kg/m^3], ai_dry: dry acoustic impedance
         [kg/m^3 x m/s], vpvs_dry: dry velocity ratio [unitless], k_dry, mu: dry bulk modulus and shear modulus (the
         latter unchanged from saturated state) [Pa].

rock_physics_open/equinor_utilities/various_utilities/gassmann_mod.py

@@ -1,7 +1,26 @@
+import numpy as np
+import numpy.typing as npt
+
 from rock_physics_open.equinor_utilities import std_functions
 
 
-def gassmann_model(k_min, k_fl, rho_fl, k_dry, mu, rho_dry, por):
+def gassmann_model(
+    k_min: npt.NDArray[np.float64],
+    k_fl: npt.NDArray[np.float64],
+    rho_fl: npt.NDArray[np.float64],
+    k_dry: npt.NDArray[np.float64],
+    mu: npt.NDArray[np.float64],
+    rho_dry: npt.NDArray[np.float64],
+    por: 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],
+    npt.NDArray[np.float64],
+    npt.NDArray[np.float64],
+]:
     """
     Gassmann model to go from dry rock to saturated state.
 
@@ -25,7 +44,7 @@ def gassmann_model(k_min, k_fl, rho_fl, k_dry, mu, rho_dry, por):
     Returns
     -------
     tuple
-        vp_sat, vs_sat, rho_sat, ai_sat, vpvs_sat, k_sat, mu : (np.ndarray, np.ndarray, np.ndarray, np.ndarray, np.ndarray, np.ndarray, np.ndarray).
+        vp_sat, vs_sat, rho_sat, ai_sat, vpvs_sat, k_sat, mu : np.ndarray
         vp_sat, vs_sat:  saturated velocities [m/s], rho_sat: saturated density [kg/m^3], ai_sat: saturated acoustic
         impedance [kg/m^3 x m/s], vpvs_sat: saturated velocity ratio [unitless], k_sat, mu: saturated bulk modulus and
         shear modulus (the latter unchanged from dry state) [Pa].

rock_physics_open/equinor_utilities/various_utilities/gassmann_sub_mod.py

@@ -1,17 +1,28 @@
+import numpy as np
+import numpy.typing as npt
+
 from rock_physics_open.equinor_utilities import std_functions
 
 
 def gassmann_sub_model(
-    k_min,
-    k_fl_orig,
-    rho_fl_orig,
-    k_fl_sub,
-    rho_fl_sub,
-    k_sat_orig,
-    mu,
-    rho_sat_orig,
-    por,
-):
+    k_min: npt.NDArray[np.float64],
+    k_fl_orig: npt.NDArray[np.float64],
+    rho_fl_orig: npt.NDArray[np.float64],
+    k_fl_sub: npt.NDArray[np.float64],
+    rho_fl_sub: npt.NDArray[np.float64],
+    k_sat_orig: npt.NDArray[np.float64],
+    mu: npt.NDArray[np.float64],
+    rho_sat_orig: npt.NDArray[np.float64],
+    por: 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],
+    npt.NDArray[np.float64],
+    npt.NDArray[np.float64],
+]:
     """
     Gassmann model to go from one saturated state to another.
 
@@ -24,7 +35,7 @@ def gassmann_sub_model(
     rho_fl_orig : np.ndarray
         Original fluid density [lg/m^3].
     k_fl_sub : np.ndarray
-        Sunstituted fluid  bulk modulus [Pa].
+        Substituted fluid  bulk modulus [Pa].
     rho_fl_sub : np.ndarray
         Substituted fluid density [lg/m^3].
     k_sat_orig : np.ndarray
@@ -39,7 +50,7 @@ def gassmann_sub_model(
     Returns
     -------
     tuple
-        vp_sat, vs_sat, rho_sat, ai_sat, vpvs_sat, k_sat, mu : (np.ndarray, np.ndarray, np.ndarray, np.ndarray, np.ndarray, np.ndarray, np.ndarray).
+        vp_sat, vs_sat, rho_sat, ai_sat, vpvs_sat, k_sat, mu : np.ndarray
         vp_sat, vs_sat:  saturated velocities [m/s], rho_sat: saturated density [kg/m^3], ai_sat: saturated acoustic
         impedance [kg/m^3 x m/s], vpvs_sat: saturated velocity ratio [unitless], k_sat, mu: saturated bulk modulus and
         shear modulus (the latter unchanged from dry state) [Pa].

rock_physics_open/equinor_utilities/various_utilities/hs_average.py

@@ -1,7 +1,26 @@
+import numpy as np
+import numpy.typing as npt
+
 from rock_physics_open.equinor_utilities import std_functions
 
 
-def hs_average(k1, mu1, rhob1, k2, mu2, rhob2, f):
+def hs_average(
+    k1: npt.NDArray[np.float64],
+    mu1: npt.NDArray[np.float64],
+    rhob1: npt.NDArray[np.float64],
+    k2: npt.NDArray[np.float64],
+    mu2: npt.NDArray[np.float64],
+    rhob2: npt.NDArray[np.float64],
+    f: 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],
+    npt.NDArray[np.float64],
+    npt.NDArray[np.float64],
+]:
     """
     BMix of two phases by Hashin-Shtrikman model. Derived properties are also returned.