API Reference¶
Purpose¶
pyesmda is an open-source, pure python, and object-oriented library that provides a user friendly implementation of one of the most popular ensemble based method for parameters estimation and data assimilation: the Ensemble Smoother with Multiple Data Assimilation (ES-MDA) algorithm, introduced by Emerick and Reynolds [1-2].
The following functionalities are directly provided on module-level.
Classes¶
|
Ensemble Smoother with Multiple Data Assimilation. |
|
Restricted Step Ensemble Smoother with Multiple Data Assimilation. |
Objective functions¶
Compute the ensemble average normalized objective function. |
|
|
Compute the normalized objective function for a given member \(j\). |
Covariance approximation¶
|
Get the given ensemble variance (diagonal terms of the covariance matrix). |
|
Approximate the parameters autocovariance matrix from the ensemble. |
Approximate the covariance matrix between two ensembles in the EnKF way. |
|
|
Inflate the given parameter ensemble around its mean. |
Correlation functions¶
|
Transform the distances into weights between 0 and 1 with a beta function. |
|
Transform the distances into weights between 0 and 1 with a fifth order function. |
Other functions¶
|
Check and raise an exception if there is any NaNs in the input predictions array. |