rock-physics-open 0.0__tar.gz

rock_physics_open-0.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @equinor/rokdoc-plugins

rock_physics_open-0.0/.github/dependabot.yaml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # checks workflow files in ".github/workflows"
+    schedule:
+      interval: "monthly"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "monthly"

rock_physics_open-0.0/.github/workflows/lint-and-format.yaml

@@ -0,0 +1,21 @@
+name: lint-and-format
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: --all-files

rock_physics_open-0.0/.github/workflows/on-pull-request.yaml

@@ -0,0 +1,10 @@
+name: on-pull-request
+
+on:
+  pull_request:
+
+jobs:
+  lint-and-format:
+    uses: ./.github/workflows/lint-and-format.yaml
+  test:
+    uses: ./.github/workflows/test.yaml

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

@@ -0,0 +1,22 @@
+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.0/.github/workflows/publish-pypi.yaml

@@ -0,0 +1,47 @@
+name: Publish to PyPI
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build wheels
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Build wheels
+        run: |
+          pip install build
+          python -m build
+
+      - name: Upload wheels to workflow assets
+        uses: actions/upload-artifact@v4
+        with:
+          name: distribution
+          path: dist/
+
+  publish:
+    name: Publish release to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/rock-physics-open
+    permissions:
+      id-token: write  # required for Trusted Publishing to PyPI
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: distribution
+          path: dist/
+          merge-multiple: true
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

rock_physics_open-0.0/.github/workflows/release-please.yaml

@@ -0,0 +1,22 @@
+name: release-please
+
+on:
+  workflow_call:
+    outputs:
+      release_created:
+        description: "If true, a release PR has been merged"
+        value: ${{ jobs.release-please.outputs.release_created }}
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}

rock_physics_open-0.0/.github/workflows/test.yaml

@@ -0,0 +1,62 @@
+name: test
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {
+            artifact: "Windows-MSVC",
+            cc: "cl", cxx: "cl",
+            os: windows-latest,
+          }
+          - {
+            artifact: "Windows-MinGW",
+            cc: "gcc", cxx: "g++",
+            os: windows-latest,
+          }
+          - {
+            artifact: "Linux",
+            cc: "gcc", cxx: "g++",
+            os: ubuntu-latest,
+          }
+          - {
+            artifact: "Mac",
+            cc: "clang", cxx: "clang++",
+            os: macos-latest,
+          }
+
+    runs-on: ${{ matrix.config.os }}
+    name: ${{ matrix.config.artifact }} (${{ matrix.config.os }}, ${{ matrix.config.cc }}/${{ matrix.config.cxx }})
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+
+    - name: Upgrade Pip
+      run: pip install --upgrade pip
+
+    - name: Show Machine Information
+      run: |
+        pip install py-cpuinfo
+        python -m cpuinfo
+
+    - name: Install Dependencies
+      run: pip install .[tests]
+
+    - name: Test
+      if: ${{ matrix.config.artifact == 'Windows-MSVC' }}
+      run: pytest
+
+    - name: Test ( -m "not use_graphics" )
+      if: ${{ matrix.config.artifact != 'Windows-MSVC' }}
+      run: pytest -m "not use_graphics"

rock_physics_open-0.0/.gitignore

