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

[WIP] GNKI doc source and edits #416

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[WIP] GNKI doc source and edits #416

wants to merge 3 commits into from

Conversation

rgjini
Copy link
Collaborator

@rgjini rgjini commented Oct 16, 2024

Purpose

Closes #415

To-do

  • Write GNKI user guide docs and algorithm theory
  • Set defaults
  • Edits the homepage to include as a potential algorithm

Content


  • I have read and checked the items on the review checklist.

Copy link
Collaborator

@odunbar odunbar left a comment

Choose a reason for hiding this comment

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

example text

Copy link
Collaborator

@odunbar odunbar left a comment

Choose a reason for hiding this comment

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

example comment

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"
Copy link
Collaborator

Choose a reason for hiding this comment

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

example review

@odunbar odunbar changed the title GNKI doc source and edits [WIP] GNKI doc source and edits Oct 16, 2024
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.

Add a docs page describing setup, and API. Add derivation as with other EKP tools
2 participants