pide
pide: Petrophysical Interpretation tools for geoDynamic Exploration. - Published in JOSS (2025)
Science Score: 95.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 6 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
2 of 4 committers (50.0%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
A python library for petrophysical calculations of lithosphere-scale problems.
Basic Info
- Host: GitHub
- Owner: sinanozaydin
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Homepage: https://pide.readthedocs.io/
- Size: 85.7 MB
Statistics
- Stars: 16
- Watchers: 4
- Forks: 5
- Open Issues: 2
- Releases: 11
Metadata Files
README.md
About
pide is a Python3 library for calculating geophysical parameters (e.g., electrical conductivity, seismic velocity), employing the results from experimental petrology, mineral/rock physics, and thermomechanical modelling studies. pide can calculate the theoretical electrical conductivity of any earth material that exists in the literature. pide can also calculate seismic velocity utilising the external 'sister' library santex. Using these theoretical calculations, users can utilise inversion modules to decode geophysical anomalies compositionally or convert thermomechanical models into geophysical observables. With a given spatial mapping of earth materials, which can preferentially be loaded from a thermomechanical model, pide can be used to build synthetic electrical conductivity and seismic velocity models and generate gravity and magnetic anomalies. Moreover, it is built as a modular tool, so users can easily build their functions.
How to Cite
If you are using this library in a scientific publication, please consider citing the following paper:
- Özaydın, S., Li, L., Singh, U., Rey, P.F, Manassero, M.C., 2025. pide: Petrophysical Interpretation tools for geoDynamic Exploration. Journal of Open Source Software, 10(105), 7021. https://doi.org/10.21105/joss.07021
Bibtex:
```bibtex @article{Ozaydin2025, title={pide: Petrophysical Interpretation tools for geoDynamic Exploration.}, author={Ozaydin, Sinan and Li, Lu and Singh, Utpal and Rey, Patrice F and Manassero, Maria Constanza}, journal={Journal of Open Source Software}, volume={10}, number={105}, pages={7021}, year={2025} }
```
Installation
Linux and MacOS
To install pide, the user can simply go their terminal and type the following command:
bash
pip install pide
or alternatively, they can clone the repository, then go to the directory of the source with cd and perform:
bash
pip install .
If you want to help develop and change code as it is being used:
bash
pip install -e .
Building from the source is encouraged at this point, since pide will be in development stage in the following years (2024).
Windows
On Windows computers, installation of pide may require a few more steps. If the user fails to install with pip install pide command, it will likely be caused by the pycifrw library, which is required by the dependency santex through orix. Then, we encourage the users to install the pycifrw first if pip install pide fails. This, for instance, can be achieved through utilising conda package manager with:
bash
conda install pycifrw -c conda-forge
Alternatively, the user can install pide by manually installing the dependencies. This will involve the execution of the following commands:
bash
pip install numpy matplotlib scipy h5py harmonica pyproj netCDF4 psutil
pip install --no-deps santex
then:
bash
pip install --no-deps pide
or alternatively, they can clone the repository, then go to the directory of the source with cd and perform:
bash
pip install --no-deps .
Workflow and how to use
How to use pide can be learned through Jupyter notebooks provided in examples/notebooks directory. The general workflow can be tracked through the chart below:
Information on all methods (input/output, examples) can be accesed through the pide object method as follows:
pide_object = pide.pide()
pideobject.listmethods() pideobject.getmethodmanual(methodname)
Getting Involved
Since pide is an open-source library, users are encouraged to be contribute and become developers of the project. For further information about how to contribute, please refer to the Contributing Guide.
Running Tests
To run the tests for the package, simply go to the test files and run them with python command:
bash
python3 test_electrical_cond.py
Contacts
| Sinan Özaydın | sinan.ozaydin@protonmail.com | sinan.ozaydin@sydney.edu.au
Owner
- Name: Sinan Özaydın
- Login: sinanozaydin
- Kind: user
- Location: Sydney, Australia
- Company: University of Sydney
- Website: https://sinanozaydin.github.io
- Repositories: 4
- Profile: https://github.com/sinanozaydin
Earth scientist interested in magnetotelluric modeling and their detailed interpretations. emails: sinan.ozaydin@sydney.edu.au sinan.ozaydin@protonmail.com
JOSS Publication
pide: Petrophysical Interpretation tools for geoDynamic Exploration.
Authors
School of Geosciences, University of Sydney, Sydney, Australia.
School of Earth Sciences, University of Western Australia, Perth, Australia.
School of Geosciences, University of Sydney, Sydney, Australia.
School of Geosciences, University of Sydney, Sydney, Australia.
School of Natural Sciences (Physics), University of Tasmania, Hobart, Australia.
Editor
Kristen Thyng
Tags
Python3 magnetotellurics petrophysics electrical conductivity seismic velocity experimental petrology geodynamics geophysics synthetic modellingGitHub Events
Total
- Create event: 5
- Release event: 4
- Issues event: 15
- Watch event: 6
- Delete event: 2
- Issue comment event: 23
- Push event: 95
- Pull request event: 10
- Fork event: 4
Last Year
- Create event: 5
- Release event: 4
- Issues event: 15
- Watch event: 6
- Delete event: 2
- Issue comment event: 23
- Push event: 95
- Pull request event: 10
- Fork event: 4
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Sinan Özaydın | 6****n | 398 |
| Santiago Soler | s****r@f****m | 4 |
| Lu Li | l****i@r****u | 3 |
| Patrice Rey | p****y@s****u | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 16
- Total pull requests: 6
- Average time to close issues: 4 months
- Average time to close pull requests: 14 days
- Total issue authors: 2
- Total pull request authors: 1
- Average comments per issue: 2.44
- Average comments per pull request: 0.5
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 16
- Pull requests: 6
- Average time to close issues: 4 months
- Average time to close pull requests: 14 days
- Issue authors: 2
- Pull request authors: 1
- Average comments per issue: 2.44
- Average comments per pull request: 0.5
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- santisoler (9)
- kujaku11 (7)
Pull Request Authors
- santisoler (12)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 37 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 11
- Total maintainers: 1
pypi.org: pide
A library for petrophysical interpretations of geophysical models.
- Homepage: https://github.com/sinanozaydin/pide
- Documentation: https://pide.readthedocs.io/
- License: GNU Lesser General Public License v3 (LGPLv3)
-
Latest release: 1.1.0
published 8 months ago
Rankings
Maintainers (1)
Dependencies
- jupyter *
- linkify-it-py *
- myst-parser *
- nbsphinx *
- sphinx >=4.0
- sphinx-rtd-theme *
- h5py *
- harmonica *
- matplotlib *
- netCDF4 *
- numpy *
- psutil *
- pyproj *
- santex >=1.2.2
- scipy *