rock-physics-open 0.1.2__tar.gz → 0.1.3__tar.gz

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

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

rock_physics_open-0.1.2/.github/workflows/publish-pypi.yaml → rock_physics_open-0.1.3/.github/workflows/on-push-main.yaml

@@ -1,35 +1,51 @@
-name: Publish to PyPI
+name: push to main branch
+
 on:
-  workflow_call:
-  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
 
 jobs:
+  lint-and-format:
+    uses: ./.github/workflows/lint-and-format.yaml
+
+  test:
+    uses: ./.github/workflows/test.yaml
+
+  release-please:
+    needs: test
+    uses: ./.github/workflows/release-please.yaml
+
   build:
-    name: Build wheels
+    name: Build for publishing
+    if: true
+    needs: release-please
     runs-on: ubuntu-latest
-
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@v5
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
           python-version: 3.11
 
-      - name: Build wheels
+      - name: Build
         run: |
           pip install build
           python -m build
 
-      - name: Upload wheels to workflow assets
+      - name: Upload Artifact
         uses: actions/upload-artifact@v4
         with:
           name: distribution
           path: dist/
 
   publish:
-    name: Publish release to PyPI
+    name: Publish to PyPI
     needs: build
     runs-on: ubuntu-latest
     environment:
@@ -39,11 +55,12 @@ jobs:
       id-token: write  # required for Trusted Publishing to PyPI
 
     steps:
-      - uses: actions/download-artifact@v4
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
         with:
           name: distribution
           path: dist/
           merge-multiple: true
 
-      - name: Publish package distributions to PyPI
+      - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

{rock_physics_open-0.1.2 → rock_physics_open-0.1.3}/.github/workflows/release-please.yaml

@@ -18,5 +18,8 @@ jobs:
     steps:
       - uses: googleapis/release-please-action@v4
         id: release
+        with:
+          config-file: .github/release-please-config.json
+          manifest-file: .github/release-please-manifest.json
     outputs:
       release_created: ${{ steps.release.outputs.release_created }}

{rock_physics_open-0.1.2 → rock_physics_open-0.1.3}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [0.1.3](https://github.com/equinor/rock-physics-open/compare/v0.1.2...v0.1.3) (2025-05-13)
+
+
+### Bug Fixes
+
+* remove local version for scm ([d299b64](https://github.com/equinor/rock-physics-open/commit/d299b64c6cc6a75e0a17dabf105e0446be42a81d))
+* initiate standardization of names for input parameters ([#25](https://github.com/equinor/rock-physics-open/issues/25)) ([3d505e3](https://github.com/equinor/rock-physics-open/commit/3d505e39e5e8130dcb9a16bf67fa22c96d47768a))
+* standardize names of input parameters ([#27](https://github.com/equinor/rock-physics-open/issues/27)) ([55126fd](https://github.com/equinor/rock-physics-open/commit/55126fd8e2f3d51c9baad3fb5f55a6a2e0499c38))
+
 ## [0.1.2](https://github.com/equinor/rock-physics-open/compare/v0.1.1...v0.1.2) (2025-05-09)
 
 

{rock_physics_open-0.1.2/src/rock_physics_open.egg-info → rock_physics_open-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rock_physics_open
-Version: 0.1.2
+Version: 0.1.3
 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>
@@ -34,7 +34,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 +67,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 +78,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.1.3",
 ]
 ```
 <!-- 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 → rock_physics_open-0.1.3}/README.md

@@ -1,6 +1,6 @@
 <div align="center">
 
-# rock_physics_open
+# rock-physics-open
 
 [![License: LGPL v3][license-badge]][license]
 [![SCM Compliance][scm-compliance-badge]][scm-compliance]
@@ -33,10 +33,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:
@@ -44,14 +44,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.1.3",
 ]
 ```
 <!-- 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 → rock_physics_open-0.1.3}/src/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-0.1.2 → rock_physics_open-0.1.3}/src/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.1.3'
+__version_tuple__ = version_tuple = (0, 1, 3)

{rock_physics_open-0.1.2 → rock_physics_open-0.1.3/src/rock_physics_open.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rock_physics_open
-Version: 0.1.2
+Version: 0.1.3
 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>
@@ -34,7 +34,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 +67,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 +78,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.1.3",
 ]
 ```
 <!-- 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 → rock_physics_open-0.1.3}/src/rock_physics_open.egg-info/SOURCES.txt

@@ -1,6 +1,5 @@
 .gitignore
 .pre-commit-config.yaml
-.release-please-manifest.json
 CHANGELOG.md
 CONTRIBUTING.md
 LICENSE
@@ -8,13 +7,13 @@ README.md
 SECURITY.md
 pyproject.toml
 pytest.ini
-release-please-config.json
 .github/CODEOWNERS
 .github/dependabot.yaml
+.github/release-please-config.json
+.github/release-please-manifest.json
 .github/workflows/lint-and-format.yaml
 .github/workflows/on-pull-request.yaml
 .github/workflows/on-push-main.yaml
-.github/workflows/publish-pypi.yaml
 .github/workflows/release-please.yaml
 .github/workflows/test.yaml
 src/__init__.py

rock_physics_open-0.1.2/.github/workflows/on-push-main.yaml

@@ -1,22 +0,0 @@
-name: push to main branch
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  lint-and-format:
-    uses: ./.github/workflows/lint-and-format.yaml
-
-  test:
-    uses: ./.github/workflows/test.yaml
-
-  release-please:
-    needs: test
-    uses: ./.github/workflows/release-please.yaml
-
-  publish-latest:
-    needs: release-please
-    if: ${{ needs.release-please.outputs.release_created }}
-    uses: ./.github/workflows/publish-pypi.yaml

rock_physics_open-0.1.2/.release-please-manifest.json

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