Merge pull request #1463 from CliMA/js/detect-restart

add option detect_restart_files

Author: juliasloan25

NEWS.md

@@ -6,6 +6,12 @@ ClimaCoupler.jl Release Notes
 
 ### ClimaCoupler features
 
+#### Add option `detect_restart_files` PR[#1463](https://github.com/CliMA/ClimaCoupler.jl/pull/1463)
+Add a CLI option to signal whether restart files should be automatically used
+to restart a simulation. This is true by default, but can be set to false if a
+user wishes to run a simulation from the beginning, ignoring present restart files.
+
+
 #### Remove ED/EDMF aquaplanet longruns PR[#1461](https://github.com/CliMA/ClimaCoupler.jl/pull/1461)
 Removes the ED-only and diag. EDMF aquaplanet longruns.
 These can be run manually as needed for debugging, rather than running every week.

config/ci_configs/amip_coarse_ft64_hourly_checkpoints_restart.yml

@@ -1,6 +1,7 @@
 apply_limiter: false
 checkpoint_dt: "400secs"
 co2_model: "maunaloa"
+detect_restart_files: true
 energy_check: false
 h_elem: 6
 mode_name: "amip"

experiments/ClimaEarth/cli_options.jl

@@ -88,6 +88,10 @@ function argparse_settings()
         arg_type = Bool
         default = true
         # Restart information
+        "--detect_restart_files"
+        help = "Boolean flag indicating whether to automatically use restart files if available [`false` (default), `true`]"
+        arg_type = Bool
+        default = false
         "--restart_dir"
         help = "Directory containing restart files"
         arg_type = String

experiments/ClimaEarth/setup_run.jl

@@ -115,6 +115,7 @@ function CoupledSimulation(config_dict::AbstractDict)
         share_surface_space,
         saveat,
         checkpoint_dt,
+        detect_restart_files,
         restart_dir,
         restart_t,
         use_land_diagnostics,
@@ -164,7 +165,7 @@ function CoupledSimulation(config_dict::AbstractDict)
 
     isnothing(restart_t) && (restart_t = Checkpointer.t_start_from_checkpoint(dir_paths.checkpoints))
     isnothing(restart_dir) && (restart_dir = dir_paths.checkpoints)
-    should_restart = !isnothing(restart_t) && !isnothing(restart_dir)
+    should_restart = detect_restart_files && !isnothing(restart_t) && !isnothing(restart_dir)
     if should_restart
         if t_start isa ITime
             t_start, _ = promote(ITime(restart_t), t_start)

experiments/ClimaEarth/test/restart.jl

@@ -58,6 +58,7 @@ println("Simulating four steps, options from command line")
 four_steps_reading = deepcopy(four_steps)
 
 four_steps_reading["t_end"] = "900secs"
+four_steps_reading["detect_restart_files"] = true
 four_steps_reading["restart_dir"] = cs_four_steps.dirs.checkpoints
 four_steps_reading["restart_t"] = 720
 four_steps_reading["job_id"] = "four_steps_reading"
@@ -85,6 +86,7 @@ cs_two_steps1 = setup_and_run(two_steps)
 println("Reading and simulating last two steps")
 # Two additional steps
 two_steps["t_end"] = "720secs"
+two_steps["detect_restart_files"] = true
 cs_two_steps2 = setup_and_run(two_steps)
 
 @testset "Restarts" begin

experiments/ClimaEarth/user_io/arg_parsing.jl

@@ -98,6 +98,7 @@ function get_coupler_args(config_dict::Dict)
     checkpoint_dt = config_dict["checkpoint_dt"]
 
     # Restart information
+    detect_restart_files = config_dict["detect_restart_files"]
     restart_dir = config_dict["restart_dir"]
     restart_t = config_dict["restart_t"]
 
@@ -138,6 +139,7 @@ function get_coupler_args(config_dict::Dict)
         share_surface_space,
         saveat,
         checkpoint_dt,
+        detect_restart_files,
         restart_dir,
         restart_t,
         use_coupler_diagnostics,