GNKI doc source and edits #416
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
odunbar
reviewed
Oct 16, 2024
docs/make.jl
Outdated
| @@ -77,6 +77,7 @@ pages = [ | |||
| "Examples" => examples, | |||
| "List of default configurations" => "defaults.md", | |||
| "Ensemble Kalman Inversion" => "ensemble_kalman_inversion.md", | |||
| "Gauss Newton Kalman Inversion" => "gauss_newton_kalman_inversion.md" | |||
odunbar
force-pushed
the
rg/GNKI-docs
branch
from
63f7f53 to
f04e8f4
Compare
odunbar
force-pushed
the
rg/GNKI-docs
branch
from
f04e8f4 to
af546b6
Compare
…es.jl into rg/GNKI-docs
odunbar
approved these changes
Dec 19, 2024
| ## Creating the EKI Object | ||
|
|
||
| We first build a prior distribution (for details of the construction see [here](@ref constrained-gaussian)). | ||
| Then we build our EKP object with `EnsembleKalmanProcess(args..., GaussNewtonInversion(prior); kwargs...)`. For general EKP object creation requirements see [Creating the EKI object](@ref eki). To make updates using the inversion algorithm see [Updating the Ensemble](@ref eki). |
There was a problem hiding this comment.
Could you use triple quotes (without spaces) to get this to be a code block
There was a problem hiding this comment.
Formatting is all set! I also included a couple minor changes that Matti suggested, so everything should be ready to merge! Maybe you could review it one last time before I merge?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Closes #415
To-do
Content