Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename C_D to covariance in ESMDA API #157

Merged
merged 3 commits into from
Oct 18, 2023
Merged

Conversation

tommyod
Copy link
Collaborator

@tommyod tommyod commented Oct 6, 2023

  • Aligning the signatures of ESMDA and SIES. Both now take covariance as an argument.

This PR is just a search and replace.

@tommyod tommyod marked this pull request as ready for review October 6, 2023 07:28
@tommyod tommyod requested a review from dafeda October 6, 2023 10:19
@tommyod tommyod requested a review from Blunde1 October 16, 2023 08:16
Copy link
Contributor

@Blunde1 Blunde1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My default was to be against this because there are multiple covariances going around in Kalman-type updates. I therefore wanted to build association into the naming. However, the covariance of the measurement error is the only one that is passed as input, as pointed out, so it is perhaps okay. It makes perhaps also sense to step away from the notation in the 2019 paper of SIES, if other algorithms, like ES-MDA (that have different notation in their respective papers), are implemented. A descriptive naming like covariance over C_D then makes sense. My preference is perhaps still cov_d, but given a good docstring I will be okay.

src/iterative_ensemble_smoother/esmda.py Outdated Show resolved Hide resolved
@tommyod tommyod merged commit f616c88 into equinor:main Oct 18, 2023
9 checks passed
@tommyod tommyod deleted the api-naming branch October 18, 2023 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants