rock-physics-open 0.1.2__py3-none-any.whl → 0.2.0__py3-none-any.whl

rock_physics_open/equinor_utilities/snapshot_test_utilities/compare_snapshots.py

@@ -11,18 +11,19 @@ from rock_physics_open.equinor_utilities.various_utilities import disp_result_st
 
 from .snapshots import get_snapshot_name
 
-DISPLAY_RESULTS = False
-
 
 def compare_snapshots(
     test_results: Union[np.ndarray, tuple, DataFrame],
     saved_results: tuple,
+    name_arr=None,
+    display_results: bool = False,
 ) -> bool:
     test_results = _validate_input(test_results, saved_results)
 
-    if DISPLAY_RESULTS:
+    if display_results:
         title = str(inspect.stack()[1].function)
-        name_arr = [f"arr_{i}" for i in range(len(test_results))]
+        if not name_arr:
+            name_arr = [f"arr_{i}" for i in range(len(test_results))]
         disp_result_stats(title, test_results, name_arr)
 
     r_tol = 0.01

rock_physics_open/equinor_utilities/snapshot_test_utilities/snapshots.py

@@ -1,5 +1,4 @@
 import inspect
-import os
 from pathlib import Path
 
 import numpy as np
@@ -9,7 +8,6 @@ INITIATE = False
 
 def get_snapshot_name(step: int = 1, include_snapshot_dir=True) -> str:
     """
-
     Parameters
     ----------
     step: number of steps in the trace to collect information from
@@ -18,15 +16,25 @@ def get_snapshot_name(step: int = 1, include_snapshot_dir=True) -> str:
     Returns
     -------
     name of snapshot file
-
     """
-    # Get filename and function name of calling function
     trace = inspect.stack()
-    dir_name = Path(trace[step].filename).parent.joinpath("snapshots")
-    file_name = "_".join(
-        (Path(trace[step].filename).stem, trace[step].function + ".npz")
-    )
-    return os.path.join(dir_name, file_name) if include_snapshot_dir else file_name
+    for frame in trace[step:]:
+        if not any(
+            keyword in frame.filename
+            for keyword in [
+                "pydev",
+                "ipython-input",
+                "interactiveshell",
+                "async_helpers",
+            ]
+        ):
+            break
+    else:
+        frame = trace[step]
+
+    dir_name = Path(frame.filename).parent / "snapshots"
+    file_name = f"{Path(frame.filename).stem}_{frame.function}.npz"
+    return str(dir_name / file_name) if include_snapshot_dir else file_name
 
 
 def store_snapshot(snapshot_name: str, *args: np.ndarray) -> bool:

rock_physics_open/fluid_models/oil_model/oil_properties.py

@@ -10,19 +10,19 @@ from .oil_bubble_point import bp_standing
 
 
 def oil_properties(
-    temp: np.ndarray | float,
-    pres: np.ndarray | float,
+    temperature: np.ndarray | float,
+    pressure: np.ndarray | float,
     rho0: np.ndarray | float,
-    gor: np.ndarray | float,
-    gr: np.ndarray | float,
+    gas_oil_ratio: np.ndarray | float,
+    gas_gravity: np.ndarray | float,
 ) -> np.ndarray | float:
     """
-    :param temp: Temperature (Celsius) of oil.
-    :param pres: Pressure (Pa) of oil
+    :param temperature: Temperature (Celsius) 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)
-    :param gor: The volume ratio of gas to oil [l/l]
-    :param gr: Gas Gravity, molar mass of gas relative to air molar mas.
+    :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
     """
     # Since live_oil with gas_oil_ratio=0.0 is not equal to dead oil
@@ -41,9 +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(temp, pres, rho0, gor, gr)
-    doil_den, doil_vel = dead_oil(temp, pres, rho0)
-    window = triangular_window(gor)
+    loil_den, loil_vel = live_oil(
+        temperature, pressure, rho0, gas_oil_ratio, gas_gravity
+    )
+    doil_den, doil_vel = 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
     k_oil = vel_oil**2 * den_oil

rock_physics_open/span_wagner/co2_properties.py

@@ -1,5 +1,6 @@
+import importlib
+
 import numpy as np
-import pkg_resources
 import scipy.optimize
 from scipy.interpolate import RegularGridInterpolator
 
@@ -420,11 +421,16 @@ def carbon_dioxide_density(absolute_temperature, pressure, interpolate=False, **
             absolute_temperature, pressure, **kwargs
         )
     assert interpolate is True
