Merge pull request #1217 from CliMA/ne/bucket_parameters

Add optional `toml_files` kwarg to the `BucketSimulation` func

Author: nefrathenrici

NEWS.md

@@ -6,6 +6,10 @@ ClimaCoupler.jl Release Notes
 
 ### ClimaCoupler features
 
+#### Add support for parameter files in `BucketSimulation` PR[#1217](https://github.com/CliMA/ClimaCoupler.jl/pull/1217)
+Add a keyword argument `parameter_files` to `BucketSimulation` to enable
+calibration in a coupled simulation, passed via the `"coupler_toml"` argument.
+
 #### Add `ClimaLandSimulation` object PR[#1199](https://github.com/CliMA/ClimaCoupler.jl/pull/1199)
 Add methods to support running `ClimaLand.LandModel` in a coupled simulation.
 Also add tests to verify the constructor setup and taking a step.

experiments/ClimaEarth/components/atmosphere/climaatmos.jl

@@ -427,12 +427,9 @@ function get_atmos_config_dict(coupler_dict::Dict, job_id::String, atmos_output_
     atmos_toml = joinpath.(pkgdir(CA), atmos_config["toml"])
     coupler_toml = joinpath.(pkgdir(ClimaCoupler), coupler_dict["coupler_toml"])
     toml = isempty(coupler_toml) ? atmos_toml : coupler_toml
-    if haskey(atmos_config, "calibration_toml")
-        push!(toml, atmos_config["calibration_toml"])
-    end
     if !isempty(toml)
         @info "Overwriting Atmos parameters from input TOML file(s): $toml"
-        atmos_config = merge(atmos_config, Dict("toml" => toml))
+        atmos_config["toml"] = toml
     end
 
     # Specify atmos output directory to be inside the coupler output directory

experiments/ClimaEarth/components/land/climaland_bucket.jl

@@ -7,6 +7,7 @@ import ClimaTimeSteppers as CTS
 import Thermodynamics as TD
 import ClimaLand as CL
 import ClimaLand.Parameters as LP
+import ClimaParams as CP
 import ClimaDiagnostics as CD
 import ClimaCoupler: Checkpointer, FluxCalculator, Interfacer
 using NCDatasets
@@ -77,6 +78,7 @@ function BucketSimulation(
     albedo_type::String = "map_static",
     land_initial_condition::String = "",
     energy_check::Bool = false,
+    parameter_files = [],
 ) where {FT, TT <: Union{Float64, ITime}}
     @assert domain_type == "sphere" "Currently only spherical shell domains are supported; single column may be supported in the future."
 
@@ -117,7 +119,13 @@ function BucketSimulation(
     κ_soil = FT(1.5) # soil conductivity
     ρc_soil = FT(2e6) # soil volumetric heat capacity
 
-    params = CL.Bucket.BucketModelParameters(FT; albedo, z_0m, z_0b, τc, σS_c, W_f, κ_soil, ρc_soil)
+    params = if isempty(parameter_files)
+        CL.Bucket.BucketModelParameters(FT; albedo, z_0m, z_0b, τc, σS_c, W_f, κ_soil, ρc_soil)
+    else
+        toml_dict = CP.create_toml_dict(FT; override_file = CP.merge_toml_files(parameter_files; override = true))
+        # τc should be the only exception, it depends on `dt`
+        CL.Bucket.BucketModelParameters(toml_dict; z_0m, z_0b, albedo, τc)
+    end
 
     n_vertical_elements = 7
     # Note that this does not take into account topography of the surface, which is OK for this land model.

experiments/ClimaEarth/setup_run.jl

@@ -200,6 +200,7 @@ function setup_and_run(config_dict::AbstractDict)
         energy_check,
         conservation_softfail,
         output_dir_root,
+        parameter_files,
     ) = get_coupler_args(config_dict)
 
     #=
@@ -341,6 +342,7 @@ function setup_and_run(config_dict::AbstractDict)
             albedo_type = land_albedo_type,
             land_initial_condition,
             energy_check,
+            parameter_files,
         )
 
         ## sea ice model
@@ -387,6 +389,7 @@ function setup_and_run(config_dict::AbstractDict)
             albedo_type = land_albedo_type,
             land_initial_condition,
             energy_check,
+            parameter_files,
         )
 
         ## ocean model
@@ -435,6 +438,7 @@ function setup_and_run(config_dict::AbstractDict)
             albedo_type = land_albedo_type,
             land_initial_condition,
             energy_check,
+            parameter_files,
         )
 
         ## ocean stub (here set to zero area coverage)

experiments/ClimaEarth/user_io/arg_parsing.jl

@@ -58,6 +58,9 @@ function get_coupler_args(config_dict::Dict)
     random_seed = config_dict["unique_seed"] ? time_ns() : 1234
     FT = config_dict["FLOAT_TYPE"] == "Float64" ? Float64 : Float32
 
+    # Vector of TOML files containing model parameters
+    parameter_files = config_dict["coupler_toml"]
+
     # Time information
     t_end = Float64(Utilities.time_to_seconds(config_dict["t_end"]))
     t_start = Float64(Utilities.time_to_seconds(config_dict["t_start"]))
@@ -140,6 +143,7 @@ function get_coupler_args(config_dict::Dict)
         land_initial_condition,
         land_temperature_anomaly,
         use_land_diagnostics,
+        parameter_files,
     )
 end
 
@@ -157,7 +161,6 @@ Extract the necessary arguments from the atmosphere configuration dictionary.
 function get_atmos_args(atmos_config_dict)
     dt_rad = atmos_config_dict["dt_rad"]
     output_default_diagnostics = atmos_config_dict["output_default_diagnostics"]
-
     return (; dt_rad, output_default_diagnostics)
 end