Stresslog: A Python package for modeling wellbore stability in inclined stress states
Stresslog: A Python package for modeling wellbore stability in inclined stress states - Published in JOSS (2025)
Science Score: 93.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 14 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Repository
Python package to read well logs and model geomechanical properties.
Basic Info
Statistics
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 0
- Releases: 40
Topics
Metadata Files
README.md
Stresslog
A package to calculate and plot pore pressure and other geomechanical data from las files. It is intended for pre-drill and post-drill studies of wells, and can be used for limited realtime stress prediction.
Features
Import las files, dlis files, deviation files, ucs and lithology files
Alias logs using user modifiable alias file
Pad log data all the way to surface, using appropriate KB, GL or WD values (Option to specify these and correct these in the Log Header)
Calculate geomechanical properties using 6 component stress tensor
Calculate Pore Pressure, Shmin, SHMax, Sv and UCS and more
Plot Stress Polygon, Wellbore Stability and more at drainhole analysis depth
Plot the data in user configurable intervals
Option to save Plots at custom DPI
Export the well data as .csv, so you can run your own plots and calculations in your software of choice
Output Las Files (with updated header and new data columns)
Parameters for adding mud data, loss/gain data and other data interpreted from drilling and testing history, these are plotted over the calculated data to help visually constrain the model
Option to include ascii file with observations from resistivity image logs (or others like ultrasonic calipers) to include tensile fractures and breakouts, which are then used internally to better constrain SHMax
Override nu, mu, and UCS and tensile strength from the lithology file
Installation
pip install stresslog
Consult the documentation at https://stresslog.readthedocs.io/ for more help.
Contributing
We welcome contributions—feel free to submit a pull request!
Guidelines for Contributions
- Pull Requests are Welcome: If you have an improvement, bug fix, or feature, send a PR.
- No Code-Style Requirements: We don’t enforce a specific coding style — if the tests pass, your code is valid.
- Before submitting a pull request, open an issue first: This is so that maintainer(s) can discuss the situation and perhaps guide the pull request in a way compatible with the overall structure and function of the codebase.
Contributors are required to accept the Contributor License Agreement before submitting a pull request.
Acknowledgements
Jon Jincai Zhang, for his awesome work on pore pressure prediction, and geomechanics at large. This software uses his algorithms wherever possible.
In more detail: The Stability Analysis Plots are after Peska and Zoback, 1995. The Stress Polygon Technique for constraining SHMax is after Zoback et al., 2003 The Pore Pressure equation is from Zhang, 2011 The shmin is calculated in accordance with Dianes, 1982, as well as Zoback and Healy,1992
This software is written in Python, using the python library Welly by Agile Scientific, Canada. Welly itself uses the Lasio library to handle the las files. Dlis files are handled using dlisio package by Equinor. Other libraries used include Pandas, Numpy, Matplotlib, Plotly and Scipy.
Disclaimer
IN MAKING INTERPRETATIONS OF LOGS THIS SOFTWARE AND ITS AUTHOR(S) WILL GIVE USERS THE BENEFIT OF THEIR BEST JUDGEMENT. BUT SINCE ALL INTERPRETATIONS ARE OPINIONS BASED ON INFERENCES FROM ELECTRICAL OR OTHER MEASUREMENTS, WE CANNOT, AND WE DO NOT GUARANTEE THE ACCURACY OR CORRECTNESS OF ANY INTERPRETATION. WE SHALL NOT BE LIABLE OR RESPONSIBLE FOR ANY LOSS, COST, DAMAGES, OR EXPENSES WHATSOEVER INCURRED OR SUSTAINED BY THE USER RESULTING FROM ANY INTERPRETATION MADE BY THE SOFTWARE OR ITS AUTHOR(S).
THERE IS NO WARRANTY FOR THE PROGRAM. THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
IN NO EVENT WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
THE STATEMENTS ABOVE ARE IN ADDITION TO THE CONCERNED SECTIONS OF THE AGPL3.0 LICENSE GOVERNING THE PROGRAM.
Owner
- Login: GeoArkadeep
- Kind: user
- Repositories: 1
- Profile: https://github.com/GeoArkadeep
JOSS Publication
Stresslog: A Python package for modeling wellbore stability in inclined stress states
Authors
ROCK LAB PRIVATE LIMITED, India
Editor
William Gearty
Tags
Drilling Geomechanics Pore-pressure Mud loss Wellbore stabilityGitHub Events
Total
- Create event: 31
- Issues event: 13
- Release event: 32
- Watch event: 7
- Delete event: 1
- Issue comment event: 42
- Push event: 258
- Pull request event: 5
- Fork event: 2
Last Year
- Create event: 31
- Issues event: 13
- Release event: 32
- Watch event: 7
- Delete event: 1
- Issue comment event: 42
- Push event: 258
- Pull request event: 5
- Fork event: 2
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Arkadeep Ghosh | a****h@r****n | 402 |
| Arkadeep Ghosh | 1****p@u****m | 51 |
| Arkadeep | a****h@g****m | 41 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 5 months ago
All Time
- Total issues: 9
- Total pull requests: 3
- Average time to close issues: 23 days
- Average time to close pull requests: 1 minute
- Total issue authors: 2
- Total pull request authors: 2
- Average comments per issue: 5.22
- Average comments per pull request: 0.33
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 9
- Pull requests: 3
- Average time to close issues: 23 days
- Average time to close pull requests: 1 minute
- Issue authors: 2
- Pull request authors: 2
- Average comments per issue: 5.22
- Average comments per pull request: 0.33
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- frank1010111 (6)
- wkearn (3)
Pull Request Authors
- GeoArkadeep (2)
- frank1010111 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 1,378 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 76
- Total maintainers: 1
proxy.golang.org: github.com/geoarkadeep/stresslog
- Documentation: https://pkg.go.dev/github.com/geoarkadeep/stresslog#section-documentation
- License: agpl-3.0
-
Latest release: v1.7.4
published 5 months ago
Rankings
pypi.org: stresslog
Library for stress calculations from well logs
- Homepage: https://www.rocklab.in/stresslog
- Documentation: https://stresslog.readthedocs.io/en/stable/
- License: AGPL-3.0
-
Latest release: 1.7.8
published 5 months ago
Rankings
Maintainers (1)
Dependencies
- pandas >=2.0