Add Var.has_dim

Useful to see if a variable has a given dimension (e.g., `z`).
CliMA · Aug 3, 2024 · 2114df2 · 2114df2
1 parent 982973c
commit 2114df2
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/src/outvar_dimensions.jl b/src/outvar_dimensions.jl
@@ -25,11 +25,18 @@ export times,
     _dim_name(dim_names, allowed_names)
 
 Return the `dim_name` within `dim_names` that is contained in `allowed_names`.
-Return `nothing` is not available
+Return `nothing` is not available.
+
+Example
+==========
+
+```jldoctest
+julia> ClimaAnalysis.Var._dim_name(["z", "lat", "lon"], ["lon", "long"])
+1
+```
 """
 function _dim_name(dim_names, allowed_names)
-    return
-    findfirst(possible_name -> possible_name in dim_names, allowed_names)
+    return findfirst(possible_name -> possible_name in dim_names, allowed_names)
 end
 
 """

diff --git a/test/test_Var.jl b/test/test_Var.jl
@@ -324,7 +324,7 @@ end
     time = 0.0:10.0 |> collect
     alt = 0.0:2.0 |> collect
 
-    data = reshape(1.0:(3 * 91 * 181 * 11), (3, 11, 181, 91))
+    data = reshape(1.0:(3 * 91 * 181 * 11), (11, 181, 91, 3))
 
     dims =
         OrderedDict(["time" => time, "lon" => long, "lat" => lat, "z" => alt])