Switch from OrderedCollections to DataStructures

Sbozzolo · Sbozzolo · commit b5c33485faaf · 2024-11-11T17:10:56.000-08:00
The only data structure needed in OrderedDict, which is also provided by
DataStructures (which is already a dependency of ClimaCore)
diff --git a/.buildkite/Project.toml b/.buildkite/Project.toml
@@ -16,6 +16,7 @@ ClimaTimeSteppers = "595c0a79-7f3d-439a-bc5a-b232dc3bde79"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 CountFlops = "1db9610d-79e1-487a-8d40-77f3295c7593"
 CubedSphere = "7445602f-e544-4518-8976-18f8e8ae6cdb"
+DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 DiffEqCallbacks = "459566f4-90b8-5000-8ac3-15dfb0a30def"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 FastBroadcast = "7034ab61-46d4-4ed7-9d0f-46aef9175898"
@@ -32,7 +33,6 @@ Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 MPI = "da04e1cc-30fd-572f-bb4f-1f8673147195"
 NCDatasets = "85f8d34a-cbdd-5861-8df4-14fed0d494ab"
 NVTX = "5da4648a-3479-48b8-97b9-01cb529c0a1f"
-OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
 OrdinaryDiffEqSSPRK = "669c94d9-1f4b-4b64-b377-1aa079aa2388"
 OrdinaryDiffEqTsit5 = "b1df2697-797e-41e3-8120-5422d3b24e4a"
 PProf = "e4faabce-9ead-11e9-39d9-4379958e3056"
diff --git a/test/Fields/convergence_field_integrals.jl b/test/Fields/convergence_field_integrals.jl
@@ -8,7 +8,7 @@ using JET
 
 using ClimaComms
 ClimaComms.@import_required_backends
-using OrderedCollections
+import DataStructures
 using StaticArrays, IntervalSets
 import ClimaCore
 import ClimaCore.Utilities: PlusHalf
@@ -51,7 +51,7 @@ convergence_rate(err, Δh) =
 
 @testset "Definite column integrals bycolumn" begin
     FT = Float64
-    results = OrderedCollections.OrderedDict()
+    results = DataStructures.OrderedDict()
     ∫y_analytic = 1 - cos(1) - (0 - cos(0))
     function col_field_copy(y)
         col_copy = similar(y[Fields.ColumnIndex((1, 1), 1)])
diff --git a/test/Fields/unit_field.jl b/test/Fields/unit_field.jl
@@ -8,7 +8,6 @@ using JET
 
 using ClimaComms
 ClimaComms.@import_required_backends
-using OrderedCollections
 using StaticArrays, IntervalSets
 import ClimaCore
 import ClimaCore.InputOutput
diff --git a/test/Fields/utils_field_multi_broadcast_fusion.jl b/test/Fields/utils_field_multi_broadcast_fusion.jl
@@ -10,7 +10,6 @@ using BenchmarkTools
 
 using ClimaComms
 ClimaComms.@import_required_backends
-using OrderedCollections
 using StaticArrays, IntervalSets
 import ClimaCore
 import ClimaCore.Utilities: PlusHalf
diff --git a/test/Geometry/axistensor_conversion_benchmarks.jl b/test/Geometry/axistensor_conversion_benchmarks.jl
@@ -1,7 +1,7 @@
 using Test, StaticArrays
 #! format: off
 import Random, BenchmarkTools, StatsBase,
-    OrderedCollections, LinearAlgebra, CountFlops
+    DataStructures, LinearAlgebra, CountFlops
 using ClimaCore.Geometry:Geometry, AbstractAxis, CovariantAxis,
     AxisVector, ContravariantAxis, LocalAxis, CartesianAxis, AxisTensor,
     Covariant1Vector, Covariant13Vector, UVVector, UWVector, UVector,
