Utility for calculating elastic properties of rocks and fluids.
Project description
open_petro_elastic
A Python library for petro-elastic modelling. It contains a Material
class for representing rocks and fluids, as well as various rock physics models and algorithms such as Hashin-Shtrikman bounds and Gassmann fluid substitution.
Installation
pip install open_petro_elastic
Developers and contributors can download the repository and do pip install ".[dev,test,docs]"
to install the package with all its dependencies for development, testing, and building the docs.
Usage
The tool can be used as a library, or from the command line using YAML configuration files. For example, see the tutorial config file.
Generally, the open_petro_elastic.material
module is used for interfacing with open_petro_elastic
as a Python library:
>>> from open_petro_elastic.material import Material
>>> from open_petro_elastic.material.sandstone import hertz_mindlin
>>> mineral = Material(bulk_modulus=1e9, shear_modulus=1e9, density=1000)
>>> sand = hertz_mindlin(mineral, porosity=0.4, pressure=1e6)
>>> print(sand.density)
600.0
To get help on the command line interface:
open_petro_elastic --help
See the docs for more usage instructions.
Run tests
Developers and contributors should install everything test_requirements.txt
. Then tests can be run with:
pytest
Developers should also intall everything in doc_requirements.txt
and read the Code of Conduct.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for open_petro_elastic-1.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c73a6d0f86a3dbfd9fcf1dc1ac885884c1cedd1a3e7a2104d4e17f6f16e87da |
|
MD5 | d762cf87cfcdd112c7e2547e2f3a6848 |
|
BLAKE2b-256 | d9b62577877b308b546023f8af48a9306ebd8ad314310c0c2a5b25d66a86ec8d |