rename date1 -> first_day_of_month

The previous name was unclear; now it's more apparent that this
variable represents the first day of the month, which gets updated
monthly as the simulation progresses.

Author: juliasloan25

experiments/ClimaEarth/run_amip.jl

@@ -453,7 +453,7 @@ Utilities.show_memory_usage(comms_ctx)
 model_sims = (atmos_sim = atmos_sim, ice_sim = ice_sim, land_sim = land_sim, ocean_sim = ocean_sim);
 
 ## dates
-dates = (; date = [date], date0 = [date0], date1 = [Dates.firstdayofmonth(date0)], new_month = [false])
+dates = (; date = [date], date0 = [date0], first_day_of_month = [Dates.firstdayofmonth(date0)], new_month = [false])
 
 #=
 ### Online Diagnostics
@@ -533,7 +533,7 @@ checkpoint_cb = CallbackManager.HourlyCallback(
 update_firstdayofmonth!_cb = CallbackManager.MonthlyCallback(
     dt = FT(1),
     func = CallbackManager.update_firstdayofmonth!,
-    ref_date = [dates.date1[1]],
+    ref_date = [dates.first_day_of_month[1]],
     active = true,
 )
 dt_water_albedo = parse(FT, filter(x -> !occursin(x, "hours"), dt_rad))
@@ -680,7 +680,7 @@ function solve_coupler!(cs)
         cs.dates.date[1] = Interfacer.current_date(cs, t)
 
         ## print date on the first of month
-        if cs.dates.date[1] >= cs.dates.date1[1]
+        if cs.dates.date[1] >= cs.dates.first_day_of_month[1]
             ClimaComms.iamroot(comms_ctx) && @show(cs.dates.date[1])
         end
 

experiments/ClimaEarth/run_cloudless_aquaplanet.jl

@@ -211,7 +211,7 @@ model_sims = (atmos_sim = atmos_sim, ocean_sim = ocean_sim);
 
 ## dates
 date0 = date = Dates.DateTime(start_date, Dates.dateformat"yyyymmdd")
-dates = (; date = [date], date0 = [date0], date1 = [Dates.firstdayofmonth(date0)], new_month = [false])
+dates = (; date = [date], date0 = [date0], first_day_of_month = [Dates.firstdayofmonth(date0)], new_month = [false])
 
 #=
 ## Initialize Callbacks
@@ -226,7 +226,7 @@ checkpoint_cb = CallbackManager.HourlyCallback(
 update_firstdayofmonth!_cb = CallbackManager.MonthlyCallback(
     dt = FT(1),
     func = CallbackManager.update_firstdayofmonth!,
-    ref_date = [dates.date1[1]],
+    ref_date = [dates.first_day_of_month[1]],
     active = true,
 )
 dt_water_albedo = parse(FT, filter(x -> !occursin(x, "hours"), dt_rad))
@@ -328,7 +328,7 @@ function solve_coupler!(cs)
         cs.dates.date[1] = Interfacer.current_date(cs, t)
 
         ## print date on the first of month
-        if cs.dates.date[1] >= cs.dates.date1[1]
+        if cs.dates.date[1] >= cs.dates.first_day_of_month[1]
             ClimaComms.iamroot(comms_ctx) && @show(cs.dates.date[1])
         end
 

experiments/ClimaEarth/run_cloudy_aquaplanet.jl

@@ -232,7 +232,7 @@ model_sims = (atmos_sim = atmos_sim, ocean_sim = ocean_sim);
 
 ## dates
 date0 = date = Dates.DateTime(start_date, Dates.dateformat"yyyymmdd")
-dates = (; date = [date], date0 = [date0], date1 = [Dates.firstdayofmonth(date0)], new_month = [false])
+dates = (; date = [date], date0 = [date0], first_day_of_month = [Dates.firstdayofmonth(date0)], new_month = [false])
 
 #=
 ## Initialize Callbacks
@@ -247,7 +247,7 @@ checkpoint_cb = CallbackManager.HourlyCallback(
 update_firstdayofmonth!_cb = CallbackManager.MonthlyCallback(
     dt = FT(1),
     func = CallbackManager.update_firstdayofmonth!,
-    ref_date = [dates.date1[1]],
+    ref_date = [dates.first_day_of_month[1]],
     active = true,
 )
 callbacks = (; checkpoint = checkpoint_cb, update_firstdayofmonth! = update_firstdayofmonth!_cb)
@@ -340,7 +340,7 @@ function solve_coupler!(cs)
         cs.dates.date[1] = Interfacer.current_date(cs, t)
 
         ## print date on the first of month
-        if cs.dates.date[1] >= cs.dates.date1[1]
+        if cs.dates.date[1] >= cs.dates.first_day_of_month[1]
             ClimaComms.iamroot(comms_ctx) && @show(cs.dates.date[1])
         end
 

experiments/ClimaEarth/run_cloudy_slabplanet.jl

@@ -175,7 +175,7 @@ land_mask_data = artifact_data(mask_dataset_path(), "seamask")
 
 ## dates
 date0 = date = Dates.DateTime(start_date, Dates.dateformat"yyyymmdd")
-dates = (; date = [date], date0 = [date0], date1 = [Dates.firstdayofmonth(date0)], new_month = [false])
+dates = (; date = [date], date0 = [date0], first_day_of_month = [Dates.firstdayofmonth(date0)], new_month = [false])
 
 
 #=
@@ -293,7 +293,7 @@ checkpoint_cb = CallbackManager.HourlyCallback(
 update_firstdayofmonth!_cb = CallbackManager.MonthlyCallback(
     dt = FT(1),
     func = CallbackManager.update_firstdayofmonth!,
-    ref_date = [dates.date1[1]],
+    ref_date = [dates.first_day_of_month[1]],
     active = true,
 )
 dt_water_albedo = parse(FT, filter(x -> !occursin(x, "hours"), dt_rad))
@@ -392,7 +392,7 @@ function solve_coupler!(cs)
         cs.dates.date[1] = Interfacer.current_date(cs, t)
 
         ## print date on the first of month
-        if cs.dates.date[1] >= cs.dates.date1[1]
+        if cs.dates.date[1] >= cs.dates.first_day_of_month[1]
             ClimaComms.iamroot(comms_ctx) && @show(cs.dates.date[1])
         end
 

experiments/ClimaEarth/run_dry_held_suarez.jl

@@ -174,7 +174,7 @@ model_sims = (atmos_sim = atmos_sim,);
 
 ## dates
 date0 = date = Dates.DateTime(start_date, Dates.dateformat"yyyymmdd")
-dates = (; date = [date], date0 = [date0], date1 = [Dates.firstdayofmonth(date0)], new_month = [false])
+dates = (; date = [date], date0 = [date0], first_day_of_month = [Dates.firstdayofmonth(date0)], new_month = [false])
 
 #=
 ## Initialize Callbacks
@@ -188,7 +188,7 @@ checkpoint_cb = CallbackManager.HourlyCallback(
 update_firstdayofmonth!_cb = CallbackManager.MonthlyCallback(
     dt = FT(1),
     func = CallbackManager.update_firstdayofmonth!,
-    ref_date = [dates.date1[1]],
+    ref_date = [dates.first_day_of_month[1]],
     active = true,
 )
 callbacks = (; checkpoint = checkpoint_cb, update_firstdayofmonth! = update_firstdayofmonth!_cb)
@@ -240,7 +240,7 @@ function solve_coupler!(cs)
         cs.dates.date[1] = Interfacer.current_date(cs, t)
 
         ## print date on the first of month
-        if cs.dates.date[1] >= cs.dates.date1[1]
+        if cs.dates.date[1] >= cs.dates.first_day_of_month[1]
             ClimaComms.iamroot(comms_ctx) ? @show(cs.dates.date[1]) : nothing
         end
 

experiments/ClimaEarth/run_moist_held_suarez.jl

@@ -218,7 +218,7 @@ model_sims = (atmos_sim = atmos_sim, ocean_sim = ocean_sim);
 
 ## dates
 date0 = date = Dates.DateTime(start_date, Dates.dateformat"yyyymmdd")
-dates = (; date = [date], date0 = [date0], date1 = [Dates.firstdayofmonth(date0)], new_month = [false])
+dates = (; date = [date], date0 = [date0], first_day_of_month = [Dates.firstdayofmonth(date0)], new_month = [false])
 
 #=
 ## Initialize Callbacks
@@ -233,7 +233,7 @@ checkpoint_cb = CallbackManager.HourlyCallback(
 update_firstdayofmonth!_cb = CallbackManager.MonthlyCallback(
     dt = FT(1),
     func = CallbackManager.update_firstdayofmonth!,
-    ref_date = [dates.date1[1]],
+    ref_date = [dates.first_day_of_month[1]],
     active = true,
 )
 callbacks = (; checkpoint = checkpoint_cb, update_firstdayofmonth! = update_firstdayofmonth!_cb)
@@ -324,7 +324,7 @@ function solve_coupler!(cs)
         cs.dates.date[1] = Interfacer.current_date(cs, t)
 
         ## print date on the first of month
-        if cs.dates.date[1] >= cs.dates.date1[1]
+        if cs.dates.date[1] >= cs.dates.first_day_of_month[1]
             ClimaComms.iamroot(comms_ctx) && @show(cs.dates.date[1])
         end
         ClimaComms.barrier(comms_ctx)

src/Diagnostics.jl

@@ -165,8 +165,8 @@ Saves all entries in `dg` in separate HDF5 files per variable in `output_dir`.
 function save_diagnostics(cs::Interfacer.CoupledSimulation)
     for dg in cs.diagnostics
 
-        # Check if the date is greater than the next date to save
-        if cs.dates.date[1] >= cs.dates.date1[1]
+        # Check if the date has crossed to the next month
+        if cs.dates.date[1] >= cs.dates.first_day_of_month[1]
             pre_save(dg.operations.accumulate, cs, dg)
             save_diagnostics(cs, dg)
             post_save(dg.operations.accumulate, cs, dg)

test/diagnostics_tests.jl

@@ -77,7 +77,7 @@ for FT in (Float32, Float64)
             ) # or use accumulate = nothing for snapshop save
             cs = Interfacer.CoupledSimulation{FT}(
                 ClimaComms.SingletonCommsContext(), # comms_ctx
-                (date = [Dates.DateTime(0, 2)], date1 = [Dates.DateTime(0, 1)]), # dates
+                (date = [Dates.DateTime(0, 2)], first_day_of_month = [Dates.DateTime(0, 1)]), # dates
                 nothing, # boundary_space
                 nothing, # fields
                 nothing, # parsed_args

test/regridder_tests.jl

@@ -289,8 +289,8 @@ for FT in (Float32, Float64)
             )
 
             # read in data on CGLL grid from the last saved date
-            date1 = CallbackManager.strdate_to_datetime.(string(Int(time[end])))
-            cgll_path = joinpath(REGRID_DIR, "$(hd_outfile_root)_$date1.hdf5")
+            date_end = CallbackManager.strdate_to_datetime.(string(Int(time[end])))
+            cgll_path = joinpath(REGRID_DIR, "$(hd_outfile_root)_$date_end.hdf5")
             hdfreader = CC.InputOutput.HDF5Reader(cgll_path, comms_ctx)
             T_cgll = CC.InputOutput.read_field(hdfreader, varname)
             Base.close(hdfreader)