Default global plots using simulation struct (#1199)

Author: kmdeck

.buildkite/Manifest-v1.11.toml

@@ -2,7 +2,7 @@
 
 julia_version = "1.11.6"
 manifest_format = "2.0"
-project_hash = "acaaffaaac229b13d375a67bbaf146c0a0ce520e"
+project_hash = "55c55a1c8b475869d4bb069be5aa7bbf8ba540bb"
 
 [[deps.ADTypes]]
 git-tree-sha1 = "be7ae030256b8ef14a441726c4c37766b90b93a3"
@@ -481,10 +481,11 @@ deps = ["ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaTimeSteppers", "Cli
 path = ".."
 uuid = "08f4d4ce-cf43-44bb-ad95-9d2d5f413532"
 version = "0.17.1"
-weakdeps = ["BSON", "CSV", "ClimaParams", "DataFrames", "Flux", "HTTP", "StatsBase"]
+weakdeps = ["BSON", "CSV", "CairoMakie", "ClimaAnalysis", "ClimaParams", "DataFrames", "Flux", "GeoMakie", "HTTP", "Poppler_jll", "Printf", "StatsBase"]
 
     [deps.ClimaLand.extensions]
     CreateParametersExt = "ClimaParams"
+    LandSimulationVisualization = ["CairoMakie", "ClimaAnalysis", "GeoMakie", "Poppler_jll", "Printf", "StatsBase"]
     NeuralSnowExt = ["CSV", "DataFrames", "HTTP", "Flux", "StatsBase", "BSON"]
 
 [[deps.ClimaParams]]

.buildkite/Manifest.toml

@@ -1,8 +1,8 @@
 # This file is machine-generated - editing it directly is not advised
 
-julia_version = "1.10.9"
+julia_version = "1.10.10"
 manifest_format = "2.0"
-project_hash = "44a3a750b9b826bdab27f20cf41681e6b0e9e450"
+project_hash = "3f0124403c94b3ee688b94982d79b9dea53973ab"
 
 [[deps.ADTypes]]
 git-tree-sha1 = "be7ae030256b8ef14a441726c4c37766b90b93a3"
@@ -478,10 +478,11 @@ deps = ["ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaTimeSteppers", "Cli
 path = ".."
 uuid = "08f4d4ce-cf43-44bb-ad95-9d2d5f413532"
 version = "0.17.1"
-weakdeps = ["BSON", "CSV", "ClimaParams", "DataFrames", "Flux", "HTTP", "StatsBase"]
+weakdeps = ["BSON", "CSV", "CairoMakie", "ClimaAnalysis", "ClimaParams", "DataFrames", "Flux", "GeoMakie", "HTTP", "Poppler_jll", "Printf", "StatsBase"]
 
     [deps.ClimaLand.extensions]
     CreateParametersExt = "ClimaParams"
+    LandSimulationVisualization = ["CairoMakie", "ClimaAnalysis", "GeoMakie", "Poppler_jll", "Printf", "StatsBase"]
     NeuralSnowExt = ["CSV", "DataFrames", "HTTP", "Flux", "StatsBase", "BSON"]
 
 [[deps.ClimaParams]]
@@ -2246,7 +2247,7 @@ version = "2.5.4+0"
 [[deps.OpenLibm_jll]]
 deps = ["Artifacts", "Libdl"]
 uuid = "05823500-19ac-5b8b-9628-191a04bc5112"
-version = "0.8.1+4"
+version = "0.8.5+0"
 
 [[deps.OpenMPI_jll]]
 deps = ["Artifacts", "CompilerSupportLibraries_jll", "Hwloc_jll", "JLLWrappers", "LazyArtifacts", "Libdl", "MPIPreferences", "TOML", "Zlib_jll"]

.buildkite/Project.toml

@@ -32,6 +32,7 @@ MPI = "da04e1cc-30fd-572f-bb4f-1f8673147195"
 NCDatasets = "85f8d34a-cbdd-5861-8df4-14fed0d494ab"
 NLsolve = "2774e3e8-f4cf-5e23-947b-6d7e65073b56"
 Poppler_jll = "9c32591e-4766-534b-9725-b71a8799265b"
+Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 ProfileCanvas = "efd6af41-a80b-495e-886c-e51b0c7d77a3"
 RootSolvers = "7181ea78-2dcb-4de3-ab41-2b8ab5a31e74"
 SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"

.github/workflows/downgrade.yml

@@ -29,6 +29,6 @@ jobs:
       - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-downgrade-compat@v1
         with:
-          skip: Dates, LazyArtifacts, LinearAlgebra, Test, Statistics
+          skip: Dates, LazyArtifacts, LinearAlgebra, Test, Statistics, Printf
       - uses: julia-actions/julia-buildpkg@latest
       - uses: julia-actions/julia-runtest@latest

NEWS.md

@@ -3,6 +3,7 @@ ClimaLand.jl Release Notes
 
 main
 -------
+- Create the extension LandSimulationsVisualization  PR[#1199](https://github.com/CliMA/ClimaLand.jl/pull/1199)
 
 v0.17.1
 -------

Project.toml

@@ -25,19 +25,27 @@ Thermodynamics = "b60c26fb-14c3-4610-9d3e-2d17fe7ff00c"
 [weakdeps]
 BSON = "fbb218c0-5317-5bc6-957e-2ee96dd4b1f0"
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
+ClimaAnalysis = "29b5916a-a76c-4e73-9657-3c8fd22e65e6"
 ClimaParams = "5c42b081-d73a-476f-9059-fd94b934656c"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"
+GeoMakie = "db073c08-6b98-4ee5-b6a4-5efafb3259c6"
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
+Poppler_jll = "9c32591e-4766-534b-9725-b71a8799265b"
+Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 
 [extensions]
 CreateParametersExt = "ClimaParams"
+LandSimulationVisualization = ["CairoMakie", "ClimaAnalysis", "GeoMakie", "Poppler_jll", "Printf", "StatsBase"]
 NeuralSnowExt = ["CSV", "DataFrames", "HTTP", "Flux", "StatsBase", "BSON"]
 
 [compat]
 BSON = "0.3.9"
+CairoMakie = "0.12"
 CSV = "0.10.14"
+ClimaAnalysis = "0.5.17"
 ClimaComms = "0.6.2"
 ClimaCore = "0.14.23"
 ClimaDiagnostics = "0.2.10"
@@ -48,13 +56,16 @@ DataFrames = "1.4"
 Dates = "1"
 DocStringExtensions = "0.9"
 Flux = "0.15, 0.16"
+GeoMakie = "< 0.7.13"
 HTTP = "1.10"
 Insolation = "0.9.2"
 Interpolations = "0.15.1, 0.16"
 LazyArtifacts = "1"
 LazyBroadcast = "1.0.0"
 LinearAlgebra = "1"
 NCDatasets = "0.14"
+Poppler_jll = "24"
+Printf = "1"
 SciMLBase = "2.53"
 StaticArrays = "1.6"
 StatsBase = "0.34"

docs/Manifest-v1.11.toml

@@ -1,6 +1,6 @@
 # This file is machine-generated - editing it directly is not advised
 
-julia_version = "1.11.5"
+julia_version = "1.11.6"
 manifest_format = "2.0"
 project_hash = "53eaaa3557cec5df76ee8d7b9a7b00e0b499fc9f"
 
@@ -404,12 +404,26 @@ deps = ["ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaTimeSteppers", "Cli
 path = ".."
 uuid = "08f4d4ce-cf43-44bb-ad95-9d2d5f413532"
 version = "0.17.1"
-weakdeps = ["BSON", "CSV", "ClimaParams", "DataFrames", "Flux", "HTTP", "StatsBase"]
 
     [deps.ClimaLand.extensions]
     CreateParametersExt = "ClimaParams"
+    LandSimulationVisualization = ["CairoMakie", "ClimaAnalysis", "GeoMakie", "Poppler_jll", "Printf", "StatsBase"]
     NeuralSnowExt = ["CSV", "DataFrames", "HTTP", "Flux", "StatsBase", "BSON"]
 
+    [deps.ClimaLand.weakdeps]
+    BSON = "fbb218c0-5317-5bc6-957e-2ee96dd4b1f0"
+    CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+    CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
+    ClimaAnalysis = "29b5916a-a76c-4e73-9657-3c8fd22e65e6"
+    ClimaParams = "5c42b081-d73a-476f-9059-fd94b934656c"
+    DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+    Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"
+    GeoMakie = "db073c08-6b98-4ee5-b6a4-5efafb3259c6"
+    HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
+    Poppler_jll = "9c32591e-4766-534b-9725-b71a8799265b"
+    Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+    StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
+
 [[deps.ClimaLandSimulations]]
 deps = ["Bonito", "CairoMakie", "ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaLand", "ClimaParams", "ClimaTimeSteppers", "ClimaUtilities", "DataFrames", "Dates", "DelimitedFiles", "Format", "HTTP", "Insolation", "Interpolations", "InverseFunctions", "JSON", "LaTeXStrings", "MutableArithmetics", "NLsolve", "PlotUtils", "RootSolvers", "SciMLBase", "StaticArrays", "Statistics", "StatsBase", "SurfaceFluxes", "Thermodynamics", "Unitful", "UnitfulMoles", "WGLMakie"]
 path = "../lib/ClimaLandSimulations"

docs/Manifest.toml

@@ -1,6 +1,6 @@
 # This file is machine-generated - editing it directly is not advised
 
-julia_version = "1.10.9"
+julia_version = "1.10.10"
 manifest_format = "2.0"
 project_hash = "0e313427333375504d76ddc31cd582bee13918ac"
 
@@ -407,12 +407,26 @@ deps = ["ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaTimeSteppers", "Cli
 path = ".."
 uuid = "08f4d4ce-cf43-44bb-ad95-9d2d5f413532"
 version = "0.17.1"
-weakdeps = ["BSON", "CSV", "ClimaParams", "DataFrames", "Flux", "HTTP", "StatsBase"]
 
     [deps.ClimaLand.extensions]
     CreateParametersExt = "ClimaParams"
+    LandSimulationVisualization = ["CairoMakie", "ClimaAnalysis", "GeoMakie", "Poppler_jll", "Printf", "StatsBase"]
     NeuralSnowExt = ["CSV", "DataFrames", "HTTP", "Flux", "StatsBase", "BSON"]
 
+    [deps.ClimaLand.weakdeps]
+    BSON = "fbb218c0-5317-5bc6-957e-2ee96dd4b1f0"
+    CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+    CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
+    ClimaAnalysis = "29b5916a-a76c-4e73-9657-3c8fd22e65e6"
+    ClimaParams = "5c42b081-d73a-476f-9059-fd94b934656c"
+    DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+    Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"
+    GeoMakie = "db073c08-6b98-4ee5-b6a4-5efafb3259c6"
+    HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
+    Poppler_jll = "9c32591e-4766-534b-9725-b71a8799265b"
+    Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+    StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
+
 [[deps.ClimaLandSimulations]]
 deps = ["Bonito", "CairoMakie", "ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaLand", "ClimaParams", "ClimaTimeSteppers", "ClimaUtilities", "DataFrames", "Dates", "DelimitedFiles", "Format", "HTTP", "Insolation", "Interpolations", "InverseFunctions", "JSON", "LaTeXStrings", "MutableArithmetics", "NLsolve", "PlotUtils", "RootSolvers", "SciMLBase", "StaticArrays", "Statistics", "StatsBase", "SurfaceFluxes", "Thermodynamics", "Unitful", "UnitfulMoles", "WGLMakie"]
 path = "../lib/ClimaLandSimulations"
@@ -2172,7 +2186,7 @@ version = "3.2.4+0"
 [[deps.OpenLibm_jll]]
 deps = ["Artifacts", "Libdl"]
 uuid = "05823500-19ac-5b8b-9628-191a04bc5112"
-version = "0.8.1+4"
+version = "0.8.5+0"
 
 [[deps.OpenMPI_jll]]
 deps = ["Artifacts", "CompilerSupportLibraries_jll", "Hwloc_jll", "JLLWrappers", "LazyArtifacts", "Libdl", "MPIPreferences", "TOML", "Zlib_jll"]

experiments/long_runs/bucket.jl

@@ -19,8 +19,6 @@ import Interpolations
 import ClimaUtilities.TimeVaryingInputs:
     TimeVaryingInput, LinearInterpolation, PeriodicCalendar
 import ClimaUtilities.TimeManager: ITime
-using ClimaAnalysis
-import ClimaAnalysis.Visualize as viz
 using ClimaUtilities
 import ClimaUtilities.ClimaArtifacts: @clima_artifact
 import ClimaParams as CP
@@ -32,12 +30,15 @@ import ClimaLand.Parameters as LP
 
 import ClimaLand.Simulations: LandSimulation, solve!
 using Statistics
-import GeoMakie
-using CairoMakie
 using Dates
 import NCDatasets
 
-using Poppler_jll: pdfunite
+using CairoMakie, GeoMakie, Poppler_jll, ClimaAnalysis
+LandSimVis =
+    Base.get_extension(
+        ClimaLand,
+        :LandSimulationVisualization,
+    ).LandSimulationVisualization;
 
 const FT = Float64;
 time_interpolation_method = LinearInterpolation(PeriodicCalendar())
@@ -92,85 +93,76 @@ function setup_model(FT, start_date, domain, earth_param_set, bucket_params)
     return bucket
 end
 
-function setup_simulation(; greet = false)
-    Δt = 900.0
-    start_date = DateTime(2008)
-    stop_date = DateTime(2010)
-    nelements = (101, 7)
-    if greet
-        @info "Run: Global Bucket Model"
-        @info "Resolution: $nelements"
-        @info "Timestep: $Δt s"
-        @info "Start Date: $start_date"
-        @info "Stop Date: $stop_date"
-    end
-    # Domain
-    depth = FT(3.5)
-    dz_tuple = FT.((1.0, 0.05))
-    domain =
-        ClimaLand.Domains.global_domain(FT; context, nelements, depth, dz_tuple)
-
-    # Parameters
-    params = LP.LandParameters(FT)
-    σS_c = FT(0.2)
-    W_f = FT(0.2)
-    z_0m = FT(1e-3)
-    z_0b = FT(1e-3)
-    κ_soil = FT(1.5)
-    ρc_soil = FT(2e6)
-    τc = FT(float(Δt))
-    α_snow = FT(0.8)
-    depth = FT(3.5)
-    bucket_params = (; σS_c, W_f, z_0m, z_0b, κ_soil, ρc_soil, τc, α_snow)
-
-    # Model
-    model = setup_model(FT, start_date, domain, params, bucket_params)
-
-    # IC function
-    function set_ic!(Y, p, t, bucket)
-        temp_anomaly_amip(coord) = 40 * cosd(coord.lat)^4
-        # Set temperature IC including anomaly, based on atmospheric setup
-        T_sfc_0 = 271.0
-        cds = ClimaCore.Fields.coordinate_field(Y.bucket.T)
-        @. Y.bucket.T = T_sfc_0 + temp_anomaly_amip(cds)
-        Y.bucket.W .= 0.15
-        Y.bucket.Ws .= 0.0
-        Y.bucket.σS .= 0.0
-    end
-
-    # Define timestepper and ODE algorithm
-    timestepper = CTS.RK4()
-    timestepper = CTS.ExplicitAlgorithm(timestepper)
-
-    # Create the simulation
-    simulation = LandSimulation(
-        FT,
-        start_date,
-        stop_date,
-        Δt,
-        model;
-        set_ic!,
-        timestepper,
-        outdir,
-    )
-    return simulation
+Δt = 900.0
+start_date = DateTime(2008)
+stop_date = DateTime(2010)
+nelements = (101, 7)
+@info "Run: Global Bucket Model"
+@info "Resolution: $nelements"
+@info "Timestep: $Δt s"
+@info "Start Date: $start_date"
+@info "Stop Date: $stop_date"
+# Domain
+depth = FT(3.5)
+dz_tuple = FT.((1.0, 0.05))
+domain =
+    ClimaLand.Domains.global_domain(FT; context, nelements, depth, dz_tuple)
+
+# Parameters
+params = LP.LandParameters(FT)
+σS_c = FT(0.2)
+W_f = FT(0.2)
+z_0m = FT(1e-3)
+z_0b = FT(1e-3)
+κ_soil = FT(1.5)
+ρc_soil = FT(2e6)
+τc = FT(float(Δt))
+α_snow = FT(0.8)
+depth = FT(3.5)
+bucket_params = (; σS_c, W_f, z_0m, z_0b, κ_soil, ρc_soil, τc, α_snow)
+
+# Model
+model = setup_model(FT, start_date, domain, params, bucket_params)
+
+# IC function
+function set_ic!(Y, p, t, bucket)
+    temp_anomaly_amip(coord) = 40 * cosd(coord.lat)^4
+    # Set temperature IC including anomaly, based on atmospheric setup
+    T_sfc_0 = 271.0
+    cds = ClimaCore.Fields.coordinate_field(Y.bucket.T)
+    @. Y.bucket.T = T_sfc_0 + temp_anomaly_amip(cds)
+    Y.bucket.W .= 0.15
+    Y.bucket.Ws .= 0.0
+    Y.bucket.σS .= 0.0
 end
 
-simulation = setup_simulation(; greet = true);
+# Define timestepper and ODE algorithm
+timestepper = CTS.RK4()
+timestepper = CTS.ExplicitAlgorithm(timestepper)
+
+# Create the simulation
+simulation = LandSimulation(
+    FT,
+    start_date,
+    stop_date,
+    Δt,
+    model;
+    set_ic!,
+    timestepper,
+    outdir,
+)
+@info "Run: Global Bucket Model"
+@info "Resolution: $nelements"
+@info "Timestep: $Δt s"
+@info "Start Date: $start_date"
+@info "Stop Date: $stop_date"
 solve!(simulation);
 
-# Eventually replace the below with:
-#ClimaLand.Simulations.plot!(simulation, simulation.model, simulation.domain)
-
-# read in diagnostics and make some plots!
-#### ClimaAnalysis ####
 short_names = ["tsfc", "lhf", "shf", "wsoil"]
-include(
-    joinpath(
-        pkgdir(ClimaLand),
-        "experiments",
-        "long_runs",
-        "figures_function.jl",
-    ),
+LandSimVis.make_annual_timeseries(simulation; savedir = root_path, short_names)
+LandSimVis.make_heatmaps(
+    simulation;
+    savedir = root_path,
+    short_names,
+    date = stop_date,
 )
-make_figures(root_path, outdir, short_names)