rename TimeManager to CallbackManager

Author: juliasloan25

README.md

@@ -26,7 +26,7 @@ ClimaUtilities.jl
   to process input data and remap it onto the simulation grid.
 - [`OutputPathGenerator`](https://clima.github.io/ClimaUtilities.jl/dev/outputpathgenerator/)
   to prepare the output directory structure of a simulation.
-- [`TimeManager`](https://clima.github.io/ClimaUtilities.jl/dev/timemanager/) to
+- [`CallbackManager`](https://clima.github.io/ClimaUtilities.jl/dev/callbackmanager/) to
   handle dates.
 
 ## ClimaUtilities.jl Developer Guidelines
@@ -178,6 +178,5 @@ two commits when the second just fixes the first).
 
 The `Space` and `TimeVaryingInputs` modules were initially developed in the
 context of [`ClimaLand`](https://github.com/CliMA/ClimaLand.jl), the
-`TempestRegridder` and `TimeManager` ones were initially developed in
+`TempestRegridder` and `CallbackManager` ones were initially developed in
 [`ClimaCoupler`](https://github.com/CliMA/ClimaCoupler.jl).
-

docs/make.jl

@@ -23,7 +23,7 @@ pages = [
     "DataHandling" => "datahandling.md",
     "Regridders" => "regridders.md",
     "OutputPathGenerator" => "outputpathgenerator.md",
-    "TimeManager" => "timemanager.md",
+    "CallbackManager" => "callbackmanager.md",
     "Frequently Asked Questions" => "faqs.md",
 ]
 

docs/src/callbackmanager.md

@@ -0,0 +1,16 @@
+# CallbackManager
+
+This module contains functions that handle dates and times
+in simulations. The functions in this module often call
+functions from Julia's [Dates](https://docs.julialang.org/en/v1/stdlib/Dates/) module.
+
+## CallbackManager API
+
+```@docs
+ClimaUtilities.CallbackManager.to_datetime
+ClimaUtilities.CallbackManager.strdate_to_datetime
+ClimaUtilities.CallbackManager.datetime_to_strdate
+ClimaUtilities.CallbackManager.trigger_callback
+ClimaUtilities.CallbackManager.Monthly
+ClimaUtilities.CallbackManager.EveryTimestep
+```

docs/src/timemanager.md

@@ -1,10 +1,10 @@
 """
-    TimeManager
+    CallbackManager
 
 This module facilitates calendar functions and temporal interpolations
 of data.
 """
-module TimeManager
+module CallbackManager
 
 import Dates
 
@@ -105,4 +105,4 @@ function trigger_callback(
     end
 end
 
-end # module TimeManager
+end # module CallbackManager

src/TimeManager.jl renamed to src/CallbackManager.jl

@@ -2,7 +2,7 @@ module ClimaUtilities
 
 include("Utils.jl")
 include("MPIUtils.jl")
-include("TimeManager.jl")
+include("CallbackManager.jl")
 include("DataStructures.jl")
 include("FileReaders.jl")
 include("Regridders.jl")

src/ClimaUtilities.jl

@@ -1,4 +1,4 @@
-import ClimaUtilities: TimeManager
+import ClimaUtilities: CallbackManager
 import Dates
 import CFTime
 using Test
@@ -9,32 +9,32 @@ for FT in (Float32, Float64)
         year = 2001
         dt_noleap = CFTime.DateTimeNoLeap(year)
         dt = Dates.DateTime(year)
-        @test TimeManager.to_datetime(dt_noleap) == dt
+        @test CallbackManager.to_datetime(dt_noleap) == dt
         # In non-leap year, DateTime and DateTimeNoLeap are the same
-        @test TimeManager.to_datetime(dt_noleap + Dates.Day(365)) ==
+        @test CallbackManager.to_datetime(dt_noleap + Dates.Day(365)) ==
               dt + Dates.Day(365)
 
         # Test leap year behavior
         leap_year = 2000
         dt_noleap_ly = CFTime.DateTimeNoLeap(leap_year)
         dt_ly = Dates.DateTime(leap_year)
         # DateTime includes leap days, DateTimeNoLeap does not, so DateTime has one extra day in leap year
-        @test TimeManager.to_datetime(dt_noleap_ly + Dates.Day(365)) ==
+        @test CallbackManager.to_datetime(dt_noleap_ly + Dates.Day(365)) ==
               dt_ly + Dates.Day(366)
 
     end
 
     @testset "test strdate_to_datetime for FT=$FT" begin
-        @test TimeManager.strdate_to_datetime("19000101") ==
+        @test CallbackManager.strdate_to_datetime("19000101") ==
               Dates.DateTime(1900, 1, 1)
-        @test TimeManager.strdate_to_datetime("00000101") ==
+        @test CallbackManager.strdate_to_datetime("00000101") ==
               Dates.DateTime(0, 1, 1)
     end
 
     @testset "test datetime_to_strdate for FT=$FT" begin
-        @test TimeManager.datetime_to_strdate(Dates.DateTime(1900, 1, 1)) ==
+        @test CallbackManager.datetime_to_strdate(Dates.DateTime(1900, 1, 1)) ==
               "19000101"
-        @test TimeManager.datetime_to_strdate(Dates.DateTime(0, 1, 1)) ==
+        @test CallbackManager.datetime_to_strdate(Dates.DateTime(0, 1, 1)) ==
               "00000101"
     end
 
@@ -47,10 +47,10 @@ for FT in (Float32, Float64)
         arg_copy = copy(arg)
         date_current =
             date_nextcall = date_nextcall_copy = Dates.DateTime(1979, 3, 21)
-        date_nextcall = TimeManager.trigger_callback(
+        date_nextcall = CallbackManager.trigger_callback(
             date_nextcall,
             date_current,
-            TimeManager.Monthly(),
+            CallbackManager.Monthly(),
             func!,
             (arg,),
         )
@@ -61,10 +61,10 @@ for FT in (Float32, Float64)
         # Case 2: date_current > date_nextcall
         date_nextcall = date_nextcall_copy = Dates.DateTime(1979, 3, 21)
         date_current = date_nextcall + Dates.Day(1)
-        date_nextcall = TimeManager.trigger_callback(
+        date_nextcall = CallbackManager.trigger_callback(
             date_nextcall,
             date_current,
-            TimeManager.Monthly(),
+            CallbackManager.Monthly(),
             func!,
             (arg,),
         )
@@ -75,10 +75,10 @@ for FT in (Float32, Float64)
         # Case 3: date_current < date_nextcall
         date_nextcall = date_nextcall_copy = Dates.DateTime(1979, 3, 21)
         date_current = date_nextcall - Dates.Day(1)
-        date_nextcall = TimeManager.trigger_callback(
+        date_nextcall = CallbackManager.trigger_callback(
             date_nextcall,
             date_current,
-            TimeManager.Monthly(),
+            CallbackManager.Monthly(),
             func!,
             (arg,),
         )

test/timemanager.jl renamed to test/callbackmanager.jl

@@ -28,8 +28,8 @@ end
     include("output_path_generator.jl")
 end
 
-@safetestset "TimeManager tests" begin
-    include("timemanager.jl")
+@safetestset "CallbackManager tests" begin
+    include("callbackmanager.jl")
 end
 
 @safetestset "DataStructures tests" begin