API Reference#

Purpose#

pypcga is an open-source, and object-oriented library that provides a user friendly implementation of the Principal Component Geostatistical Approach for large-scale inversion.

The original code has been written by Jonghyun Harry Lee.

See: https://github.com/jonghyunharrylee/pyPCGA

The following functionalities are directly provided on module-level.

Classes#

PCGA(*, s_init, ...], ...)

Solve inverse problem with PCGA (approx to quasi-linear method)

Utilitary functions#

`ensemble_dot`(X1, X2)	Return the dot products for multiple vectors.
`ghep`(A, B, Binv, r, d[, single_pass, ...])	Randomized Eigen Value Decomposition (EVD).
`mgs_stable`(A, Z[, verbose])	Returns QR decomposition of Z with Q*AQ = I.