From 555324d03a316902ee43f7ffb017e3108dc5cb2f Mon Sep 17 00:00:00 2001 From: AtilaSaraiva Date: Fri, 21 Feb 2025 15:57:11 -0700 Subject: [PATCH 1/2] docs: fixing docstrings with wrong names of plotting recipe functions --- src/Recipes/SeisAmplitudeRecipe.jl | 8 ++++---- src/Recipes/SeisFKRecipe.jl | 8 ++++---- src/Recipes/SeisImageRecipe.jl | 8 ++++---- src/Recipes/SeisOverlayRecipe.jl | 8 ++++---- src/Recipes/SeisWiggleRecipe.jl | 8 ++++---- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/Recipes/SeisAmplitudeRecipe.jl b/src/Recipes/SeisAmplitudeRecipe.jl index ad7718f..60b75cc 100644 --- a/src/Recipes/SeisAmplitudeRecipe.jl +++ b/src/Recipes/SeisAmplitudeRecipe.jl @@ -1,6 +1,6 @@ """ - seisamplitude(d; ) - seisamplitude!(ax, d; ) + seisamplitudeplot(d; ) + seisamplitudeplot!(ax, d; ) Plot amplitude-frequency 2D seismic data `d`. @@ -19,11 +19,11 @@ Plot amplitude-frequency 2D seismic data `d`. # Examples ```julia julia> d = SeisLinearEvents(); -julia> f, ax, amp = seisamplitude(d) +julia> f, ax, amp = seisamplitudeplot(d) ``` ```julia julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f) -julia> amp = seisamplitude!(ax, d) +julia> amp = seisamplitudeplot!(ax, d) ``` Author: Firas Al Chalabi (2024) diff --git a/src/Recipes/SeisFKRecipe.jl b/src/Recipes/SeisFKRecipe.jl index 7d59e5c..e7a2f4c 100644 --- a/src/Recipes/SeisFKRecipe.jl +++ b/src/Recipes/SeisFKRecipe.jl @@ -1,6 +1,6 @@ """ - seisfk(d; ) - seisfk!(ax, d; ) + seisfkplot(d; ) + seisfkplot!(ax, d; ) Plot frequency-wavenumber 2D seismic data `d`. @@ -26,11 +26,11 @@ Return the figure and axis corresponding to d. # Examples ```julia julia> d = SeisLinearEvents(); -julia> f, ax, fk = seisfk(d) +julia> f, ax, fk = seisfkplot(d) ``` ```julia julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f) -julia> fk = seisfk!(ax, d) +julia> fk = seisfkplot!(ax, d) ``` Author: Firas Al Chalabi (2024) diff --git a/src/Recipes/SeisImageRecipe.jl b/src/Recipes/SeisImageRecipe.jl index 96a0b68..5d77ce2 100644 --- a/src/Recipes/SeisImageRecipe.jl +++ b/src/Recipes/SeisImageRecipe.jl @@ -1,6 +1,6 @@ """ - seisimage(d; ); - seisimage!(ax, d; ); + seisimageplot(d; ); + seisimageplot!(ax, d; ); Recipe to plot time-space, color plot of 2D seismic data `d`. @@ -22,11 +22,11 @@ Recipe to plot time-space, color plot of 2D seismic data `d`. # Examples ```julia julia> d = SeisLinearEvents(); -julia> f, ax, img = seisimage(d) +julia> f, ax, img = seisimageplot(d) ``` ```julia julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f) -julia> img = seisimage!(ax, d) +julia> img = seisimageplot!(ax, d) ``` Author: Firas Al Chalabi (2024) diff --git a/src/Recipes/SeisOverlayRecipe.jl b/src/Recipes/SeisOverlayRecipe.jl index eec51ed..3bd334a 100644 --- a/src/Recipes/SeisOverlayRecipe.jl +++ b/src/Recipes/SeisOverlayRecipe.jl @@ -1,6 +1,6 @@ """ - seisoverlay(d; ) - seisoverlay!(ax, d; ) + seisoverlayplot(d; ) + seisoverlayplot!(ax, d; ) Recipe to plot time-space, overlay plot of 2D seismic data `d`. @@ -27,11 +27,11 @@ Recipe to plot time-space, overlay plot of 2D seismic data `d`. # Examples ```julia julia> d = SeisLinearEvents(); -julia> f, ax, ov = seisoverlay(d) +julia> f, ax, ov = seisoverlayplot(d) ``` ```julia julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f) -julia> ov = seisoverlay!(ax, d) +julia> ov = seisoverlayplot!(ax, d) ``` """ @recipe(SeisOverlayPlot, d) do scene diff --git a/src/Recipes/SeisWiggleRecipe.jl b/src/Recipes/SeisWiggleRecipe.jl index 7934703..953fcfd 100644 --- a/src/Recipes/SeisWiggleRecipe.jl +++ b/src/Recipes/SeisWiggleRecipe.jl @@ -1,6 +1,6 @@ """ - seiswiggle(d; ) - seiswiggle!(ax, d; ) + seiswiggleplot(d; ) + seiswiggleplot!(ax, d; ) Recipe to plot time-space, wiggle plot of 2D seismic data `d`. @@ -24,11 +24,11 @@ Recipe to plot time-space, wiggle plot of 2D seismic data `d`. # Examples ```julia julia> d = SeisLinearEvents(); -julia> f, ax, wp = seiswiggle(d) +julia> f, ax, wp = seiswiggleplot(d) ``` ```julia julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f) -julia> wp = seiswiggle!(ax, d) +julia> wp = seiswiggleplot!(ax, d) ``` **Note: animations only work with this recipe if you update the observable `d` From fc5dcde24e8e6b804e578951bd0f6a2271889282 Mon Sep 17 00:00:00 2001 From: AtilaSaraiva Date: Fri, 21 Feb 2025 16:03:52 -0700 Subject: [PATCH 2/2] env: updating the package version along with its dependencies --- Project.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Project.toml b/Project.toml index 43ca704..11ca4ec 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "SeisMakie" uuid = "1618359f-28d0-421c-9c3d-0705aaf8cc0d" authors = ["Firas ", "Átila "] -version = "0.2.0" +version = "0.2.1" [deps] FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341" @@ -10,7 +10,7 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2" [compat] FFTW = "1" -Makie = "0.20, 0.21" +Makie = "0.20, 0.21, 0.22" Statistics = "1" julia = "1"