Skip to content

Fix typos in docs #247

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.

Sign up for GitHub

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

Merged
ph-kev merged 1 commit into from
Oct 23, 2025
Merged

Fix typos in docs #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/observation_recipe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ All functions assume that any data preprocessing is done with `ClimaAnalysis`.

### Covariance Estimators

There are currently two covariance estimators, `ScalarCovariance`,
There are currently three covariance estimators, `ScalarCovariance`,
`SeasonalDiagonalCovariance`, and `SVDplusDCovariance`, which are subtypes of
`AbstractCovarianceEstimator`. `ScalarCovariance` approximates the observation
noise covariance as a scalar diagonal matrix. `SeasonalDiagonalCovariance`
Expand Down
8 changes: 2 additions & 6 deletions ext/observation_recipe.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ function ObservationRecipe.get_metadata_for_nth_iteration(obs_series, N)
end

"""
ObservationRecipe.get_observations_for_nth_iteration(obs_series, N)
get_observations_for_nth_iteration(obs_series, N)

For the `N`th iteration, get the observation(s) being processed.
"""
Expand All @@ -579,14 +579,10 @@ function ObservationRecipe.get_observations_for_nth_iteration(obs_series, N)
end

"""
reconstruct_g_mean_final(ekp::EKP.EnsembleKalmanProcess,
observation::EKP.Observation)
reconstruct_g_mean_final(ekp::EKP.EnsembleKalmanProcess)

Reconstruct the mean forward model evaluation at the last iteration as a
vector of `OutputVar`s.

This function assumes `observation` contains the necessary metadata to reconstruct
the `OutputVar`s. Note that the metadata comes from the observations.
"""
function ObservationRecipe.reconstruct_g_mean_final(
ekp::EKP.EnsembleKalmanProcess,
Expand Down
2 changes: 1 addition & 1 deletion src/model_interface.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ end
"""
analyze_iteration(ekp, g_ensemble, prior, output_dir, iteration)

After each evaluation of the observation map and before updating the ensemble,
After updating the ensemble and before starting the next iteration,
`analyze_iteration` is evaluated.

This function is optional to implement.
Expand Down
Loading