Merge pull request #156 from CliMA/ne/simplify_update

Simplify ensemble update with helper function

Author: nefrathenrici

docs/src/api.md

@@ -52,6 +52,8 @@ ClimaCalibrate.submit_pbs_job
 ClimaCalibrate.initialize
 ClimaCalibrate.save_G_ensemble
 ClimaCalibrate.update_ensemble
+ClimaCalibrate.update_ensemble!
+ClimaCalibrate.observation_map_and_update!
 ClimaCalibrate.ExperimentConfig
 ClimaCalibrate.get_prior
 ClimaCalibrate.get_param_dict

src/backends.jl

@@ -220,10 +220,8 @@ function calibrate(
         if errors == ensemble_size
             error("Full ensemble has failed, aborting calibration.")
         end
-        G_ensemble = observation_map(iter)
-        save_G_ensemble(output_dir, iter, G_ensemble)
         ekp = load_ekp_struct(output_dir, iter)
-        terminate = update_ensemble!(ekp, G_ensemble, output_dir, iter, prior)
+        terminate = observation_map_and_update!(ekp, output_dir, iter, prior)
         !isnothing(terminate) && break
     end
     return ekp
@@ -321,11 +319,8 @@ function calibrate(
             failure_rate,
         )
         @info "Iteration $iter time: $time"
-        # Process results
-        G_ensemble = observation_map(iter)
-        save_G_ensemble(output_dir, iter, G_ensemble)
         ekp = load_ekp_struct(output_dir, iter)
-        terminate = update_ensemble!(ekp, G_ensemble, output_dir, iter, prior)
+        terminate = observation_map_and_update!(ekp, output_dir, iter, prior)
         !isnothing(terminate) && break
     end
     return ekp
@@ -444,10 +439,8 @@ function calibrate(
             reruns = 0,
         )
         @info "Completed iteration $iter, updating ensemble"
-        G_ensemble = observation_map(iter)
-        save_G_ensemble(output_dir, iter, G_ensemble)
         ekp = load_ekp_struct(output_dir, iter)
-        terminate = update_ensemble!(ekp, G_ensemble, output_dir, iter, prior)
+        terminate = observation_map_and_update!(ekp, output_dir, iter, prior)
         !isnothing(terminate) && break
     end
     return ekp

src/ekp_interface.jl

@@ -370,6 +370,18 @@ function update_ensemble!(ekp, G_ens, output_dir, iteration, prior)
     return terminate
 end
 
+"""
+    observation_map_and_update!(ekp, output_dir, iteration, prior)
+
+Compute the observation map and update the given EKP object.
+"""
+function observation_map_and_update!(ekp, output_dir, iteration, prior)
+    g_ensemble = observation_map(iteration)
+    save_G_ensemble(output_dir, iteration, g_ensemble)
+    terminate = update_ensemble!(ekp, g_ensemble, output_dir, iteration, prior)
+    return terminate
+end
+
 """
     last_completed_iteration(output_dir)