Tr/fix test warnings (#925)

* Fix warnings in tests Replace deprecated reference_date arg The ClimaUtilities DataHandler, TimeVaryingInput, and EveryCalendarDtSchedule function were called with reference_date as an argument, which is deprecated. This commit replaces them with start_date, and replaces other uses of reference_date as an arg to functions that pass the arg to EveryCalendarDtSchedule. Fix warning in test for unused type declaration Update common_diagnostics example in docs Annotate start date * Bump ClimaUtilities compat ClimaUtilities compat bumped from 0.1.16 to 0.1.17. This allows call to detect_restart_file to allways use the non-deprecated argument for style.
CliMA · Nov 20, 2024 · 8e915fc · 8e915fc
1 parent d3afe21
commit 8e915fc
Show file tree

Hide file tree

Showing 13 changed files with 135 additions and 153 deletions.
diff --git a/Project.toml b/Project.toml
@@ -43,7 +43,7 @@ ClimaComms = "0.6"
 ClimaCore = "0.14.19"
 ClimaDiagnostics = "0.2.10"
 ClimaParams = "0.10.2"
-ClimaUtilities = "0.1.16"
+ClimaUtilities = "0.1.17"
 DataFrames = "1.4"
 Dates = "1"
 DocStringExtensions = "0.9"

diff --git a/docs/src/diagnostics/developers_diagnostics.md b/docs/src/diagnostics/developers_diagnostics.md
@@ -107,6 +107,7 @@ hourly_averages(FT, short_names...; output_writer) = common_diagnostics(
     60 * 60 * one(FT),
     (+),
     output_writer,
+    nothing, # start_date
     short_names...;
     pre_output_hook! = average_pre_output_hook!,
 )

diff --git a/docs/src/diagnostics/users_diagnostics.md b/docs/src/diagnostics/users_diagnostics.md
@@ -122,6 +122,7 @@ seasonal_maxs(FT, short_names...; output_writer) = common_diagnostics(
     90 * 24 * 60 * 60 * one(FT),
     max,
     output_writer,
+    nothing, # start_date
     short_names...,
 )
 ```

diff --git a/experiments/benchmarks/richards.jl b/experiments/benchmarks/richards.jl
@@ -103,7 +103,7 @@ function setup_prob(t0, tf, Δt; nelements = (101, 15))
         joinpath(era5_artifact_path, "era5_2021_0.9x1.25.nc"),
         "tp",
         surface_space;
-        reference_date = start_date,
+        start_date,
         regridder_type,
         file_reader_kwargs = (; preprocess_func = (data) -> -data / 3600,),
     )

diff --git a/experiments/standalone/Soil/richards_runoff.jl b/experiments/standalone/Soil/richards_runoff.jl
@@ -78,7 +78,7 @@ precip = TimeVaryingInput(
     joinpath(era5_artifact_path, "era5_2021_0.9x1.25.nc"),
     "tp",
     surface_space;
-    reference_date = start_date,
+    start_date,
     regridder_type,
     file_reader_kwargs = (; preprocess_func = (data) -> -data / 3600,),
 )

diff --git a/src/diagnostics/default_diagnostics.jl b/src/diagnostics/default_diagnostics.jl
@@ -14,7 +14,7 @@ export default_diagnostics
                                 period,
                                 reduction,
                                 output_writer,
-                                reference_date,
+                                start_date,
                                 short_names...;
                                 pre_output_hook! = nothing,
                                )
@@ -25,15 +25,15 @@ function common_diagnostics(
     period,
     reduction,
     output_writer,
-    reference_date,
+    start_date,
     short_names...;
     pre_output_hook! = nothing,
 )
     return vcat(
         map(short_names) do short_name
             output_schedule_func =
                 period isa Period ?
-                EveryCalendarDtSchedule(period; reference_date) :
+                EveryCalendarDtSchedule(period; start_date) :
                 EveryDtSchedule(period)
             return ScheduledDiagnostic(
                 variable = get_diagnostic_variable(short_name),
@@ -52,7 +52,7 @@ include("standard_diagnostic_frequencies.jl")
 # Bucket
 function default_diagnostics(
     land_model::BucketModel{FT},
-    reference_date;
+    start_date;
     output_writer,
     average_period = :daily,
 ) where {FT}
@@ -80,21 +80,17 @@ function default_diagnostics(
             FT,
             bucket_diagnostics...;
             output_writer,
-            reference_date,
+            start_date,
         )
     elseif average_period == :daily
-        default_outputs = daily_averages(
-            FT,
-            bucket_diagnostics...;
-            output_writer,
-            reference_date,
-        )
+        default_outputs =
+            daily_averages(FT, bucket_diagnostics...; output_writer, start_date)
     elseif average_period == :monthly
         default_outputs = monthly_averages(
             FT,
             bucket_diagnostics...;
             output_writer,
-            reference_date,
+            start_date,
         )
     end
 
@@ -104,7 +100,7 @@ end
 # SoilCanopyModel
 function default_diagnostics(
     land_model::SoilCanopyModel{FT},
-    reference_date;
+    start_date;
     output_writer,
     output_vars = :long,
     average_period = :daily,
@@ -200,21 +196,21 @@ function default_diagnostics(
             FT,
             soilcanopy_diagnostics...;
             output_writer,
-            reference_date,
+            start_date,
         )
     elseif average_period == :daily
         default_outputs = daily_averages(
             FT,
             soilcanopy_diagnostics...;
             output_writer,
-            reference_date,
+            start_date,
         )
     elseif average_period == :monthly
         default_outputs = monthly_averages(
             FT,
             soilcanopy_diagnostics...;
             output_writer,
-            reference_date,
+            start_date,
         )
     end
 
@@ -225,7 +221,7 @@ end
 # SoilModel
 function default_diagnostics(
     land_model::EnergyHydrology{FT},
-    reference_date;
+    start_date;
     output_writer,
     average_period = :daily,
 ) where {FT}
@@ -235,26 +231,14 @@ function default_diagnostics(
     soil_diagnostics = ["swc", "si", "sie"]
 
     if average_period == :hourly
-        default_outputs = hourly_averages(
-            FT,
-            soil_diagnostics...;
-            output_writer,
-            reference_date,
-        )
+        default_outputs =
+            hourly_averages(FT, soil_diagnostics...; output_writer, start_date)
     elseif average_period == :daily
-        default_outputs = daily_averages(
-            FT,
-            soil_diagnostics...;
-            output_writer,
-            reference_date,
-        )
+        default_outputs =
+            daily_averages(FT, soil_diagnostics...; output_writer, start_date)
     elseif average_period == :monthly
-        default_outputs = monthly_averages(
-            FT,
-            soil_diagnostics...;
-            output_writer,
-            reference_date,
-        )
+        default_outputs =
+            monthly_averages(FT, soil_diagnostics...; output_writer, start_date)
     end
 
     return [default_outputs...]
@@ -263,7 +247,7 @@ end
 # Land Model
 function default_diagnostics(
     land_model::LandModel{FT},
-    reference_date;
+    start_date;
     output_writer,
     output_vars = :long,
     average_period = :daily,
@@ -360,21 +344,21 @@ function default_diagnostics(
             FT,
             snowyland_diagnostics...;
             output_writer,
-            reference_date,
+            start_date,
         )
     elseif average_period == :daily
         default_outputs = daily_averages(
             FT,
             snowyland_diagnostics...;
             output_writer,
-            reference_date,
+            start_date,
         )
     elseif average_period == :monthly
         default_outputs = monthly_averages(
             FT,
             snowyland_diagnostics...;
             output_writer,
-            reference_date,
+            start_date,
         )
     end
 end