<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](https://pypi.org/project/rock-physics-open/) 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.2.1",
]
```
<!-- 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/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
[on-push-main-action-badge]: https://github.com/equinor/rock-physics-open/actions/workflows/on-push-main.yaml/badge.svg
Raw data
{
"_id": null,
"home_page": null,
"name": "rock-physics-open",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "Harald Flesche <hfle@equinor.com>, Eirik Ola Aksnes <eoaksnes@equinor.com>, Christopher Collin L\u00f8kken <chcl@equinor.com>, Sivert Utne <sutn@equinor.com>",
"keywords": "energy, subsurface, seismic, rock physics, scientific, engineering",
"author": null,
"author_email": "Harald Flesche <hfle@equinor.com>, Eivind Jahren <ejah@equinor.com>, Jimmy Zurcher <jiz@equinor.com>",
"download_url": "https://files.pythonhosted.org/packages/3e/78/85b144ec56843b7b5765685701a4516b5ed9c25e0e250a88a73313b5122d/rock_physics_open-0.2.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# rock-physics-open\n\n[![License: LGPL v3][license-badge]][license]\n[![SCM Compliance][scm-compliance-badge]][scm-compliance]\n[![on push main action status][on-push-main-action-badge]][on-push-main-action]\n\n</div>\n\nThis repository contains Python code for rock physics modules created in Equinor by\nHarald Flesche 2010 - ... Batzle-Wang and Span-Wagner fluid equations are implemented\nby Eivind Jahren and Jimmy Zurcher. Some models are based on original Matlab code\nby Tapan Mukerji at Stanford University and ported to Python by Harald Flesche.\n\nThe modules in this repository are implementations of rock physics models\nused in quantitative seismic analysis, in addition to some utilities for handling\nof seismic and well data. The repository started as internal Equinor plugins, and was\nextracted as a separate repository that could be used within other internal applications\nin 2023. In 2025 it was released under LGPL license.\n\nThe content of the library can be described as follows:\n\nFunctions with inputs and outputs consisting of numpy arrays or in some\ncases pandas dataframes. Data frames are used in the cases where there are\nmany inputs and/or there is a need for checking the name of inputs, such\nas when there are multiple inputs of the same type which will have\ndifferent purpose. It should be made clear in which cases data dataframes\nare expected.\nThere is normally not any check on inputs, it is just the minimum\ndefinition of equations and other utilities.\n\n\n## Installation\n\nThis module can be installed through [PyPI](https://pypi.org/project/rock-physics-open/) with:\n\n```sh\npip install rock-physics-open\n```\n\nAlternatively, you can update the dependencies in your `pyproject.toml` file:\n\n<!-- x-release-please-start-version -->\n```toml\ndependencies = [\n \"rock-physics-open == 0.2.1\",\n]\n```\n<!-- x-release-please-end-version -->\n\n<!-- External Links -->\n[scm-compliance]: https://developer.equinor.com/governance/scm-policy/\n[scm-compliance-badge]: https://scm-compliance-api.radix.equinor.com/repos/equinor/rock-physics-open/badge\n[license]: https://www.gnu.org/licenses/lgpl-3.0\n[license-badge]: https://img.shields.io/badge/License-LGPL_v3-blue.svg\n[on-push-main-action]: https://github.com/equinor/rock-physics-open/actions/workflows/on-push-main.yaml\n[on-push-main-action-badge]: https://github.com/equinor/rock-physics-open/actions/workflows/on-push-main.yaml/badge.svg\n",
"bugtrack_url": null,
"license": null,
"summary": "Equinor Rock Physics Module",
"version": "0.2.1",
"project_urls": {
"Changelog": "https://github.com/equinor/rock-physics-open/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/equinor/rock-physics-open",
"Repository": "https://github.com/equinor/rock-physics-open"
},
"split_keywords": [
"energy",
" subsurface",
" seismic",
" rock physics",
" scientific",
" engineering"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "815e0955be222edfea5327bb96745dbad3a744f9d6251eb07ee094654109e427",
"md5": "e326a992b34826f3f04e2abea2e7e5fd",
"sha256": "22c209a3ec740be0b2faab98cf956c6dcb5f21092d82fbccebce407483426a4b"
},
"downloads": -1,
"filename": "rock_physics_open-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e326a992b34826f3f04e2abea2e7e5fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 18225588,
"upload_time": "2025-08-14T11:35:06",
"upload_time_iso_8601": "2025-08-14T11:35:06.439429Z",
"url": "https://files.pythonhosted.org/packages/81/5e/0955be222edfea5327bb96745dbad3a744f9d6251eb07ee094654109e427/rock_physics_open-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3e7885b144ec56843b7b5765685701a4516b5ed9c25e0e250a88a73313b5122d",
"md5": "10a64ad208ec9343affc61cd16b956fb",
"sha256": "33cdf118cb214eb34ea83ebe896ae38f61f0eebbb5c92a8e60918fd712a7572b"
},
"downloads": -1,
"filename": "rock_physics_open-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "10a64ad208ec9343affc61cd16b956fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 18340502,
"upload_time": "2025-08-14T11:35:09",
"upload_time_iso_8601": "2025-08-14T11:35:09.539884Z",
"url": "https://files.pythonhosted.org/packages/3e/78/85b144ec56843b7b5765685701a4516b5ed9c25e0e250a88a73313b5122d/rock_physics_open-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-14 11:35:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "equinor",
"github_project": "rock-physics-open",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "rock-physics-open"
}
JSON