@@ -150,7 +150,7 @@ compare(x::T, y::T) where {T <: AxisTensor} = compare(components(x), components(
 
 function test_optimized_functions(::Type{FT}; print_method_info=false) where {FT}
     @info "Testing optimized functions with $FT"
-    benchmarks = OrderedCollections.OrderedDict()
+    benchmarks = DataStructures.OrderedDict()
     for f in (
         Geometry.project,
         Geometry.transform,
diff --git a/test/Operators/finitedifference/benchmark_stencils_utils.jl b/test/Operators/finitedifference/benchmark_stencils_utils.jl
@@ -5,7 +5,7 @@ ClimaComms.@import_required_backends
 using StaticArrays, IntervalSets, LinearAlgebra
 import BenchmarkTools
 import StatsBase
-import OrderedCollections
+import DataStructures
 using ClimaCore.Geometry: ⊗
 import ClimaCore.DataLayouts
 
@@ -348,8 +348,8 @@ function benchmark_operators_column(bm; z_elems, helem, Nq, compile::Bool = fals
     FT = bm.float_type
     device = ClimaComms.device()
     @show device
-    trials = OrderedCollections.OrderedDict()
-    t_min = OrderedCollections.OrderedDict()
+    trials = DataStructures.OrderedDict()
+    t_min = DataStructures.OrderedDict()
 
     cspace = TU.ColumnCenterFiniteDifferenceSpace(FT; zelem=z_elems)
     fspace = Spaces.FaceFiniteDifferenceSpace(cspace)
@@ -367,8 +367,8 @@ function benchmark_operators_sphere(bm; z_elems, helem, Nq, compile::Bool = fals
     FT = bm.float_type
     device = ClimaComms.device()
     @show device
-    trials = OrderedCollections.OrderedDict()
-    t_min = OrderedCollections.OrderedDict()
+    trials = DataStructures.OrderedDict()
+    t_min = DataStructures.OrderedDict()
 
     cspace = TU.CenterExtrudedFiniteDifferenceSpace(FT; zelem=z_elems, helem, Nq, horizontal_layout_type)
     fspace = Spaces.FaceExtrudedFiniteDifferenceSpace(cspace)
diff --git a/test/Operators/spectralelement/benchmark_ops.jl b/test/Operators/spectralelement/benchmark_ops.jl
@@ -26,6 +26,7 @@ CUDA.@profile kernel_spectral_div_grad!(kernel_args)
 ```
 =#
 import ClimaCore as CC
+import DataStructures
 include(
     joinpath(
         pkgdir(CC),
@@ -87,7 +88,7 @@ function benchmark_all(kernel_args = setup_kernel_args(ARGS))
     #! format: on
     silent = true # see BenchmarkTools.@benchmark output with `silent = false`
 
-    bm = OrderedCollections.OrderedDict()
+    bm = DataStructures.OrderedDict()
     for (k, ka) in kernels
         # key = (Symbol(k), Symbol(ka))
         key = Symbol(k)
diff --git a/test/Operators/spectralelement/benchmark_times.jl b/test/Operators/spectralelement/benchmark_times.jl
@@ -9,7 +9,7 @@ function get_best_times((; device, float_type))
 end
 
 function get_best_times_cpu_float64()
-    best_times = OrderedCollections.OrderedDict()
+    best_times = DataStructures.OrderedDict()
     best_times[:kernel_spectral_wdiv!] = 87042.2667
     best_times[:kernel_spectral_grad!] = 77839.3543
     best_times[:kernel_spectral_grad_norm!] = 105859.9405
@@ -22,7 +22,7 @@ function get_best_times_cpu_float64()
     return best_times
 end
 function get_best_times_cpu_float32()
-    best_times = OrderedCollections.OrderedDict()
+    best_times = DataStructures.OrderedDict()
     best_times[:kernel_spectral_wdiv!] = 79922.8909
     best_times[:kernel_spectral_grad!] = 74736.2011
     best_times[:kernel_spectral_grad_norm!] = 101959.6227
@@ -35,7 +35,7 @@ function get_best_times_cpu_float32()
     return best_times
 end
 function get_best_times_gpu_float64()
-    best_times = OrderedCollections.OrderedDict()
+    best_times = DataStructures.OrderedDict()
     best_times[:kernel_spectral_wdiv!] = 21750.2493
     best_times[:kernel_spectral_grad!] = 21046.113
     best_times[:kernel_spectral_grad_norm!] = 53723.9003
@@ -48,7 +48,7 @@ function get_best_times_gpu_float64()
     return best_times
 end
 function get_best_times_gpu_float32()
-    best_times = OrderedCollections.OrderedDict()
+    best_times = DataStructures.OrderedDict()
     best_times[:kernel_spectral_wdiv!] = 26606.9483
     best_times[:kernel_spectral_grad!] = 20715.8317
     best_times[:kernel_spectral_grad_norm!] = 52673.6528
diff --git a/test/Operators/spectralelement/benchmark_utils.jl b/test/Operators/spectralelement/benchmark_utils.jl
@@ -5,7 +5,6 @@
 using LinearAlgebra: ×
 import PrettyTables
 import LinearAlgebra as LA
-import OrderedCollections
 import ClimaCore.DataLayouts
 import ClimaCore.Operators as Operators
 import ClimaCore.Domains as Domains
