Remove Dierckx, move to Interpolations

NEWS.md

@@ -5,12 +5,15 @@ Main
 -------
 - Allow different aerosol types for radiation.
   PR [#3180](https://github.com/CliMA/ClimaAtmos.jl/pull/3180)
+- ![][badge-🔥behavioralΔ] Switch from `Dierckz` to `Interpolations`. `Interpolations`
+  is type-stable and GPU compatible. The order of interpolation has decreased to first.
+  PR [#3169](https://github.com/CliMA/ClimaAtmos.jl/pull/3169)
 
 v0.27.0
 -------
-- ![][badge-💥breaking] Change "radiation_model" in the radiation cache to "rrtmgp_model".
+- ![][badge-💥breaking] Change `radiation_model` in the radiation cache to `rrtmgp_model`.
   PR [#3167](https://github.com/CliMA/ClimaAtmos.jl/pull/3167)
-- ![][badge-💥breaking] Change the "idealized_insolation" argument to "insolation", 
+- ![][badge-💥breaking] Change the `idealized_insolation` argument to `insolation`,
   and add RCEMIP insolation. PR [#3150](https://github.com/CliMA/ClimaAtmos.jl/pull/3150)
 - Add lookup table for aerosols
   PR [#3156](https://github.com/CliMA/ClimaAtmos.jl/pull/3156)
@@ -19,7 +22,7 @@ v0.26.3
 -------
 - Add ClimaCoupler downstream test.
   PR [#3152](https://github.com/CliMA/ClimaAtmos.jl/pull/3152)
-- Add an option to use aerosol radiation. This is not fully working yet. 
+- Add an option to use aerosol radiation. This is not fully working yet.
   PR [#3147](https://github.com/CliMA/ClimaAtmos.jl/pull/3147)
 - Update to RRTMGP v0.17.0.
   PR [#3131](https://github.com/CliMA/ClimaAtmos.jl/pull/3131)
@@ -30,12 +33,12 @@ v0.26.2
 -------
 - Limit temperature input to RRTMGP within the lookup table range.
   PR [#3124](https://github.com/CliMA/ClimaAtmos.jl/pull/3124)
-  
+
 v0.26.1
 -------
 - Updated RRTMGP compat from 0.15 to 0.16
   PR [#3114](https://github.com/CliMA/ClimaAtmos.jl/pull/3114)
-- ![][badge-🔥behavioralΔ] Removed the filter for shortwave radiative fluxes. 
+- ![][badge-🔥behavioralΔ] Removed the filter for shortwave radiative fluxes.
   PR [#3099](https://github.com/CliMA/ClimaAtmos.jl/pull/3099).
 
 v0.26.0

Project.toml

@@ -18,7 +18,6 @@ ClimaUtilities = "b3f4f4ca-9299-4f7f-bd9b-81e1242a7513"
 CloudMicrophysics = "6a9e3e04-43cd-43ba-94b9-e8782df3c71b"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
-Dierckx = "39dd38d3-220a-591b-8e3c-4c3a8c710a94"
 DiffEqBase = "2b5f629d-d688-5b77-993f-72d75c75574e"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 FastGaussQuadrature = "442a2c76-b920-505d-bb47-c5924d526838"
@@ -48,7 +47,7 @@ Adapt = "4"
 ArgParse = "1"
 ArtifactWrappers = "0.2"
 Artifacts = "1"
-AtmosphericProfilesLibrary = "0.1"
+AtmosphericProfilesLibrary = "0.1.6"
 ClimaComms = "0.6.2"
 ClimaCore = "0.14.6"
 ClimaDiagnostics = "0.2"
@@ -58,7 +57,6 @@ ClimaUtilities = "0.1.3"
 CloudMicrophysics = "0.22"
 Colors = "0.12"
 Dates = "1"
-Dierckx = "0.5"
 DiffEqBase = "6"
 DocStringExtensions = "0.8, 0.9"
 FastGaussQuadrature = "0.4, 0.5, 1"

docs/Manifest.toml

@@ -292,7 +292,7 @@ weakdeps = ["SparseArrays"]
     ChainRulesCoreSparseArraysExt = "SparseArrays"
 
 [[deps.ClimaAtmos]]
-deps = ["Adapt", "ArgParse", "ArtifactWrappers", "Artifacts", "AtmosphericProfilesLibrary", "ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaParams", "ClimaTimeSteppers", "ClimaUtilities", "CloudMicrophysics", "Colors", "Dates", "Dierckx", "DiffEqBase", "DocStringExtensions", "FastGaussQuadrature", "Insolation", "Interpolations", "IntervalSets", "Krylov", "LinearAlgebra", "Logging", "NCDatasets", "NVTX", "Pkg", "Printf", "RRTMGP", "Random", "RootSolvers", "SciMLBase", "StaticArrays", "Statistics", "StatsBase", "SurfaceFluxes", "Thermodynamics", "YAML"]
+deps = ["Adapt", "ArgParse", "ArtifactWrappers", "Artifacts", "AtmosphericProfilesLibrary", "ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaParams", "ClimaTimeSteppers", "ClimaUtilities", "CloudMicrophysics", "Colors", "Dates", "DiffEqBase", "DocStringExtensions", "FastGaussQuadrature", "Insolation", "Interpolations", "IntervalSets", "Krylov", "LinearAlgebra", "Logging", "NCDatasets", "NVTX", "Pkg", "Printf", "RRTMGP", "Random", "RootSolvers", "SciMLBase", "StaticArrays", "Statistics", "StatsBase", "SurfaceFluxes", "Thermodynamics", "YAML"]
 path = ".."
 uuid = "b2c96348-7fb7-4fe0-8da9-78d88439e717"
 version = "0.27.0"
@@ -551,18 +551,6 @@ git-tree-sha1 = "9e2f36d3c96a820c678f2f1f1782582fcf685bae"
 uuid = "8bb1440f-4735-579b-a4ab-409b98df4dab"
 version = "1.9.1"
 
-[[deps.Dierckx]]
-deps = ["Dierckx_jll"]
-git-tree-sha1 = "d1ea9f433781bb6ff504f7d3cb70c4782c504a3a"
-uuid = "39dd38d3-220a-591b-8e3c-4c3a8c710a94"
-version = "0.5.3"
-
-[[deps.Dierckx_jll]]
-deps = ["Artifacts", "CompilerSupportLibraries_jll", "JLLWrappers", "Libdl", "Pkg"]
-git-tree-sha1 = "6596b96fe1caff3db36415eeb6e9d3b50bfe40ee"
-uuid = "cd4c43a9-7502-52ba-aa6d-59fb2a88580b"
-version = "0.1.0+0"
-
 [[deps.DiffEqBase]]
 deps = ["ArrayInterface", "ConcreteStructs", "DataStructures", "DocStringExtensions", "EnumX", "EnzymeCore", "FastBroadcast", "FastClosures", "ForwardDiff", "FunctionWrappers", "FunctionWrappersWrappers", "LinearAlgebra", "Logging", "Markdown", "MuladdMacro", "Parameters", "PreallocationTools", "PrecompileTools", "Printf", "RecursiveArrayTools", "Reexport", "SciMLBase", "SciMLOperators", "Setfield", "SparseArrays", "Static", "StaticArraysCore", "Statistics", "Tricks", "TruncatedStacktraces"]
 git-tree-sha1 = "d1e8a4642e28b0945bde6e2e1ac569b9e0abd728"

examples/Manifest.toml

@@ -2,7 +2,7 @@
 
 julia_version = "1.10.4"
 manifest_format = "2.0"
-project_hash = "d95e2ede05eb683ad8fc21789282919021c2aa3d"
+project_hash = "0c59f47e75bae5d377c2b1fa267ce810d21934c6"
 
 [[deps.ADTypes]]
 git-tree-sha1 = "7a6b285f217ba92b5b474b783b4c2e8cf8218aaa"
@@ -320,7 +320,7 @@ version = "0.5.5"
     GeoMakie = "db073c08-6b98-4ee5-b6a4-5efafb3259c6"
 
 [[deps.ClimaAtmos]]
-deps = ["Adapt", "ArgParse", "ArtifactWrappers", "Artifacts", "AtmosphericProfilesLibrary", "ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaParams", "ClimaTimeSteppers", "ClimaUtilities", "CloudMicrophysics", "Colors", "Dates", "Dierckx", "DiffEqBase", "DocStringExtensions", "FastGaussQuadrature", "Insolation", "Interpolations", "IntervalSets", "Krylov", "LinearAlgebra", "Logging", "NCDatasets", "NVTX", "Pkg", "Printf", "RRTMGP", "Random", "RootSolvers", "SciMLBase", "StaticArrays", "Statistics", "StatsBase", "SurfaceFluxes", "Thermodynamics", "YAML"]
+deps = ["Adapt", "ArgParse", "ArtifactWrappers", "Artifacts", "AtmosphericProfilesLibrary", "ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaParams", "ClimaTimeSteppers", "ClimaUtilities", "CloudMicrophysics", "Colors", "Dates", "DiffEqBase", "DocStringExtensions", "FastGaussQuadrature", "Insolation", "Interpolations", "IntervalSets", "Krylov", "LinearAlgebra", "Logging", "NCDatasets", "NVTX", "Pkg", "Printf", "RRTMGP", "Random", "RootSolvers", "SciMLBase", "StaticArrays", "Statistics", "StatsBase", "SurfaceFluxes", "Thermodynamics", "YAML"]
 path = ".."
 uuid = "b2c96348-7fb7-4fe0-8da9-78d88439e717"
 version = "0.27.0"
@@ -607,18 +607,6 @@ git-tree-sha1 = "9e2f36d3c96a820c678f2f1f1782582fcf685bae"
 uuid = "8bb1440f-4735-579b-a4ab-409b98df4dab"
 version = "1.9.1"
 
-[[deps.Dierckx]]
-deps = ["Dierckx_jll"]
-git-tree-sha1 = "d1ea9f433781bb6ff504f7d3cb70c4782c504a3a"
-uuid = "39dd38d3-220a-591b-8e3c-4c3a8c710a94"
-version = "0.5.3"
-
-[[deps.Dierckx_jll]]
-deps = ["Artifacts", "CompilerSupportLibraries_jll", "JLLWrappers", "Libdl", "Pkg"]
-git-tree-sha1 = "6596b96fe1caff3db36415eeb6e9d3b50bfe40ee"
-uuid = "cd4c43a9-7502-52ba-aa6d-59fb2a88580b"
-version = "0.1.0+0"
-
 [[deps.DiffEqBase]]
 deps = ["ArrayInterface", "ConcreteStructs", "DataStructures", "DocStringExtensions", "EnumX", "EnzymeCore", "FastBroadcast", "FastClosures", "ForwardDiff", "FunctionWrappers", "FunctionWrappersWrappers", "LinearAlgebra", "Logging", "Markdown", "MuladdMacro", "Parameters", "PreallocationTools", "PrecompileTools", "Printf", "RecursiveArrayTools", "Reexport", "SciMLBase", "SciMLOperators", "Setfield", "SparseArrays", "Static", "StaticArraysCore", "Statistics", "Tricks", "TruncatedStacktraces"]
 git-tree-sha1 = "d1e8a4642e28b0945bde6e2e1ac569b9e0abd728"

examples/Project.toml

@@ -22,7 +22,6 @@ ClimaUtilities = "b3f4f4ca-9299-4f7f-bd9b-81e1242a7513"
 CloudMicrophysics = "6a9e3e04-43cd-43ba-94b9-e8782df3c71b"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
-Dierckx = "39dd38d3-220a-591b-8e3c-4c3a8c710a94"
 DiffEqBase = "2b5f629d-d688-5b77-993f-72d75c75574e"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 FastGaussQuadrature = "442a2c76-b920-505d-bb47-c5924d526838"

perf/Manifest.toml

@@ -2,7 +2,7 @@
 
 julia_version = "1.10.4"
 manifest_format = "2.0"
-project_hash = "7a92cac99b6b02f9ad635d89d8820baa11d445e7"
+project_hash = "ddcac0ed38fc33b661f9c30ef50fd3e33f33a3e0"
 
 [[deps.ADTypes]]
 git-tree-sha1 = "7a6b285f217ba92b5b474b783b4c2e8cf8218aaa"
@@ -331,7 +331,7 @@ version = "0.5.5"
     GeoMakie = "db073c08-6b98-4ee5-b6a4-5efafb3259c6"
 
 [[deps.ClimaAtmos]]
-deps = ["Adapt", "ArgParse", "ArtifactWrappers", "Artifacts", "AtmosphericProfilesLibrary", "ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaParams", "ClimaTimeSteppers", "ClimaUtilities", "CloudMicrophysics", "Colors", "Dates", "Dierckx", "DiffEqBase", "DocStringExtensions", "FastGaussQuadrature", "Insolation", "Interpolations", "IntervalSets", "Krylov", "LinearAlgebra", "Logging", "NCDatasets", "NVTX", "Pkg", "Printf", "RRTMGP", "Random", "RootSolvers", "SciMLBase", "StaticArrays", "Statistics", "StatsBase", "SurfaceFluxes", "Thermodynamics", "YAML"]
+deps = ["Adapt", "ArgParse", "ArtifactWrappers", "Artifacts", "AtmosphericProfilesLibrary", "ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaParams", "ClimaTimeSteppers", "ClimaUtilities", "CloudMicrophysics", "Colors", "Dates", "DiffEqBase", "DocStringExtensions", "FastGaussQuadrature", "Insolation", "Interpolations", "IntervalSets", "Krylov", "LinearAlgebra", "Logging", "NCDatasets", "NVTX", "Pkg", "Printf", "RRTMGP", "Random", "RootSolvers", "SciMLBase", "StaticArrays", "Statistics", "StatsBase", "SurfaceFluxes", "Thermodynamics", "YAML"]
 path = ".."
 uuid = "b2c96348-7fb7-4fe0-8da9-78d88439e717"
 version = "0.27.0"
@@ -618,18 +618,6 @@ git-tree-sha1 = "9e2f36d3c96a820c678f2f1f1782582fcf685bae"
 uuid = "8bb1440f-4735-579b-a4ab-409b98df4dab"
 version = "1.9.1"
 
-[[deps.Dierckx]]
-deps = ["Dierckx_jll"]
-git-tree-sha1 = "d1ea9f433781bb6ff504f7d3cb70c4782c504a3a"
-uuid = "39dd38d3-220a-591b-8e3c-4c3a8c710a94"
-version = "0.5.3"
-
-[[deps.Dierckx_jll]]
-deps = ["Artifacts", "CompilerSupportLibraries_jll", "JLLWrappers", "Libdl", "Pkg"]
-git-tree-sha1 = "6596b96fe1caff3db36415eeb6e9d3b50bfe40ee"
-uuid = "cd4c43a9-7502-52ba-aa6d-59fb2a88580b"
-version = "0.1.0+0"
-
 [[deps.DiffEqBase]]
 deps = ["ArrayInterface", "ConcreteStructs", "DataStructures", "DocStringExtensions", "EnumX", "EnzymeCore", "FastBroadcast", "FastClosures", "ForwardDiff", "FunctionWrappers", "FunctionWrappersWrappers", "LinearAlgebra", "Logging", "Markdown", "MuladdMacro", "Parameters", "PreallocationTools", "PrecompileTools", "Printf", "RecursiveArrayTools", "Reexport", "SciMLBase", "SciMLOperators", "Setfield", "SparseArrays", "Static", "StaticArraysCore", "Statistics", "Tricks", "TruncatedStacktraces"]
 git-tree-sha1 = "d1e8a4642e28b0945bde6e2e1ac569b9e0abd728"

perf/Project.toml

@@ -22,7 +22,6 @@ ClimaTimeSteppers = "595c0a79-7f3d-439a-bc5a-b232dc3bde79"
 CloudMicrophysics = "6a9e3e04-43cd-43ba-94b9-e8782df3c71b"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
-Dierckx = "39dd38d3-220a-591b-8e3c-4c3a8c710a94"
 DiffEqBase = "2b5f629d-d688-5b77-993f-72d75c75574e"
 DiffEqNoiseProcess = "77a26b50-5914-5dd7-bc55-306e6241c503"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"

regression_tests/ref_counter.jl

@@ -1,6 +1,9 @@
-168
+169
 
 #=
+169:
+- Moved from Dierckx to Interpolations
+
 168: Updated RRTMGP to v0.15.0
 - Updated RRTMGP artifact
 - Split solver into longwave and shortwave solvers

src/initial_conditions/InitialConditions.jl

@@ -26,7 +26,7 @@ import ..Parameters as CAP
 import Thermodynamics as TD
 import AtmosphericProfilesLibrary as APL
 import SciMLBase
-import Dierckx
+import Interpolations as Intp
 import NCDatasets as NC
 
 include("local_state.jl")

src/initial_conditions/initial_conditions.jl

@@ -39,7 +39,10 @@ struct ColumnInterpolatableField{F, D}
     function ColumnInterpolatableField(f::Fields.ColumnField)
         zdata = vec(parent(Fields.Fields.coordinate_field(f).z))
         fdata = vec(parent(f))
-        data = Dierckx.Spline1D(zdata, fdata; k = 1)
+        data = Intp.extrapolate(
+            Intp.interpolate((zdata,), fdata, Intp.Gridded(Intp.Linear())),
+            Intp.Flat(),
+        )
         return new{typeof(f), typeof(data)}(f, data)
     end
 end
@@ -712,7 +715,8 @@ end
 # TODO: Get rid of this
 import AtmosphericProfilesLibrary as APL
 
-const FunctionOrSpline = Union{Dierckx.Spline1D, Function, APL.AbstractProfile}
+const FunctionOrSpline =
+    Union{Function, APL.AbstractProfile, Intp.Extrapolation}
 
 """
     hydrostatic_pressure_profile(; thermo_params, p_0, [T, θ, q_tot, z_max])
@@ -1062,7 +1066,14 @@ function (initial_condition::TRMM_LBA)(params)
         q_v_sat = p_v_sat * (1 / molmass_ratio) / denominator
         return q_v_sat * measured_RH(z) / 100
     end
-    q_tot = Dierckx.Spline1D(measured_z_values, measured_q_tot_values; k = 1)
+    q_tot = Intp.extrapolate(
+        Intp.interpolate(
+            (measured_z_values,),
+            measured_q_tot_values,
+            Intp.Gridded(Intp.Linear()),
+        ),
+        Intp.Flat(),
+    )
 
     p = hydrostatic_pressure_profile(; thermo_params, p_0, T, q_tot)
     u = APL.TRMM_LBA_u(FT)
@@ -1146,7 +1157,10 @@ function (initial_condition::GCMDriven)(params)
     z_gcm = gcm_z(external_forcing_file)
     vars = gcm_initial_conditions(external_forcing_file)
     θ, u, v, q_tot, ρ₀ = map(vars) do value
-        Dierckx.Spline1D(z_gcm, value; k = 1)
+        Intp.extrapolate(
+            Intp.interpolate((z_gcm,), value, Intp.Gridded(Intp.Linear())),
+            Intp.Flat(),
+        )
     end
 
     function local_state(local_geometry)

src/parameterized_tendencies/radiation/radiation.jl

@@ -10,7 +10,7 @@ import .Parameters as CAP
 import RRTMGP
 import .RRTMGPInterface as RRTMGPI
 
-using Dierckx: Spline1D
+import Interpolations
 using StatsBase: mean
 
 
@@ -101,9 +101,13 @@ function radiation_model_cache(
                 vec(mean(reshape(input_data["ozone"][:, :, 1], n, :); dims = 2))
 
             # interpolate the ozone concentrations to our initial pressures
-            pressure2ozone = Spline1D(
-                input_center_pressure,
-                input_center_volume_mixing_ratio_o3,
+            pressure2ozone = Intp.extrapolate(
+                Intp.interpolate(
+                    (input_center_pressure,),
+                    input_center_volume_mixing_ratio_o3,
+                    Intp.Gridded(Intp.Linear()),
+                ),
+                Intp.Flat(),
             )
             if device isa ClimaComms.CUDADevice
                 fv = Fields.field_values(ᶜp)

src/prognostic_equations/forcing/external_forcing.jl

@@ -6,10 +6,13 @@ import Thermodynamics as TD
 import ClimaCore.Spaces as Spaces
 import ClimaCore.Fields as Fields
 import NCDatasets as NC
-import Dierckx
+import Interpolations as Intp
 
 function interp_vertical_prof(x, xp, fp)
-    spl = Dierckx.Spline1D(xp, fp; k = 1)
+    spl = Intp.extrapolate(
+        Intp.interpolate((xp,), fp, Intp.Gridded(Intp.Linear())),
+        Intp.Flat(),
+    )
     return spl(vec(x))
 end
 

src/solver/type_getters.jl

@@ -1,6 +1,5 @@
 using Adapt
 using Dates: DateTime, @dateformat_str
-using Dierckx
 using Interpolations
 import NCDatasets
 import ClimaUtilities.OutputPathGenerator

src/surface_conditions/SurfaceConditions.jl

@@ -20,7 +20,7 @@ import ClimaCore.Geometry: ⊗
 import SurfaceFluxes as SF
 import Thermodynamics as TD
 
-import Dierckx
+import Interpolations
 import StaticArrays as SA
 import Statistics: mean
 import NCDatasets as NC

src/surface_conditions/surface_setups.jl

@@ -142,9 +142,14 @@ function (::ARM_SGP)(params)
     thermo_params = CAP.thermodynamics_params(params)
     ts = TD.PhaseNonEquil_pθq(thermo_params, p, θ, TD.PhasePartition(q_vap))
     T = TD.air_temperature(thermo_params, ts)
-    shf = FT.(Dierckx.Spline1D(t_data, shf_data; k = 1))
-    lhf = FT.(Dierckx.Spline1D(t_data, lhf_data; k = 1))
-    # TODO: Replace Dierckx with a type-stable interpolation and remove the FT.
+    shf = Intp.extrapolate(
+        Intp.interpolate((t_data,), shf_data, Intp.Gridded(Intp.Linear())),
+        Intp.Flat(),
+    )
+    lhf = Intp.extrapolate(
+        Intp.interpolate(t_data, lhf_data, Intp.Gridded(Intp.Linear())),
+        Intp.Flat(),
+    )
     function surface_state(surface_coordinates, interior_z, t)
         fluxes = HeatFluxes(; shf = shf(t), lhf = lhf(t))
         parameterization = MoninObukhov(; z0, fluxes, ustar)

test/Project.toml

@@ -19,7 +19,6 @@ ClimaTimeSteppers = "595c0a79-7f3d-439a-bc5a-b232dc3bde79"
 CloudMicrophysics = "6a9e3e04-43cd-43ba-94b9-e8782df3c71b"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
-Dierckx = "39dd38d3-220a-591b-8e3c-4c3a8c710a94"
 DiffEqBase = "2b5f629d-d688-5b77-993f-72d75c75574e"
 DiffEqCallbacks = "459566f4-90b8-5000-8ac3-15dfb0a30def"
 DiffEqNoiseProcess = "77a26b50-5914-5dd7-bc55-306e6241c503"
@@ -72,7 +71,6 @@ ClimaCorePlots = "0.2"
 ClimaCoreSpectra = "0.1"
 ClimaCoreTempestRemap = "0.3"
 ClimaCoreVTK = "0.7"
-Dierckx = "0.5"
 DiffEqNoiseProcess = "5"
 ForwardDiff = "0.10"
 Glob = "1"