`analyze_iteration` is run after `update_ensemble!`, but its docstring says otherwise

[xkykai]

See this line:

ClimaCalibrate.jl/src/model_interface.jl

Line 31 in dc3845f

After each evaluation of the observation map and before updating the ensemble,

which states that analyze_iteration is run before update_ensemble!. However here:

ClimaCalibrate.jl/src/ekp_interface.jl

Lines 346 to 352 in dc3845f

	terminate = update_ensemble!(ekp, g_ensemble, output_dir, iteration, prior)
	try
	analyze_iteration(ekp, g_ensemble, prior, output_dir, iteration)
	catch ret_code
	@error "`analyze_iteration` crashed. See stacktrace" exception =
	(ret_code, catch_backtrace())
	end

However in the source code analyze_iteration is run after update_ensemble!.

So either the source code or the docstring should be changed, but I think analyze_iteration should be run before update_ensemble!? This is so that diagnostics about the calibration can be made on the forward runs and the EKP object before it is updated.

Or perhaps we need another helper that enables the user to also analyze the iteration after update_ensemble! to look at the updated EKP.

[ph-kev]

The docstring should be updated. I am confused about your comment for reordering analyze_iteration and update_ensemble!. For the forward run output, you should be access it from the EKP object regardless if update_ensemble! was called or not.

[xkykai]

I see, in that case only a change in the docstring suffices then!

[ph-kev]

closed by #247