broken example documentation

[lazarusA]

since #578 this example is now broken.

┌ Error: failed to run `@example` block in docs/src/UserGuide/compute.md:338-347
│ ```@example outdims
│ output_time = XOutput(yax_test.time)
│ output_flat = XOutput()
│ 
│ r1, r2, r3 = xmap(many_to_many, yax_test⊘:time, yax_2d, yax_test⊘"time",
│     output =(output_time, output_time, output_flat), inplace=true);
│ dsout = Dataset(many_to_many_two=r2)
│ 
│ compute_to_zarr(dsout, "test_mm.zarr", overwrite=true)
│ ```
│   exception =
│    KeyError: key nothing not found
│    Stacktrace:
│      [1] getindex(h::OrderedCollections.OrderedDict{Symbol, YAXArray}, key::Nothing)
│        @ OrderedCollections ~/.julia/packages/OrderedCollections/Xihhq/src/ordered_dict.jl:387
│      [2] (::YAXArrays.Xmap.var"#91#92"{DiskArrayEngine.ExecutionPlan{4, DiskArrayEngine.ProductArray{NTuple{4, UnitRange}, 4, NTuple{4, DiskArrays.RegularChunks}}}, Dataset, Dict{Int64, Int64}, Dict{Any, Any}})(oid::Int64, ospec::@NamedTuple{lw::DiskArrayEngine.LoopWindows{DiskArrayEngine.ProductArray{Tuple{Base.OneTo{Int64}, Int64, Int64, Int64}, 4, Tuple{DiskArrayEngine.Window{Base.OneTo{Int64}, Vector{Base.OneTo{Int64}}, DiskArrayEngine.Increasing, DiskArrayEngine.NonOverlapping, DiskArrayEngine.Dense}, Base.OneTo{Int64}, Base.OneTo{Int64}, Base.OneTo{Int64}}}, (1, 2, 3, 4)}, chunks::NTuple{4, Nothing}, ismem::Bool})
│        @ YAXArrays.Xmap ~/work/YAXArrays.jl/YAXArrays.jl/src/DAT/xmap.jl:655
│      [3] #Generator##0
│        @ ./generator.jl:37 [inlined]
│      [4] iterate
│        @ ./generator.jl:48 [inlined]
│      [5] collect(itr::Base.Generator{Base.Iterators.Zip{Tuple{Vector{Int64}, Tuple{@NamedTuple{lw::DiskArrayEngine.LoopWindows{DiskArrayEngine.ProductArray{Tuple{Base.OneTo{Int64}, Int64, Int64, Int64}, 4, Tuple{DiskArrayEngine.Window{Base.OneTo{Int64}, Vector{Base.OneTo{Int64}}, DiskArrayEngine.Increasing, DiskArrayEngine.NonOverlapping, DiskArrayEngine.Dense}, Base.OneTo{Int64}, Base.OneTo{Int64}, Base.OneTo{Int64}}}, (1, 2, 3, 4)}, chunks::NTuple{4, Nothing}, ismem::Bool}, @NamedTuple{lw::DiskArrayEngine.LoopWindows{DiskArrayEngine.ProductArray{Tuple{Base.OneTo{Int64}, Int64, Int64, Int64}, 4, Tuple{DiskArrayEngine.Window{Base.OneTo{Int64}, Vector{Base.OneTo{Int64}}, DiskArrayEngine.Increasing, DiskArrayEngine.NonOverlapping, DiskArrayEngine.Dense}, Base.OneTo{Int64}, Base.OneTo{Int64}, Base.OneTo{Int64}}}, (1, 2, 3, 4)}, chunks::NTuple{4, Nothing}, ismem::Bool}, @NamedTuple{lw::DiskArrayEngine.LoopWindows{DiskArrayEngine.ProductArray{NTuple{4, Int64}, 4, NTuple{4, Base.OneTo{Int64}}}, (1, 2, 3, 4)}, chunks::NTuple{4, Nothing}, ismem::Bool}}}}, Base.var"#Generator##0#Generator##1"{YAXArrays.Xmap.var"#91#92"{DiskArrayEngine.ExecutionPlan{4, DiskArrayEngine.ProductArray{NTuple{4, UnitRange}, 4, NTuple{4, DiskArrays.RegularChunks}}}, Dataset, Dict{Int64, Int64}, Dict{Any, Any}}}})
│        @ Base ./array.jl:790
│      [6] map(f::Function, it::Vector{Int64}, iters::Tuple{@NamedTuple{lw::DiskArrayEngine.LoopWindows{DiskArrayEngine.ProductArray{Tuple{Base.OneTo{Int64}, Int64, Int64, Int64}, 4, Tuple{DiskArrayEngine.Window{Base.OneTo{Int64}, Vector{Base.OneTo{Int64}}, DiskArrayEngine.Increasing, DiskArrayEngine.NonOverlapping, DiskArrayEngine.Dense}, Base.OneTo{Int64}, Base.OneTo{Int64}, Base.OneTo{Int64}}}, (1, 2, 3, 4)}, chunks::NTuple{4, Nothing}, ismem::Bool}, @NamedTuple{lw::DiskArrayEngine.LoopWindows{DiskArrayEngine.ProductArray{Tuple{Base.OneTo{Int64}, Int64, Int64, Int64}, 4, Tuple{DiskArrayEngine.Window{Base.OneTo{Int64}, Vector{Base.OneTo{Int64}}, DiskArrayEngine.Increasing, DiskArrayEngine.NonOverlapping, DiskArrayEngine.Dense}, Base.OneTo{Int64}, Base.OneTo{Int64}, Base.OneTo{Int64}}}, (1, 2, 3, 4)}, chunks::NTuple{4, Nothing}, ismem::Bool}, @NamedTuple{lw::DiskArrayEngine.LoopWindows{DiskArrayEngine.ProductArray{NTuple{4, Int64}, 4, NTuple{4, Base.OneTo{Int64}}}, (1, 2, 3, 4)}, chunks::NTuple{4, Nothing}, ismem::Bool}})
│        @ Base ./abstractarray.jl:3526
│      [7] (::YAXArrays.Xmap.var"#89#90"{Float64, Nothing, Dataset, Dict{Int64, Int64}, Dict{Any, Any}, DiskArrayEngine.MwopGraph})(conn::DiskArrayEngine.MwopConnection)
│        @ YAXArrays.Xmap ~/work/YAXArrays.jl/YAXArrays.jl/src/DAT/xmap.jl:641
│      [8] iterate
│        @ ./generator.jl:48 [inlined]
│      [9] _collect(c::Vector{Any}, itr::Base.Generator{Vector{Any}, YAXArrays.Xmap.var"#89#90"{Float64, Nothing, Dataset, Dict{Int64, Int64}, Dict{Any, Any}, DiskArrayEngine.MwopGraph}}, ::Base.EltypeUnknown, isz::Base.HasShape{1})
│        @ Base ./array.jl:810
│     [10] collect_similar(cont::Vector{Any}, itr::Base.Generator{Vector{Any}, YAXArrays.Xmap.var"#89#90"{Float64, Nothing, Dataset, Dict{Int64, Int64}, Dict{Any, Any}, DiskArrayEngine.MwopGraph}})
│        @ Base ./array.jl:732
│     [11] map(f::Function, A::Vector{Any})
│        @ Base ./abstractarray.jl:3372
│     [12] compute_to_zarr(ods::Dataset, path::String; max_cache::Float64, custom_loopranges::Nothing, overwrite::Bool)
│        @ YAXArrays.Xmap ~/work/YAXArrays.jl/YAXArrays.jl/src/DAT/xmap.jl:633
│     [13] top-level scope
│        @ compute.md:346
│     [14] eval(m::Module, e::Any)
│        @ Core ./boot.jl:489
│     [15] #61
│        @ ~/.julia/packages/Documenter/AXNMp/src/expander_pipeline.jl:879 [inlined]
│     [16] cd(f::Documenter.var"#61#62"{Module, Expr}, dir::String)
│        @ Base.Filesystem ./file.jl:112
│     [17] (::Documenter.var"#59#60"{Documenter.Page, Module, Expr})()
│        @ Documenter ~/.julia/packages/Documenter/AXNMp/src/expander_pipeline.jl:878
│     [18] (::IOCapture.var"#12#13"{Type{InterruptException}, Documenter.var"#59#60"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}})()
│        @ IOCapture ~/.julia/packages/IOCapture/MR051/src/IOCapture.jl:170
│     [19] with_logstate(f::IOCapture.var"#12#13"{Type{InterruptException}, Documenter.var"#59#60"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}}, logstate::Base.CoreLogging.LogState)
│        @ Base.CoreLogging ./logging/logging.jl:542
│     [20] with_logger(f::Function, logger::Base.CoreLogging.ConsoleLogger)
│        @ Base.CoreLogging ./logging/logging.jl:653
│     [21] capture(f::Documenter.var"#59#60"{Documenter.Page, Module, Expr}; rethrow::Type, color::Bool, passthrough::Bool, capture_buffer::IOBuffer, io_context::Vector{Any})
│        @ IOCapture ~/.julia/packages/IOCapture/MR051/src/IOCapture.jl:167
│     [22] runner(::Type{Documenter.Expanders.ExampleBlocks}, node::MarkdownAST.Node{Nothing}, page::Documenter.Page, doc::Documenter.Document)
│        @ Documenter ~/.julia/packages/Documenter/AXNMp/src/expander_pipeline.jl:877
└ @ Documenter ~/.julia/packages/Documenter/AXNMp/src/utilities/utilities.jl:47

