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:

@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:

pip install pide

or alternatively, they can clone the repository, then go to the directory of the source with cd and perform:

pip install .

If you want to help develop and change code as it is being used:

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:

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:

pip install numpy matplotlib scipy h5py harmonica pyproj netCDF4 psutil
pip install --no-deps santex

then:

pip install --no-deps pide

or alternatively, they can clone the repository, then go to the directory of the source with cd and perform:

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()

pide_object.list_methods()
pide_object.get_method_manual(method_name)

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:

python3 test_electrical_cond.py

Contacts

| Sinan Özaydın | sinan.ozaydin@protonmail.com | sinan.ozaydin@sydney.edu.au