Add add_date_maybe!

Author: ph-kev

src/netcdf_writer.jl

@@ -373,6 +373,13 @@ function write_field!(writer::NetCDFWriter, field, diagnostic, u, p, t)
     else
         start_date = writer.start_date
     end
+    if !isnothing(start_date)
+        add_date_maybe!(
+            nc;
+            units = "seconds since $start_date",
+            bounds = "date_bnds",
+        )
+    end
 
     if haskey(nc, "$(var.short_name)")
         # We already have something in the file
@@ -409,8 +416,9 @@ function write_field!(writer::NetCDFWriter, field, diagnostic, u, p, t)
     # FIXME: We are rounding t
     if !isnothing(start_date)
         # TODO: Use ITime here
-        nc["date"][time_index] =
-            string(start_date + Dates.Millisecond(round(1000 * float(t))))
+        curr_date = start_date + Dates.Millisecond(round(1000 * float(t)))
+        date_type = typeof(curr_date) # not necessarily a Dates.DateTime
+        nc["date"][time_index] = curr_date
     end
 
     # TODO: It would be nice to find a cleaner way to do this

src/netcdf_writer_coordinates.jl

@@ -98,8 +98,6 @@ end
 
 Add the `time` dimension (with infinite size) to the given NetCDF file if not already there.
 Optionally, add all the keyword arguments as attributes.
-
-Also add a `date` dataset (as a string).
 """
 function add_time_maybe!(
     nc::NCDatasets.NCDataset,
@@ -112,7 +110,28 @@ function add_time_maybe!(
 
     NCDatasets.defDim(nc, "time", Inf)
     dim = NCDatasets.defVar(nc, "time", FT, ("time",))
-    NCDatasets.defVar(nc, "date", String, ("time",))
+    for (k, v) in kwargs
+        dim.attrib[String(k)] = v
+    end
+    return nothing
+end
+
+"""
+    add_date_maybe!(nc::NCDatasets.NCDataset,
+                    kwargs...)
+
+Add the `date` dimension (with infinite size) to the given NetCDF file if not already there.
+Optionally, add all the keyword arguments as attributes.
+"""
+function add_date_maybe!(nc::NCDatasets.NCDataset; kwargs...)
+    haskey(nc, "date") && return nothing
+    !haskey(nc, "time") &&
+        error("`add_date_maybe!` is meant to be called after `add_time_maybe!`")
+    dim = NCDatasets.defVar(nc, "date", Float64, ("time",))
+    for (k, v) in kwargs
+        dim.attrib[String(k)] = v
+    end
+end
     for (k, v) in kwargs
         dim.attrib[String(k)] = v
     end

test/writers.jl

@@ -97,8 +97,7 @@ end
               string(Dates.DateTime(1453, 5, 29))
         @test size(nc["ABC"]) == (1, NUM, 2NUM, 3NUM)
         @test nc["time"][1] == 10.0
-        @test nc["date"][1] ==
-              string(Dates.DateTime(1453, 5, 29) + Dates.Second(10.0))
+        @test nc["date"][1] == Dates.DateTime(1453, 5, 29) + Dates.Second(10.0)
         @test nc["time"].attrib["standard_name"] == "time"
         @test nc["time"].attrib["long_name"] == "Time"
         @test nc["time"].attrib["axis"] == "T"