[lazarusA]

full example:

using YAXArrays
using YAXArrays: YAXArrays as YAX
using Dates
using Zarr
using Random

axlist = (
    YAX.time(Date("2022-01-01"):Day(1):Date("2022-01-05")),
    lon(range(1, 4, length=4)),
    lat(range(1, 3, length=3)),
    Variables(["a", "b"])
)

Random.seed!(123)
data = rand(1:5, 5, 4, 3, 2)

properties = Dict("description" => "multi dimensional test cube")
yax_test = YAXArray(axlist, data, properties)

properties_2d = Dict("description" => "2d dimensional test cube")
yax_2d = YAXArray(axlist[2:end], rand(-1:1, 4, 3, 2), properties_2d)

f1(xin) = xin + 1
f2(xin) = xin + 2

function many_to_many(xout_one, xout_two, xout_flat, xin_one, xin_two, xin_drei)
    xout_one .= f1.(xin_one)
    xout_two .= f2mix.(xin_one, xin_two)
    xout_flat .= sum(xin_drei) # this will reduce the time dimension if we set outdims = OutDims()
    return nothing
end
f2mix(xin_xyt, xin_xy) = xin_xyt - xin_xy

output_time = XOutput(yax_test.time)
output_flat = XOutput()

r1, r2, r3 = xmap(many_to_many, yax_test⊘:time, yax_2d, yax_test⊘"time",
    output =(output_time, output_time, output_flat), inplace=true);