@@ -0,0 +1,22 @@
+.DS_Store
+.idea/
+.vscode/
+.venv
+venv/
+.tool-versions
+.python-version
+
+build/
+__pycache__/
+*.pyc
+*.egg-info
+.eggs
+version.py
+.dccache
+.coverage
+
+/tests/**/snapshots/*.log
+/tests/data/*.txt
+/tests/data/pat_cem.pkl
+
+/Notebooks/

rock_physics_open-0.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+default_stages: [pre-commit]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-ast
+        language_version: python3.11
+      - id: debug-statements
+      - id: check-merge-conflict
+      - id: detect-private-key
+      - id: check-case-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: check-json
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.7
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

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

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

rock_physics_open-0.0/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## [0.1.2](https://github.com/equinor/rock-physics-open/compare/v0.1.1...v0.1.2) (2025-05-09)
+
+
+### Bug Fixes
+
+* avoid building deps wheels ([e188e9d](https://github.com/equinor/rock-physics-open/commit/e188e9d84d95bad08040dff5411b020c0af1426d))
+* check release please output ([275f13e](https://github.com/equinor/rock-physics-open/commit/275f13e018af560d5459e8ac779825de517f0feb))
+* use id for step to catch output value ([681c5e3](https://github.com/equinor/rock-physics-open/commit/681c5e3e36fd90dfc43c704a3298688ea6745e05))
+
+## [0.1.1](https://github.com/equinor/rock-physics-open/compare/v0.1.0...v0.1.1) (2025-05-09)
+
+
+### Bug Fixes
+
+* use pip wheel to build wheels ([7c7b9f4](https://github.com/equinor/rock-physics-open/commit/7c7b9f405309ad8be3c76f91028260936d842b05))
+
+## 0.1.0 (2025-05-08)
+
+
+### Features
+
+* initial release ([1ecc1c2](https://github.com/equinor/rock-physics-open/commit/1ecc1c2f0bff534bcdc007d4951865c4c37d5435))

rock_physics_open-0.0/CONTRIBUTING.md

@@ -0,0 +1,100 @@
+# Contribution Guidelines
+
+Instructions and guidelines for how you can contribute to this repository.
+
+## Issues
+
+For reporting bugs, requesting new features and more do so by [creating a new issue][new-issue]. Make sure that:
+- The issue clearly states expected vs current behavior
+- Includes steps to reproduce bugs
+- Look through the [existing issues][existing-issues] to see if your issue or suggestion has already been reported, if it has, add your own context to that issue instead of creating a new one.
+
+## Development
+
+How you can contribute code to this repository yourself.
+
+### Requirements
+
+> We recommend using a Python version and virtual environment manager, such as [asdf][asdf] or [pyenv][pyenv].
+
+- [Git][git]
+- [Python][python], version >= 3.11
+
+### Install Dependencies
+
+To install all the dependencies and test/dev dependencies do:
+```sh
+pip install ."[tests]"
+```
+
+> This installs [pre-commit][pre-commit] to enforce consistent formatting using [ruff][ruff]. Remember to activate it to automatically format code locally on all commits with:
+> ```sh
+> pre-commit install
+> ```
+
+#### Updating / Adding Dependencies
+
+Dependencies and their versions are managed by the codeowners based on external requirements.
+
+### Running Tests
+
+Ensure everyting is working as expected by running all the tests with:
+```sh
+pytest
+```
+
+<details>
+<summary>How can i see the test coverage?</summary>
+
+Add the `--cov=rock_physics_open` argument to `pytest` to see the coverage across this project:
+```sh
+pytest --cov=rock_physics_open
+```
+
+</details>
+
+<details>
+<summary>Im getting <code>No module named '_tkinter'</code> error when running the tests?</summary>
+
+You can skip these graphics tests by doing:
+```sh
+pytest -m "not use_graphics"
+```
+
+</details>
+
+### Pull-Requests
+
+- should only solve a single problem/issue
+- can be in the form of a single or multiple commits
+- must always be up to date with the `main` branch when:
+  - the PR is created
+  - before the PR is merged
+- must explain **why** and **how** of the proposed changes in the PR description.
+- ensure the commit history is clean
+
+#### Commits
+
+- Use [conventional commit messages][conventional-commits], as they are used to generate the changelog and perform releases using [release please][release-please].
+- A single commit should only contain a *single logical change*
+  - Commit should be as small as possible
+  - Commit should contain a complete change
+
+#### Review
+
+A PR must be approved by a *Code Owner*. Once a PR is marked as ready for review _and_ passes all required checks a code owner will look through the PR as soon as they are able to.
+
+If the PR is approved you can either `squash and merge` or `rebase and merge` it with main depending on commits/changes in the PR. If the reviewer had comments, or the request is not approved, address and resolve these comments before re-requesting a review.
+
+<!-- External Links -->
+[new-issue]: https://github.com/equinor/rock-physics-open/issues/new/choose
+[existing-issues]: https://github.com/equinor/rock-physics-open/issues?q=is%3Aissue
+[release-please]: https://github.com/googleapis/release-please?tab=readme-ov-file#release-please
+[conventional-commits]: https://www.conventionalcommits.org/en/v1.0.0/
+
+[git]: https://git-scm.com
+[python]: https://www.python.org/
+[asdf]: https://asdf-vm.com
+[pyenv]: https://github.com/pyenv/pyenv
+[pre-commit]: https://pre-commit.com
+[ruff]: https://docs.astral.sh/ruff/

rock_physics_open-0.0/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

rock_physics_open-0.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: rock_physics_open
+Version: 0.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
+Keywords: energy,subsurface,seismic,rock physics,scientific,engineering
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Natural Language :: English
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: pandas>=2.0.2
+Requires-Dist: matplotlib>=3.7.1
+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">
+
+# rock_physics_open
+
+[![License: LGPL v3][license-badge]][license]
+[![SCM Compliance][scm-compliance-badge]][scm-compliance]
+[![on push main action status][on-push-main-action-badge]][on-push-main-action]
+
+</div>
+
+This repository contains Python code for rock physics modules created in Equinor by
+Harald Flesche 2010 - ... Batzle-Wang and Span-Wagner fluid equations are implemented
+by Eivind Jahren and Jimmy Zurcher. Some models are based on original Matlab code
+by Tapan Mukerji at Stanford University and ported to Python by Harald Flesche.
+
+The modules in this repository are implementations of rock physics models
+used in quantitative seismic analysis, in addition to some utilities for handling
+of seismic and well data. The repository started as internal Equinor plugins, and was
+extracted as a separate repository that could be used within other internal applications
+in 2023. In 2025 it was released under LGPL license.
+
+The content of the library can be described as follows:
+
+Functions with inputs and outputs consisting of numpy arrays or in some
+cases pandas dataframes. Data frames are used in the cases where there are
+many inputs and/or there is a need for checking the name of inputs, such
+as when there are multiple inputs of the same type which will have
+different purpose. It should be made clear in which cases data dataframes
+are expected.
+There is normally not any check on inputs, it is just the minimum
+definition of equations and other utilities.
+
+
+## Installation
+
+This module can be installed through PyPi with:
+
+```sh
+pip install rock_physics_open
+```
+
+Alternatively, you can update the dependencies in your `pyproject.toml` file:
+
+<!-- x-release-please-start-version -->
+```toml
+dependencies = [
+    "rock_physics_open == 0.1.2",
+]
+```
+<!-- 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
+[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
+[on-push-main-action-badge]:  https://github.com/equinor/rock-physics-open/actions/workflows/on-push-main.yaml/badge.svg