Using extentions instead of requires.jl

Author: mauro3

Project.toml

@@ -1,16 +1,21 @@
 name = "WhereTheWaterFlows"
 uuid = "ea906314-1493-4d22-a0af-f886a20c9fba"
 authors = ["Mauro Werder <[email protected]>"]
-version = "0.8.1"
+version = "0.9.1"
 
 [deps]
-Requires = "ae029012-a4dd-5104-9daa-d747884805df"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 
+[weakdeps]
+PyPlot = "d330b81b-6aea-500a-939a-2ce795aea3ee"
+
+[extensions]
+PyPlotExt = "PyPlot"
+
 [compat]
-Requires = "0.5.2, 1.0"
 StaticArrays = "0.11.1, 0.12, 1.0"
-julia = "1.1"
+PyPlot = "2"
+julia = "1.9"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

README.md

@@ -36,29 +36,29 @@ x,y,dem = peaks2(200)
 area, slen, dir, nout, nin, pits, c, bnds = waterflows(dem)
 
 # log-upslope area as well as pits (sinks)
-WWF.plotarea(x, y, area, pits)
+WWF.plt.plotarea(x, y, area, pits)
 
 # log-upslope area over contours of the dem
-WWF.plotarea_dem(x, y, dem, area, pits)
+WWF.plt.plotarea_dem(x, y, dem, area, pits)
 
 # catchments
 figure()
-WWF.heatmap(x,y,c)
+WWF.plt.heatmap(x,y,c)
 
 # A single catchment of some point.  Choose one with large catchment:
 i, j = 50, findmax(area[50,:])[2]
 cc = catchment(dir, CartesianIndex(i,j))
-WWF.heatmap(x,y,cc)
+WWF.plt.heatmap(x,y,cc)
 plot(x[i], y[j], "<r", ms=10)
 
 # stream length
 figure()
-WWF.heatmap(x,y,slen)
+WWF.plt.heatmap(x,y,slen)
 
 demf = fill_dem(dem, pits, dir)
 # "lake-depth"
 figure()
