From 75f6145659b8908fc3aa1718da12f878b1af1809 Mon Sep 17 00:00:00 2001 From: Gabriele Bozzola Date: Wed, 28 Aug 2024 16:57:03 -0700 Subject: [PATCH] Move extensions to better namespace Extensions could have name collisions, adding ClimaAnalysis in front dramatically reduces the likelihood and follows conventions. --- Project.toml | 4 +- ext/ClimaAnalysisGeoMakieExt.jl | 2 +- ext/{MakieExt.jl => ClimaAnalysisMakieExt.jl} | 2 +- ext/GeoMakieExt.jl | 202 ------------------ 4 files changed, 4 insertions(+), 206 deletions(-) rename ext/{MakieExt.jl => ClimaAnalysisMakieExt.jl} (99%) delete mode 100644 ext/GeoMakieExt.jl diff --git a/Project.toml b/Project.toml index e08d7b0..f874b15 100644 --- a/Project.toml +++ b/Project.toml @@ -18,8 +18,8 @@ GeoMakie = "db073c08-6b98-4ee5-b6a4-5efafb3259c6" Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a" [extensions] -GeoMakieExt = "GeoMakie" -MakieExt = "Makie" +ClimaAnalysisGeoMakieExt = "GeoMakie" +ClimaAnalysisMakieExt = "Makie" [compat] Aqua = "0.8" diff --git a/ext/ClimaAnalysisGeoMakieExt.jl b/ext/ClimaAnalysisGeoMakieExt.jl index d1f20d0..9edf4ee 100644 --- a/ext/ClimaAnalysisGeoMakieExt.jl +++ b/ext/ClimaAnalysisGeoMakieExt.jl @@ -1,4 +1,4 @@ -module ClimaAnalysisGeoMakieExt +module GeoMakieExt import GeoMakie import GeoMakie: Makie diff --git a/ext/MakieExt.jl b/ext/ClimaAnalysisMakieExt.jl similarity index 99% rename from ext/MakieExt.jl rename to ext/ClimaAnalysisMakieExt.jl index 763c918..c2d1dfc 100644 --- a/ext/MakieExt.jl +++ b/ext/ClimaAnalysisMakieExt.jl @@ -1,4 +1,4 @@ -module MakieExt +module ClimaAnalysisMakieExt import Makie import ClimaAnalysis diff --git a/ext/GeoMakieExt.jl b/ext/GeoMakieExt.jl deleted file mode 100644 index 012e690..0000000 --- a/ext/GeoMakieExt.jl +++ /dev/null @@ -1,202 +0,0 @@ -module GeoMakieExt - -import GeoMakie -import GeoMakie: Makie -import ClimaAnalysis -import ClimaAnalysis: Visualize - -MakiePlace = Union{Makie.Figure, Makie.GridLayout} - -function _geomakie_plot_on_globe!( - place::MakiePlace, - var::ClimaAnalysis.OutputVar; - p_loc = (1, 1), - plot_coastline = true, - plot_colorbar = true, - more_kwargs = Dict( - :plot => Dict(), - :cb => Dict(), - :axis => Dict(), - :coast => Dict(:color => :black), - ), - plot_fn = Makie.surface!, -) - length(var.dims) == 2 || error("Can only plot 2D variables") - - lon_name = "" - lat_name = "" - - for dim in var.index2dim - if dim in ClimaAnalysis.Var.LONGITUDE_NAMES - lon_name = dim - elseif dim in ClimaAnalysis.Var.LATITUDE_NAMES - lat_name = dim - else - error("$dim is neither longitude nor latitude") - end - end - - lon = var.dims[lon_name] - lat = var.dims[lat_name] - - units = var.attributes["units"] - short_name = var.attributes["short_name"] - colorbar_label = "$short_name [$units]" - - axis_kwargs = get(more_kwargs, :axis, Dict()) - plot_kwargs = get(more_kwargs, :plot, Dict()) - cb_kwargs = get(more_kwargs, :cb, Dict()) - coast_kwargs = get(more_kwargs, :coast, Dict(:color => :black)) - - var.attributes["long_name"] = - ClimaAnalysis.Utils.warp_string(var.attributes["long_name"]) - - title = get(axis_kwargs, :title, var.attributes["long_name"]) - - GeoMakie.GeoAxis(place[p_loc...]; title, axis_kwargs...) - - plot = plot_fn(lon, lat, var.data; plot_kwargs...) - plot_coastline && Makie.lines!(GeoMakie.coastlines(); coast_kwargs...) - - if plot_colorbar - p_loc_cb = Tuple([p_loc[1], p_loc[2] + 1]) - Makie.Colorbar( - place[p_loc_cb...], - plot, - label = colorbar_label; - cb_kwargs..., - ) - end -end - -""" - heatmap2D_on_globe!(fig::Makie.Figure, - var::ClimaAnalysis.OutputVar; - p_loc = (1,1), - plot_coastline = true, - plot_colorbar = true, - more_kwargs) - heatmap2D_on_globe!(grid_layout::Makie.GridLayout, - var::ClimaAnalysis.OutputVar; - p_loc = (1,1), - plot_coastline = true, - plot_colorbar = true, - more_kwargs) - - -Plot a heatmap of the given 2D `var`iable on a projected geoid. - -The plot comes with labels, units, and a colorbar. - -This function assumes that the following attributes are available: -- long_name -- short_name -- units - -The dimensions have to be longitude and latitude. - -Additional arguments to the plotting and axis functions -======================================================= - -`more_kwargs` can be a dictionary that maps symbols to additional options for: -- the axis (`:axis`) -- the plotting function (`:plot`) -- the colorbar (`:cb`) -- the coastline (`:coast`) - -The coastline is plotted from `GeoMakie.coastline` using the `lines!` plotting function. - -The values are splatted in the relevant functions. Populate them with a -Dictionary of `Symbol`s => values to pass additional options. -""" -function Visualize.heatmap2D_on_globe!( - place::MakiePlace, - var::ClimaAnalysis.OutputVar; - p_loc = (1, 1), - plot_coastline = true, - plot_colorbar = true, - more_kwargs = Dict( - :plot => Dict(), - :cb => Dict(), - :axis => Dict(), - :coast => Dict(:color => :black), - ), -) - return _geomakie_plot_on_globe!( - place, - var; - p_loc, - plot_coastline, - plot_colorbar, - more_kwargs, - plot_fn = Makie.surface!, - ) -end - -""" - contours2D_on_globe!(fig::Makie.Figure, - var::ClimaAnalysis.OutputVar; - p_loc = (1,1), - plot_coastline = true, - plot_colorbar = true, - plot_contours = true, - more_kwargs) - contours2D_on_globe!(grid_layout::Makie.GridLayout, - var::ClimaAnalysis.OutputVar; - p_loc = (1,1), - plot_coastline = true, - plot_colorbar = true, - plot_contours = true, - more_kwargs) - - -Plot discrete contours of the given 2D `var`iable on a projected geoid. - -The plot comes with labels, units, and a colorbar. - -This function assumes that the following attributes are available: -- long_name -- short_name -- units - -The dimensions have to be longitude and latitude. - -Additional arguments to the plotting and axis functions -======================================================= - -`more_kwargs` can be a dictionary that maps symbols to additional options for: -- the axis (`:axis`) -- the plotting function (`:plot`) -- the colorbar (`:cb`) -- the coastline (`:coast`) - -The coastline is plotted from `GeoMakie.coastline` using the `lines!` plotting function. - -The values are splatted in the relevant functions. Populate them with a -Dictionary of `Symbol`s => values to pass additional options. -""" -function Visualize.contour2D_on_globe!( - place::MakiePlace, - var::ClimaAnalysis.OutputVar; - p_loc = (1, 1), - plot_coastline = true, - plot_colorbar = true, - more_kwargs = Dict( - :plot => Dict(), - :cb => Dict(), - :axis => Dict(), - :coast => Dict(:color => :black), - ), -) - _geomakie_plot_on_globe!( - place, - var; - p_loc, - plot_coastline, - plot_colorbar, - more_kwargs, - plot_fn = Makie.contourf!, - ) -end - -end