(0.3.0) Cleaner syntax for ECCOFieldTimeSeries and ECCORestoring

src/DataWrangling/ECCO/ECCO_restoring.jl

@@ -51,15 +51,15 @@ end
 Base.length(backend::ECCONetCDFBackend)  = backend.length
 Base.summary(backend::ECCONetCDFBackend) = string("ECCONetCDFBackend(", backend.start, ", ", backend.length, ")")
 
-const ECCONetCDFFTS{N} = FlavorOfFTS{<:Any, <:Any, <:Any, <:Any, <:ECCONetCDFBackend{N}} where N
+const ECCOFieldTimeSeries{N} = FlavorOfFTS{<:Any, <:Any, <:Any, <:Any, <:ECCONetCDFBackend{N}} where N
 
 new_backend(b::ECCONetCDFBackend{native, cache_data}, start, length) where {native, cache_data} =
     ECCONetCDFBackend{native, cache_data}(start, length, b.inpainting, b.metadata)
 
 on_native_grid(::ECCONetCDFBackend{native}) where native = native
 cache_inpainted_data(::ECCONetCDFBackend{native, cache_data}) where {native, cache_data} = cache_data
 
-function set!(fts::ECCONetCDFFTS) 
+function set!(fts::ECCOFieldTimeSeries) 
     backend = fts.backend
     start   = backend.start
     inpainting = backend.inpainting
@@ -105,12 +105,11 @@ function ECCO_times(metadata; start_time = first(metadata).dates)
 end
 
 """
-    ECCO_field_time_series(metadata::ECCOMetadata;
-                           grid = nothing,
-                           architecture = isnothing(grid) ? CPU() : architecture(grid),
-                           time_indices_in_memory = 2,
-                           time_indexing = Cyclical(),
-                           inpainting_iterations = prod(size(metadata)),
+    ECCOFieldTimeSeries(metadata::ECCOMetadata, grid=nothing;
+                        architecture = isnothing(grid) ? CPU() : architecture(grid),
+                        time_indices_in_memory = 2,
+                        time_indexing = Cyclical(),
+                        inpainting = nothing)
 
 Create a field time series object for ECCO data.
 
@@ -138,49 +137,47 @@ Keyword Arguments
                           Default: `true`.
 
 """
-function ECCO_field_time_series(metadata::ECCOMetadata;	
-                                architecture = CPU(),	
-                                time_indices_in_memory = 2,	
-                                time_indexing = Cyclical(),
-                                inpainting = NearestNeighborInpainting(prod(size(metadata))),
-                                cache_inpainted_data = true,
-                                grid = nothing)	
+function ECCOFieldTimeSeries(metadata::ECCOMetadata, arch::AbstractArchitecture=CPU(); kw...)
+    download_dataset(metadata)
+    ftmp = empty_ECCO_field(first(metadata); architecture)
+    grid = ftmp.grid
+    return ECCOFieldTimeSeries(metadata, grid; kw...)
+end
+
+function ECCOFieldTimeSeries(metadata::ECCOMetadata, grid::AbstractGrid;
+                             time_indices_in_memory = 2,	
+                             time_indexing = Cyclical(),
+                             inpainting = nothing,
+                             cache_inpainted_data = true)
 
     # Make sure all the required individual files are downloaded
     download_dataset(metadata)
 
     inpainting isa Int && (inpainting = NearestNeighborInpainting(inpainting))
-
-    ftmp = empty_ECCO_field(first(metadata); architecture)
-    on_native_grid = isnothing(grid)
-    on_native_grid && (grid = ftmp.grid)
+    backend = ECCONetCDFBackend(time_indices_in_memory, metadata; on_native_grid, inpainting, cache_inpainted_data)
 
     times = ECCO_times(metadata)
     loc = LX, LY, LZ = location(metadata)
     boundary_conditions = FieldBoundaryConditions(grid, loc)
-
-    backend = ECCONetCDFBackend(time_indices_in_memory, metadata; on_native_grid, inpainting, cache_inpainted_data)
-
     fts = FieldTimeSeries{LX, LY, LZ}(grid, times; backend, time_indexing, boundary_conditions)
     set!(fts)	
 
     return fts	
 end
 
-ECCO_field_time_series(variable_name::Symbol, version=ECCO4Monthly(); kw...) = 
-    ECCO_field_time_series(ECCOMetadata(variable_name, all_ECCO_dates(version), version); kw...)
+ECCOFieldTimeSeries(variable_name::Symbol, version=ECCO4Monthly(); kw...) = 
+    ECCOFieldTimeSeries(ECCOMetadata(variable_name, all_ECCO_dates(version), version); kw...)
 
 # Variable names for restoreable data
 struct Temperature end
 struct Salinity end
 struct UVelocity end
 struct VVelocity end
 
-oceananigans_fieldname = Dict(
-    :temperature => Temperature(), 
-    :salinity    => Salinity(), 
-    :u_velocity  => UVelocity(), 
-    :v_velocity  => VVelocity())
+const oceananigans_fieldnames = Dict(:temperature => Temperature(), 
+                                     :salinity    => Salinity(), 
+                                     :u_velocity  => UVelocity(), 
+                                     :v_velocity  => VVelocity())
 
 @inline Base.getindex(fields, i, j, k, ::Temperature) = @inbounds fields.T[i, j, k]
 @inline Base.getindex(fields, i, j, k, ::Salinity)    = @inbounds fields.S[i, j, k]
@@ -250,7 +247,7 @@ end
                   mask = 1,
                   rate = 1,
                   grid = nothing,
-                  inpainting = NearestNeighborInpainting(prod(size(metadata))),
+                  inpainting = NearestNeighborInpainting(Inf),
                   cache_inpainted_data = true)
 
 Create a forcing term that restores to values stored in an ECCO field time series.
@@ -330,17 +327,16 @@ function ECCORestoring(arch::AbstractArchitecture,
         throw(ArgumentError("The architecture of ECCORestoring must match the architecture of the grid."))
     end
 
-    fts = ECCO_field_time_series(metadata; 
-                                 grid, 
-                                 architecture = arch, 
-                                 time_indices_in_memory, 
-                                 time_indexing, 
-                                 inpainting,
-                                 cache_inpainted_data)
+    fts = ECCOFieldTimeSeries(metadata, grid;
+                              architecture = arch, 
+                              time_indices_in_memory, 
+                              time_indexing, 
+                              inpainting,
+                              cache_inpainted_data)
 
     # Grab the correct Oceananigans field to restore
     variable_name = metadata.name
-    field_name = oceananigans_fieldname[variable_name]
+    field_name = oceananigans_fieldnames[variable_name]
 
     # If we pass the grid we do not need to interpolate
     # so we can save parameter space by setting the native grid to nothing