erlendviggen/pyintegrity

An open-source toolbox for processing ultrasonic pulse-echo well integrity log data

Pyintegrity

Pyintegrity is an open-source Python library for processing acoustic well integrity log data, in particular ultrasonic pulse-echo data. With Pyintegrity, you can load well logs that contain the original recorded waveforms and process them using any of the implemented processing algorithms. You can also experiment with these algorithms on real or simulated data, or use Pyintegrity as a framework for developing and testing new algorithms.

You can find a more detailed introduction to Pyintegrity in our article Pyintegrity: An Open-Source Toolbox for Processing Ultrasonic Pulse-Echo Well Integrity Log Data, presented at the SPE Norway Subsurface Conference 2024. If you find Pyintegrity useful in your research, we would appreciate it if you could cite this article in your own publications.

Pyintegrity was originally developed by NTNU Researcher Erlend Magnus Viggen (most of the framework, W2/W1 algorithm) and SINTEF Research Scientist Anja Diez (simulation framework, all other algorithms) in a project funded by The Research Council of Norway through the Centre for Innovative Ultrasound Solutions (grant no. 237887).

Pyintegrity is made available under an Apache 2.0 license.

Getting started

To download and install Pyintegrity in a conda environment named pyintegrity, do the following:

git clone https://github.com/erlendviggen/pyintegrity.git
cd pyintegrity
conda env create -f environment.yml
conda activate pyintegrity
pip install -e .

The included Jupyter Notebook Pyintegrity demo.ipynb provides a demonstration of Pyintegrity by reproducing the results of the article.

Documentation

Pyintegrity's documentation can be found at https://erlendviggen.github.io/pyintegrity/.