dsout = Dataset(many_to_many_two=r2)

compute_to_zarr(dsout, "test_mm.zarr", overwrite=true)

hopefully that's the only one broken and https://juliadatacubes.github.io/YAXArrays.jl/stable/UserGuide/compute.html#One-InDims-to-many-OutDims still works, I didn't see any failures on CI for that one.

[meggart]

This should be fixed by the linked PR. However, for the documentation, would it not make more sense to also write the other outputs to zarr? So something like dsout = Dataset(many_to_many_one = r1, many_to_many_two=r2, many_to_many_three=r3). One of the main benefits of YAXArrays is that you can compute multiple outputs at once without the need to load the input data multiple times.

[lazarusA]

yes, fair. We should update the example. At the time I guess that was just a quick way to test saving to zarr.

[lazarusA]

well, now main for this example is showing, https://github.com/JuliaDataCubes/YAXArrays.jl/actions/runs/23853413981/job/69539791472#step:7:276

exception =
│    MethodError: no method matching to_graph!(::DiskArrayEngine.MwopGraph, ::Array{Int64, 4})
│    The function `to_graph!` exists, but no method is defined for this combination of argument types.
│    
│    Closest candidates are:
│      to_graph!(::Any, ::DiskArrayEngine.GMWOPResult)
│       @ DiskArrayEngine ~/.julia/packages/DiskArrayEngine/9hxXG/src/graphs.jl:165
│      to_graph!(::Any, ::DiskArrayEngine.GMWOPResult, ::Any)
│       @ DiskArrayEngine ~/.julia/packages/DiskArrayEngine/9hxXG/src/graphs.jl:165

new error.