feat: TimeSeriesAPI module

Author: Beforerr

README.md

@@ -1,7 +1,7 @@
 # SpaceDataModel
 
-[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaSpacePhysics.github.io/SpaceDataModel.jl/dev/)
 [![DOI](https://zenodo.org/badge/958430775.svg)](https://doi.org/10.5281/zenodo.15207556)
+[![version](https://juliahub.com/docs/General/SpaceDataModel/stable/version.svg)](https://juliahub.com/ui/Packages/General/SpaceDataModel)
 
 [![Build Status](https://github.com/JuliaSpacePhysics/SpaceDataModel.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaSpacePhysics/SpaceDataModel.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![](https://img.shields.io/badge/%F0%9F%9B%A9%EF%B8%8F_tested_with-JET.jl-233f9a)](https://github.com/aviatesk/JET.jl)
@@ -14,12 +14,9 @@ SpaceDataModel.jl is a lightweight Julia package providing a flexible data model
 
 For information on using the package, see the documentation available at https://JuliaSpacePhysics.github.io/SpaceDataModel.jl/dev/.
 
-## Installation
+**Installation**: at the Julia REPL, run `using Pkg; Pkg.add("SpaceDataModel")`
 
-```julia
-using Pkg
-Pkg.add("SpaceDataModel")
-```
+**Documentation**: [![Dev](https://img.shields.io/badge/docs-dev-blue.svg?logo=julia)](https://JuliaSpacePhysics.github.io/SpaceDataModel.jl/dev/)
 
 ## Usage
 

ext/SpaceDataModelDimensionalDataExt.jl

@@ -1,18 +1,22 @@
 module SpaceDataModelDimensionalDataExt
 
 import SpaceDataModel
-using DimensionalData: AbstractDimArray, TimeDim, dims, Dimension
+using DimensionalData: AbstractDimArray, TimeDim, dims, Dimension, Dim
 import DimensionalData as DD
-import SpaceDataModel: meta, _merge, timedim, unwrap, name
+import SpaceDataModel: meta, _merge, tdimnum, timedim, unwrap, name
 
 _merge(::DD.NoMetadata, d, rest...) = merge(d, rest...)
-meta(A::AbstractDimArray) = DD.metadata(A)
-name(x::Dimension) = DD.name(x)
-unwrap(x::Dimension) = parent(x)
+SpaceDataModel.getmeta(A::AbstractDimArray) = DD.metadata(A)
+SpaceDataModel.name(x::Dimension) = DD.name(x)
+SpaceDataModel.unwrap(x::Dimension) = parent(x)
+
+# A no-error version of `dimnum`
+_dimnum(x, dim) = DD.hasdim(x, dim) ? DD.dimnum(x, dim) : nothing
+
+SpaceDataModel.tdimnum(x::AbstractDimArray) = @something(
+    _dimnum(x, TimeDim),
+    _dimnum(x, Dim{:time}),
+    tdimnum(parent(x))
+)
 
-function SpaceDataModel.timedim(x::AbstractDimArray, query = nothing)
-    query = something(query, TimeDim)
-    qdim = dims(x, query)
-    return isnothing(qdim) ? dims(x, 1) : qdim
-end
 end

src/SpaceDataModel.jl

@@ -27,7 +27,7 @@ include("workload.jl")
 
 include("variable_interface.jl")
 
-include("times.jl")
-using .Times
+include("times.jl");        using .Times
+include("timeseries.jl");   using .TimeSeriesAPI
 
 end

src/timeseries.jl

@@ -0,0 +1,22 @@
+"""A time series-focused namespace for packages to share functions"""
+module TimeSeriesAPI
+using ..SpaceDataModel: dim, @getfield, unwrap
+export tdimnum, timedim, times, tmin, tmax
+"""
+    tdimnum(x)
+
+Get the time dimension number of object `x`.
+"""
+function tdimnum(x)
+    @warn "Could not guess the time dimension number, assuming last dimension"
+    return ndims(x)
+end
+
+timedim(x) = dim(x, tdimnum(x))
+
+times(v) = @getfield v (:times, :time) unwrap(timedim(v))
+
+tmin(v) = minimum(times(v))
+tmax(v) = maximum(times(v))
+
+end

src/variable.jl

@@ -32,9 +32,6 @@ Base.setindex!(var::AbstractDataVariable, v, s::Union{String, Symbol}) = setinde
 Base.get(var::AbstractDataVariable, s::Union{String, Symbol}, d = nothing) = _get(meta(var), s, d)
 Base.get(f::Function, var::AbstractDataVariable, s::Union{String, Symbol}) = get(f, meta(var), s)
 
-tmin(v) = minimum(times(v))
-tmax(v) = maximum(times(v))
-
 _timerange_str(times) = "Time Range: $(minimum(times)) to $(maximum(times))"
 
 function Base.show(io::IO, var::T) where {T <: AbstractDataVariable}

src/variable_interface.jl

@@ -29,15 +29,14 @@ function dim(x, s::Union{String, Symbol})
     error("Dimension $s not found")
 end
 
-timedim(x) = dim(x, ndims(x))
-
 """
     getmeta(x)
 
 Get metadata for object `x`. If `x` does not have metadata, return `NoMetadata()`. 
 
 """
 getmeta(x) = @getfield x (:meta, :metadata) NoMetadata()
+getmeta(x::AbstractDict) = x
 
 # like get, but handles NamedTuple
 _get(x, key, default) = get(x, key, default)
@@ -50,10 +49,9 @@ Get metadata value associated with `key` for object `x`, or `default` if `key` i
 """
 getmeta(x, key, default = nothing) = _get(meta(x), key, default)
 
-meta(x) = getmeta(x) # not exported (to be removed)
+const meta = getmeta # not exported (to be removed)
 
 units(v) = @get(v, "units", nothing)
-times(v) = @getfield v (:times, :time) unwrap(timedim(v))
 
 function unit(v)
     us = units(v)

test/ext/DimensionalData.jl

@@ -31,16 +31,23 @@ end
     @test dim(x, :X) == X(1:3)
     @test_throws ErrorException dim(x, :time)
 
-    @test timedim(x) == Ti([1, 2, 3, 4, 5])
-    @test times(x) == [1, 2, 3, 4, 5]
-    @test tmin(x) == 1
-    @test tmax(x) == 5
-    @test unwrap(timedim(x)) == 1:5
-
-    @test name(timedim(x)) == :Ti
     @test string(name(x)) == ""
-
-    @test unwrap(Ti(1:5)) == 1:5
-    @test Ti(1:5) isa DimensionalData.Dimension
     @test unwrap(Ti(view([1, 2, 3, 4, 5], 2:3))) == view(1:5, 2:3)
+
+    @testset "TimeSeriesAPI" begin
+        using Chairmarks
+        using SpaceDataModel: tdimnum
+        x = rand(X(3), Ti(5), Z(2))
+        @test tdimnum(x) == 2
+        @test timedim(x) == Ti([1, 2, 3, 4, 5])
+        @test times(x) == [1, 2, 3, 4, 5]
+        @test tmin(x) == 1
+        @test tmax(x) == 5
+        @test unwrap(timedim(x)) == 1:5
+        @test name(timedim(x)) == :Ti
+
+        x = rand(X(3), Dim{:time}(5), Z(2))
+        @test tdimnum(x) == 2
+        @test (@allocated tdimnum(x)) == 0
+    end
 end