-WWF.heatmap(x,y,demf.-dem)
+WWF.plt.heatmap(x,y,demf.-dem)
 ```
 
 In the `example/` folder there are two more complicated examples.  One

examples/example.jl

@@ -9,7 +9,7 @@ if !(@isdefined WWF)
     const WWF = WhereTheWaterFlows
 end
 
-"A artificial DEM"
+"An artificial DEM"
 function ele(x, y; withpit=false, randfac=0.0)
     out = - (x^2 - 1)^2 - (x^2*y - x - 1)^2 + 6 + 0.1*x + 3*y
     if withpit
@@ -22,15 +22,15 @@ dx = 0.01
 xs = -1.5:dx:1
 ys = -0.5:dx:3.0
 dem = ele.(xs, ys', randfac=0.1, withpit=true);
-plotyes && WWF.heatmap(xs, ys, dem)
+plotyes && WWF.plt.heatmap(xs, ys, dem)
 
 area, slen, dir, nout, nin, pits, c, bnds  = WWF.waterflows(dem, drain_pits=true);
 
 @assert size(dem)==(length(xs), length(ys))
-plotyes && WWF.plotit(xs, ys, dem)
-plotyes && WWF.plotarea(xs, ys, area, pits)
+plotyes && WWF.plt.plotit(xs, ys, dem)
+plotyes && WWF.plt.plotarea(xs, ys, area, pits)
 
-plotyes && WWF.heatmap(xs, ys, c)
+plotyes && WWF.plt.heatmap(xs, ys, c)
 
 demf = WWF.fill_dem(dem, pits, dir) #, small=1e-6)
-plotyes && WWF.heatmap(xs, ys, demf.-dem)
+plotyes && WWF.plt.heatmap(xs, ys, demf.-dem)

examples/subglacial-routing-feedback.jl

@@ -54,12 +54,12 @@ phi = rho_w*g*bed + flotation_fraction * g * rho_i * (surface - bed)
 
 # To track the amount of melted ice, we'll use three cellareas as inputs,
 # which in turns leads to three outputs in `area`:
-# - water discharge including extra melt
+# - water discharge due to source and extra melt
 # - water discharge due to extra melt only
 # - melt rate in m/s at each cell
 cellarea = (fill!(similar(surface), 0.1/day*dx*dx), # summer conditions: 10cm melt per day over the whole glacier
-            fill!(similar(surface), 0.0),
-            fill!(similar(surface), 0.0))
+            fill!(similar(surface), 0.0), # no source here
+            fill!(similar(surface), 0.0)) # no source here
 
 const phi_ = phi # make const for use in below function
 """
@@ -99,12 +99,12 @@ area, slen, dir, nout, nin, pits, c, bnds  = WWF.waterflows(phi, drain_pits=true
                                                             feedback_fn=melting)
 
 # Plot it
-plotyes && WWF.plotit(x, y, phi)
-plotyes && WWF.plotarea(x, y, area[1], pits)
-plotyes && WWF.plotarea(x, y, area[2], pits)
+plotyes && WWF.plt.plotit(x, y, phi)
+plotyes && WWF.plt.plotarea(x, y, area[1], pits)
+plotyes && WWF.plt.plotarea(x, y, area[2], pits)
 @show extrema(area[3])
 
-plotyes && WWF.heatmap(x, y, c)
+plotyes && WWF.plt.heatmap(x, y, c)
 
 phi_filled = WWF.fill_dem(phi, pits, dir) #, small=1e-6)
-plotyes && WWF.heatmap(x, y, phi_filled .- phi)
+plotyes && WWF.plt.heatmap(x, y, phi_filled .- phi)

examples/subglacial-routing.jl

@@ -49,10 +49,10 @@ phi = bed + flotation_fraction * rho_i/rho_w * (surface - bed)
 area, slen, dir, nout, nin, pits, c, bnds  = WWF.waterflows(phi, drain_pits=true)
 
 # Plot it
-plotyes && WWF.plotit(x, y, phi)
-plotyes && WWF.plotarea(x, y, area, pits)
+plotyes && WWF.plt.plotit(x, y, phi)
+plotyes && WWF.plt.plotarea(x, y, area, pits)
 
-plotyes && WWF.heatmap(x, y, c)
+plotyes && WWF.plt.heatmap(x, y, c)
 
 phi_filled = WWF.fill_dem(phi, pits, dir) #, small=1e-6)
-plotyes && WWF.heatmap(x, y, phi_filled .- phi)
+plotyes && WWF.plt.heatmap(x, y, phi_filled .- phi)

src/plotting.jl renamed to ext/PyPlotExt.jl

@@ -1,5 +1,16 @@
-using .PyPlot
-export plotarea, plotarea_dem
+module PyPlotExt
+# Some extension specific threads for my information:
+# - https://www.youtube.com/live/vG6ZLhe9Hns?si=7bPLZWqC-EB3AFzr&t=24578
+# - https://discourse.julialang.org/t/are-extension-packages-importable/92527/18
+# - https://discourse.julialang.org/t/package-extensions-structs-inside-extensions/101849
+# - https://github.com/JuliaLang/Pkg.jl/pull/3552
+
+
+using WhereTheWaterFlows
+const WWF=WhereTheWaterFlows
+using PyPlot
+
+export plotarea, plotarea_dem, plotit, plotdir, plotbnds, heatmap, plotlakedepth, plot_catchments
 
 """
     plotit(x, y, dem)
@@ -22,7 +33,7 @@ function plotit(x, y, waterflows_output::Tuple, dem)
 end
 
 function plotdir(x, y, dir)
-    vecfield = dir2vec.(dir)
+    vecfield = WWF.dir2vec.(dir)
     vecfieldx = [v[1] for v in vecfield]
     vecfieldy = [v[2] for v in vecfield]
     quiver(repeat(x,1, length(y)), repeat(y,length(x),1), vecfieldx, vecfieldy)
@@ -68,7 +79,7 @@ end
 
 function plotlakedepth(x, y, dem)
     area, slen, dir, nout, nin, pits  = waterflows(dem)
-    demf = fill_dem(dem, pits, dir)
+    demf = WWF.fill_dem(dem, pits, dir)
     heatmap(x, y, demf.-dem)
 end
 
@@ -99,3 +110,5 @@ function plot_catchments(x, y, c, lim=10)
     end
     heatmap(x,y,c)
 end
+
+end

src/WhereTheWaterFlows.jl

@@ -1,6 +1,6 @@
 module WhereTheWaterFlows
 
-using StaticArrays, Requires
+using StaticArrays
 
 export waterflows
 
@@ -286,7 +286,7 @@ function _flowrouting_catchments!(area, len, c, dir, cellarea, feedback_fn, colo
             slen = max(slen, slen_+1)
         end
     end
-    # feedback of areas with each other an onto themselves
+    # feedback of areas with each other and onto themselves
     if feedback_fn!==nothing
         uparea = feedback_fn(uparea, ij, dir)
     end
@@ -552,12 +552,35 @@ function _flow_from_to!(P1, P2, dir, nin, nout, allow_reversion=false)
 end
 
 
-## Plotting
-function __init__()
-    @require PyPlot="d330b81b-6aea-500a-939a-2ce795aea3ee" include("plotting.jl")
-end
-
 ## Post processing
 include("postproc.jl")
 
+## Plotting via Plt
+struct Plt end
+
+"""
+Plotting functions can be accessed via `plt` after loading PyPlot.
+
+Example
+```
+WhereTheWaterFlows.plt.plotit(dem)
+```
+"""
+plt = Plt()
+function Base.getproperty(::Plt, name::Symbol)
+    ext = Base.get_extension(@__MODULE__, :PyPlotExt)
+    if isnothing(ext)
+        error("Need to `using PyPlot` to make plotting available")
+    end
+    return getproperty(ext, name)
+end
+
+function Base.propertynames(::Plt)
+    ext = Base.get_extension(@__MODULE__, :PyPlotExt)
+    if isnothing(ext)
+        error("Need to `using PyPlot` to make plotting available")
+    end
+    return propertynames(ext)
+end
+
 end # module