chandpes / pymarchenko

A bag of Marchenko algorithms implemented on top of PyLops

PyMarchenko

This Python library provides a bag of Marchenko algorithms implemented on top of PyLops.

Whilst a basic implementation of the Marchenko algorithm is available directly in PyLops, a number of variants have been developed over the years. This library aims at collecting all of them in the same place and give access to them with a unique consistent API to ease switching between them and prototyping new algorithms.

Objective

Currently we provide the following implementations:

• Marchenko redatuming via Neumann iterative substitution (Wapenaar et al., 2014)
• Marchenko redatuming via inversion (van der Neut et al., 2017)
• Rayleigh-Marchenko redatuming (Ravasi, 2017)
• Internal multiple elimination via Marchenko equations (Zhang et al., 2019)
• Marchenko redatuming with irregular sources (Haindl et al., 2021)

Alongside the core algorithms, these following auxiliary tools are also provided:

• Target-oriented receiver-side redatuming via MDD
• Marchenko imaging (combined source-side Marchenko redatuming and receiver-side MDD redatuming)
• Angle gather computation (de Bruin, Wapenaar, and Berkhout, 1990)

Getting started

You need Python 3.6 or greater.

From PyPi

pip install pymarchenko

From Github

You can also directly install from the main repository (although this is not reccomended)

pip install git+https://[email protected]/DIG-Kaust/pymarchenko.git@main

Documentation

The official documentation of PyMarchenko is available here.

Visit this page to get started learning about the different algorithms implemented in this library.

Moreover, if you have installed PyMarchenko using the developer environment you can also build the documentation locally by typing the following command:

make doc

Once the documentation is created, you can make any change to the source code and rebuild the documentation by simply typing

make docupdate

Since the tutorials are too heavy to be created by documentation web-services like Readthedocs, our documentation is hosted on Github-Pages and run locally on a separate branch. To get started create the following branch both locally and in your remote fork:

git checkout -b gh-pages
git push -u origin gh-pages

Every time you want to update and deploy the documentation run:

make docpush

This will automatically move to the gh-pages branch, build the documentation and push it in the equivalent remote branch. You can finally make a Pull Request for your local gh-pages branch to the gh-pages in the DIG-Kaust repository,