delete plot_diagnostics option; rename amip_diagnostics to coupler_diagnostics

Author: juliasloan25

NEWS.md

@@ -6,6 +6,14 @@ ClimaCoupler.jl Release Notes
 
 ### ClimaCoupler features
 
+#### Postprocessing no longer uses `sim_mode` PR[#1153](https://github.com/CliMA/ClimaCoupler.jl/pull/1153)
+Postprocessing now consists of a single function that's used for all simulation
+modes. Note that now all available diagnostics will be plotted at the end of
+the simulation, where before we specified a subset to plot based on the
+simulation type.
+This PR also removes the `plot_diagnostics` config option. `use_coupler_diagnostics`
+should be used instead.
+
 #### PrescribedOceanSimulation added, includes SST update PR[#1144](https://github.com/CliMA/ClimaCoupler.jl/pull/1144)
 This PR is similar to #1141 below, but applies to SST rather than SIC.
 SST is now updated within `PrescribedOceanSimulation` methods, rather

config/ci_configs/slabplanet_atmos_diags.yml

@@ -1,5 +1,4 @@
 apply_limiter: false
-plot_diagnostics: true
 dt: "200secs"
 dt_cpl: "200secs"
 dt_save_to_sol: "9days"

docs/src/diagnostics.md

@@ -39,7 +39,7 @@ Once we have created a `ScheduledDiagnostic` for each variable we're interested
 we collect them in a vector and pass this to our `DiagnosticsHandler` object.
 
 An example of this process for the variable `F_turb_energy` can be found in
-`experiments/ClimaEarth/user_io/amip_diagnostics.jl`.
+`experiments/ClimaEarth/user_io/coupler_diagnostics.jl`.
 
 For more information about this process, please see the
 ClimaDiagnostics.jl [documentation](https://clima.github.io/ClimaDiagnostics.jl/dev/).

experiments/ClimaEarth/cli_options.jl

@@ -119,10 +119,6 @@ function argparse_settings()
         help = "Directory to save output files. Note that TempestRemap fails if interactive and paths are too long. [\"experiments/ClimaEarth/output\" (default)]"
         arg_type = String
         default = "experiments/ClimaEarth/output"
-        "--plot_diagnostics"
-        help = "Boolean flag indicating whether to make plot diagnostics [`false` (default), `true`]"
-        arg_type = Bool
-        default = false
         # ClimaAtmos specific
         "--surface_setup"
         help = "Triggers ClimaAtmos into the coupled mode [`PrescribedSurface` (default), `DefaultMoninObukhov`]" # retained here for standalone Atmos benchmarks

experiments/ClimaEarth/run_amip.jl

@@ -131,7 +131,6 @@ add_extra_diagnostics!(config_dict)
     energy_check,
     conservation_softfail,
     output_dir_root,
-    plot_diagnostics,
 ) = get_coupler_args(config_dict)
 
 #=
@@ -486,10 +485,10 @@ Use ClimaDiagnostics for default AMIP diagnostics, which currently include turbu
 =#
 if use_coupler_diagnostics
     @info "Using default coupler diagnostics"
-    include("user_io/amip_diagnostics.jl")
+    include("user_io/coupler_diagnostics.jl")
     coupler_diags_path = joinpath(dir_paths.output, "coupler")
     isdir(coupler_diags_path) || mkpath(coupler_diags_path)
-    diags_handler = amip_diagnostics_setup(coupler_fields, coupler_diags_path, dates.date0[1], tspan[1], calendar_dt)
+    diags_handler = coupler_diagnostics_setup(coupler_fields, coupler_diags_path, dates.date0[1], tspan[1], calendar_dt)
 else
     diags_handler = nothing
 end
@@ -732,7 +731,6 @@ The postprocessing includes:
 =#
 
 if ClimaComms.iamroot(comms_ctx)
-    postprocessing_vars =
-        (; plot_diagnostics, use_coupler_diagnostics, output_default_diagnostics, t_end, conservation_softfail)
+    postprocessing_vars = (; use_coupler_diagnostics, output_default_diagnostics, t_end, conservation_softfail)
     postprocess_sim(cs, postprocessing_vars)
 end

experiments/ClimaEarth/user_io/arg_parsing.jl

@@ -76,7 +76,7 @@ function get_coupler_args(config_dict::Dict)
     # Diagnostics information
     use_coupler_diagnostics = config_dict["use_coupler_diagnostics"]
     use_land_diagnostics = config_dict["use_land_diagnostics"]
-    calendar_dt = config_dict["calendar_dt"]
+    (_, calendar_dt) = get_diag_period(t_start, t_end)
 
     # Physical simulation information
     evolving_ocean = config_dict["evolving_ocean"]
@@ -89,7 +89,6 @@ function get_coupler_args(config_dict::Dict)
 
     # Output information
     output_dir_root = config_dict["coupler_output_dir"]
-    plot_diagnostics = config_dict["plot_diagnostics"]
 
     # ClimaLand-specific information
     land_domain_type = config_dict["land_domain_type"]
@@ -122,7 +121,6 @@ function get_coupler_args(config_dict::Dict)
         energy_check,
         conservation_softfail,
         output_dir_root,
-        plot_diagnostics,
         land_domain_type,
         land_albedo_type,
         land_initial_condition,

experiments/ClimaEarth/user_io/amip_diagnostics.jl renamed to experiments/ClimaEarth/user_io/coupler_diagnostics.jl

@@ -3,15 +3,15 @@ import ClimaCoupler: Interfacer
 import Dates
 
 """
-    amip_diagnostics_setup(fields, output_dir, start_date, t_start, calendar_dt)
+    coupler_diagnostics_setup(fields, output_dir, start_date, t_start, calendar_dt)
 
 Set up the default diagnostics for an AMIP simulation, using ClimaDiagnostics.
 The diagnostics are saved to NetCDF files. Currently, this just includes a
 diagnostic for turbulent energy fluxes.
 
 Return a DiagnosticsHandler object to coordinate the diagnostics.
 """
-function amip_diagnostics_setup(fields, output_dir, start_date, t_start, calendar_dt)
+function coupler_diagnostics_setup(fields, output_dir, start_date, t_start, calendar_dt)
     # Create schedules and writer
     schedule_everystep = CD.Schedules.EveryStepSchedule()
     schedule_calendar_dt = CD.Schedules.EveryCalendarDtSchedule(calendar_dt, start_date = start_date)

experiments/ClimaEarth/user_io/postprocessing.jl

@@ -20,7 +20,7 @@ function postprocess_sim(cs, postprocessing_vars)
     land_output_dir = joinpath(output_dir, "clima_land")
 
     # Plot generic diagnostics if requested
-    if use_coupler_diagnostics && plot_diagnostics
+    if use_coupler_diagnostics
         @info "Plotting diagnostics for coupler, atmos, and land"
         make_diagnostics_plots(coupler_output_dir, artifact_dir, output_prefix = "coupler_")
         make_diagnostics_plots(atmos_output_dir, artifact_dir, output_prefix = "atmos_")