-    fp = pkg_resources.resource_filename(
-        "rock_physics.fluid_models.gas_model.span_wagner.tables",
-        "carbon_dioxide_density.npz",
+
+    ref = (
+        importlib.resources.files(
+            "rock_physics.fluid_models.gas_model.span_wagner.tables"
+        )
+        / "carbon_dioxide_density.npz"
     )
-    interpolator = load_lookup_table_interpolator(fp)
+    with importlib.resources.as_file(ref) as fp:
+        interpolator = load_lookup_table_interpolator(fp)
+
     return interpolator(absolute_temperature, pressure)
 
 

rock_physics_open/version.py

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

{rock_physics_open-0.1.2.dist-info → rock_physics_open-0.2.0.dist-info}/METADATA

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: rock_physics_open
-Version: 0.1.2
+Version: 0.2.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>
 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
 Keywords: energy,subsurface,seismic,rock physics,scientific,engineering
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering
@@ -14,6 +15,7 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Utilities
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Natural Language :: English
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -34,7 +36,7 @@ Dynamic: license-file
 
 <div align="center">
 
-# rock_physics_open
+# rock-physics-open
 
 [![License: LGPL v3][license-badge]][license]
 [![SCM Compliance][scm-compliance-badge]][scm-compliance]
@@ -67,10 +69,10 @@ definition of equations and other utilities.
 
 ## Installation
 
-This module can be installed through PyPi with:
+This module can be installed through [PyPI](https://pypi.org/project/rock-physics-open/) with:
 
 ```sh
-pip install rock_physics_open
+pip install rock-physics-open
 ```
 
 Alternatively, you can update the dependencies in your `pyproject.toml` file:
@@ -78,14 +80,14 @@ Alternatively, you can update the dependencies in your `pyproject.toml` file:
 <!-- x-release-please-start-version -->
 ```toml
 dependencies = [
-    "rock_physics_open == 0.1.2",
+    "rock-physics-open == 0.2.0",
 ]
 ```
 <!-- x-release-please-end-version -->
 
 <!-- External Links -->
 [scm-compliance]: https://developer.equinor.com/governance/scm-policy/
-[scm-compliance-badge]: https://scm-compliance-api.radix.equinor.com/repos/equinor/7ace9d61-dd9d-46b6-901d-f0f008fef142/badge
+[scm-compliance-badge]: https://scm-compliance-api.radix.equinor.com/repos/equinor/rock-physics-open/badge
 [license]: https://www.gnu.org/licenses/lgpl-3.0
 [license-badge]: https://img.shields.io/badge/License-LGPL_v3-blue.svg
 [on-push-main-action]: https://github.com/equinor/rock-physics-open/actions/workflows/on-push-main.yaml

{rock_physics_open-0.1.2.dist-info → rock_physics_open-0.2.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 rock_physics_open/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rock_physics_open/version.py,sha256=bSmADqydH8nBu-J4lG8UVuR7hnU_zcwhnSav2oQ0W0A,511
+rock_physics_open/version.py,sha256=iB5DfB5V6YB5Wo4JmvS-txT42QtmGaWcWp3udRT7zCI,511
 rock_physics_open/equinor_utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rock_physics_open/equinor_utilities/anisotropy.py,sha256=toEsuIW_gHr34gZQpam3sQTl0ap6nAq1pW5hcX9GOHI,4469
 rock_physics_open/equinor_utilities/conversions.py,sha256=d6SGPbzYsmYBvhDqnohg1lPjAeYGOc0z_vdsuFeNlb4,194
@@ -23,8 +23,8 @@ rock_physics_open/equinor_utilities/machine_learning_utilities/import_ml_models.
 rock_physics_open/equinor_utilities/machine_learning_utilities/run_regression.py,sha256=L0bCEsMCvcOn6Ji9oDLztY-TaEEYvp1b7bYZQSJ_-II,4799
 rock_physics_open/equinor_utilities/machine_learning_utilities/sigmoidal_model.py,sha256=XczrkhwSF1bAO0XcYMirbj0ilLyZG6RgT7cX2owPufw,6001
 rock_physics_open/equinor_utilities/snapshot_test_utilities/__init__.py,sha256=lcbI80ZH6JQS0jI-eUITFBafHVRdhQ5VwttPolHnJyI,255
-rock_physics_open/equinor_utilities/snapshot_test_utilities/compare_snapshots.py,sha256=-3sPFISobumPT6cdfqIeL9cwodXFG31nmBWzm3Er5VI,5399
-rock_physics_open/equinor_utilities/snapshot_test_utilities/snapshots.py,sha256=lx-UoaZ0KygSYTJKD9h7hwvgBZGduyBcZqWuQoxU7GY,1532
+rock_physics_open/equinor_utilities/snapshot_test_utilities/compare_snapshots.py,sha256=DBF9SNrC7H2V_zTNjmWK-Nz5b0uqNdx5Nktt858VJak,5457
+rock_physics_open/equinor_utilities/snapshot_test_utilities/snapshots.py,sha256=fiFqqKh7iTHMoo2rjl41KovbOm2_B2rw_QLWhI9XIBU,1731
 rock_physics_open/equinor_utilities/std_functions/__init__.py,sha256=MLOfMxRazS9tGOVvuLkUp-E4b6jRWOP4YCLf8si624c,1121
 rock_physics_open/equinor_utilities/std_functions/backus_ave.py,sha256=sYaXSfqjR69U_UFaMmrD5aEbR_0FrL7ZIWGg-Yi8QNo,1607
 rock_physics_open/equinor_utilities/std_functions/dvorkin_nur.py,sha256=TerlLcuP92ihf5vHaJES5KLyleG3CR7NWSExDI1jLIY,2138
@@ -61,7 +61,7 @@ rock_physics_open/fluid_models/oil_model/dead_oil_velocity.py,sha256=jA-XxbxsBzs
 rock_physics_open/fluid_models/oil_model/live_oil_density.py,sha256=oURrY4YM28RoC6I513xWiWIUi6hWSNIFgdb5D01kjwE,2775
 rock_physics_open/fluid_models/oil_model/live_oil_velocity.py,sha256=pPAZm24CPTJQYF9CK69t7UWkWI2JjGksR9XKccUPhbI,937
 rock_physics_open/fluid_models/oil_model/oil_bubble_point.py,sha256=hWxxJtYZFK8_mVuKTYGipLmkT6DJobz6SVm53fa_rSc,2605
-rock_physics_open/fluid_models/oil_model/oil_properties.py,sha256=6nucE7M_wUb-YEW-Wmos7OnqxDlnsuDJBhCF3EPGh_0,4117
+rock_physics_open/fluid_models/oil_model/oil_properties.py,sha256=U8CbgrnwYT9c3lSw9yILwm8_Mau7sKpFM1BLc3zlIOw,4242
 rock_physics_open/sandstone_models/__init__.py,sha256=KC_b_SMFzIeTVXZy1IDFVSa0jC5sHlONJjun5R12H6A,1955
 rock_physics_open/sandstone_models/cemented_shalysand_sandyshale_models.py,sha256=jXEuEOMOmiAukYlDgV3-vd2tiZWW8Dm59PaeP-XXh8Y,8516
 rock_physics_open/sandstone_models/constant_cement_models.py,sha256=kHRcPEC114uolMZvvPxzvHJhF9wdSuuDKNS0mNFrqtI,7223
@@ -86,7 +86,7 @@ rock_physics_open/shale_models/sca.py,sha256=eSzPBFQnm6SoL8f5UACs_PSlCgXU3QgwK69
 rock_physics_open/shale_models/shale4_mineral.py,sha256=aJ2KIWR3EUtjDjJ-mBYQACVv6QQg_73HFW9FNwicwsc,3862
 rock_physics_open/shale_models/shale4_mineral_dem_overlay.py,sha256=ty8yKoUVuBKeLT17gdS1BHBV1EJCQIpl-b5JG2fF4I8,2660
 rock_physics_open/span_wagner/__init__.py,sha256=cnvKCSmO0_KkEhbbV3BoDsV-NhlGLnDpBwErI8TPKuQ,80
-rock_physics_open/span_wagner/co2_properties.py,sha256=a2KBm86VMF4FZLcXdU7G0_cOPeGqMarat-HtpFw1_n4,16287
+rock_physics_open/span_wagner/co2_properties.py,sha256=7w-VZjR6vUOxX-NWTpLhoXH4fiUCNXd8-HBTrg-nm4w,16358
 rock_physics_open/span_wagner/coefficients.py,sha256=dGSW58MWnx064LaW0RwIaSDjP1aqV_5Bs9pk9Aaz9j0,3878
 rock_physics_open/span_wagner/equations.py,sha256=wE99XBrx70NqgxS1qdyGlKTusGihWrtdv3KlpifCz_c,3001
 rock_physics_open/span_wagner/tables/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -135,8 +135,8 @@ rock_physics_open/ternary_plots/shale_prop_ternary.py,sha256=5-NB4LoXRP7JPQYaJBZ
 rock_physics_open/ternary_plots/ternary_patches.py,sha256=oYaIkCbzC4L19VWBz5iphVdQnpHX9kdy0p2NK65aIIM,7256
 rock_physics_open/ternary_plots/ternary_plot_utilities.py,sha256=weFDWyzd7wgr3xB63Q-xtT-KoJA6FNIDWuTkA7jr94Q,5669
 rock_physics_open/ternary_plots/unconventionals_ternary.py,sha256=KWjcBrjI8Tgr2FYpz1ey-DPuhUeSC7b5mpN8OzwNa4I,1823
-rock_physics_open-0.1.2.dist-info/licenses/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-rock_physics_open-0.1.2.dist-info/METADATA,sha256=el78VhHZ7oWtxWfvCkG-WrxAhN0QxyJleObtQ9hiCWI,3906
-rock_physics_open-0.1.2.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-rock_physics_open-0.1.2.dist-info/top_level.txt,sha256=zFBbfbv2pshFJvcvcLLigDmlJjjg08iDdb6ABgncaP8,18
-rock_physics_open-0.1.2.dist-info/RECORD,,
+rock_physics_open-0.2.0.dist-info/licenses/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+rock_physics_open-0.2.0.dist-info/METADATA,sha256=swSAgEPAbnAGWi5i3eQ3nQDEc4T0AfPDD_2lMoIS5Ug,4077
+rock_physics_open-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rock_physics_open-0.2.0.dist-info/top_level.txt,sha256=zFBbfbv2pshFJvcvcLLigDmlJjjg08iDdb6ABgncaP8,18
+rock_physics_open-0.2.0.dist-info/RECORD,,

{rock_physics_open-0.1.2.dist-info → rock_physics_open-0.2.0.dist-info}/WHEEL

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