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

Clean up notation in the documentation #190

Closed
ilopezgp opened this issue Aug 23, 2022 · 3 comments · Fixed by #207
Closed

Clean up notation in the documentation #190

ilopezgp opened this issue Aug 23, 2022 · 3 comments · Fixed by #207
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ilopezgp
Copy link
Contributor

Since the documentation of different parts of the package has been written by different people, different notation has been used to refer to the same terms/concepts in several entries of the docs (e.g., UKI and EKI pages).

To provide a cleaner and more consistent documentation, we should unify notation across the docs.

@ilopezgp ilopezgp added the documentation Improvements or additions to documentation label Aug 23, 2022
@odunbar odunbar self-assigned this Sep 13, 2022
@odunbar
Copy link
Collaborator

odunbar commented Sep 13, 2022

@Zhengyu-Huang https://clima.github.io/EnsembleKalmanProcesses.jl/dev/unscented_kalman_inversion/
what is kappa=0 supposed to mean on this page, it doesn't really make sense to me the way it is currently described.

@ilopezgp
Copy link
Contributor Author

I think it was a free parameter in an earlier version of the paper, which was later removed from the published version; see eq. (18) and below in https://doi.org/10.1016/j.jcp.2022.111262. I would say let's delete kappa altogether, to have the docs resemble the paper.

@ilopezgp
Copy link
Contributor Author

We also don't have kappa in src/, btw.

@bors bors bot closed this as completed in 77593c8 Sep 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants