broken sections

Author: lazarusA

docs/src/UserGuide/compute.md

@@ -84,7 +84,7 @@ Reduce the time dimension by calculating the average value of all points in time
 
 ````@example compute
 import Statistics: mean
-mapslices(mean, a, dims="Time")
+mapslices(mean, a, dims="time")
 ````
 There is no time dimension left, because there is only one value left after averaging all time steps.
 We can also calculate spatial means resulting in one value per time step:

docs/src/UserGuide/group.md

@@ -126,33 +126,39 @@ sum_days = sum.(g_tempo, dims=:time)
 
 Weight the seasonal groups by `sum_days`
 
-````@ansi compareXarray
+::: danger WIP
+
+DiskArrayEngine fails from here on...
+
+:::
+
+````julia compareXarray
 weights = map(./, g_tempo, sum_days)
 ````
 
 Verify that the sum per season is 1
 
-````@ansi compareXarray
+````julia compareXarray
 sum.(weights)
 ````
 ### weighted seasons
 
 Now, let's weight the seasons
 
-````@ansi compareXarray
+````julia compareXarray
 g_dsW = broadcast_dims.(*, weights, g_ds)
 ````
 
 apply a `sum` over the time dimension and drop it
 
-````@ansi compareXarray
+````julia compareXarray
 weighted_g = sum.(g_dsW, dims = :time);
 weighted_g = dropdims.(weighted_g, dims=:time)
 ````
 
 Calculate the differences
 
-````@ansi compareXarray
+````julia compareXarray
 diff_g = map(.-, weighted_g, mean_g)
 ````
 
@@ -164,7 +170,7 @@ mean_g, weighted_g, diff_g, seasons_g = weighted_seasons(ds)
 
 Once all calculations are done we can plot the results with `Makie.jl` as follows:
 
-````@example compareXarray
+````julia compareXarray
 using CairoMakie
 # define plot arguments/attributes
 colorrange = (-30,30)
@@ -174,7 +180,7 @@ lowclip = :grey15
 cb_label =  ds_o.properties["long_name"]
 ````
 
-````@example compareXarray
+````julia compareXarray
 with_theme(theme_ggplot2()) do
     hm_o, hm_d, hm_w = nothing, nothing, nothing
     # the figure

docs/src/UserGuide/read.md

@@ -139,7 +139,13 @@ savecube(a4, "a4.nc")
 
 ### along a new dimension
 
-````@example open_list_netcdf
+::: danger
+
+broken!
+
+:::
+
+````julia open_list_netcdf
 using YAXArrays, NetCDF, Dates
 using YAXArrays: YAXArrays as YAX
 import DimensionalData as DD
@@ -152,14 +158,14 @@ ds = open_mfdataset(DD.DimArray(files, YAX.time(dates_read)))
 
 and even opening files along a new `Time` dimension that already have a `time` dimension
 
-````@example open_list_netcdf
+````julia open_list_netcdf
 files = ["a3.nc", "a4.nc"]
 ds = open_mfdataset(DD.DimArray(files, YAX.Time(dates_read)))
 ````
 
 Note that opening along a new dimension name without specifying values also works; however, it defaults to `1:length(files)` for the dimension values.
 
-````@example open_list_netcdf
+````julia open_list_netcdf
 files = ["a1.nc", "a2.nc"]
 ds = open_mfdataset(DD.DimArray(files, YAX.time))
 ````
@@ -168,7 +174,7 @@ ds = open_mfdataset(DD.DimArray(files, YAX.time))
 
 Another use case is when we want to open files along an existing dimension. In this case, `open_mfdataset` will concatenate the paths along the specified dimension
 
-````@example open_list_netcdf
+````julia open_list_netcdf
 using YAXArrays, NetCDF, Dates
 using YAXArrays: YAXArrays as YAX
 import DimensionalData as DD
@@ -180,7 +186,7 @@ ds = open_mfdataset(DD.DimArray(files, YAX.time()))
 
 where the contents of the `time` dimension are the merged values from both files
 
-````@ansi open_list_netcdf
+````julia open_list_netcdf
 ds["time"]
 ````
 

docs/src/UserGuide/xcompute.md

@@ -86,7 +86,7 @@ Reduce the time dimension by calculating the average value of all points in time
 
 ````@example compute
 import Statistics: mean
-mapslices(mean, a, dims="Time")
+mapslices(mean, a, dims="time")
 ````
 There is no time dimension left, because there is only one value left after averaging all time steps.
 We can also calculate spatial means resulting in one value per time step:
@@ -143,7 +143,7 @@ Since `xmap` is operating in a lazy fashion, it can be directly used for follow-
 want to store the result to disk one can explicitly compute the result:
 
 ````@ansi mapCube
-gen_cube = compute_to_zarr(expanded_cube, "my_gen_cube.zarr", overwrite=true, max_cache=1e9)
+gen_cube = compute_to_zarr(Dataset(layer=r), "my_gen_cube.zarr", overwrite=true, max_cache=1e9)
 ````
 
 ::: info "time axis goes first"
@@ -199,10 +199,8 @@ end
 f1(xin) = xin + 1
 f2(xin) = xin + 2
 ````
-now, we define `InDims` and `OutDims`:
 
 ````@example outdims
-indims_one   = InDims("Time")
 # outputs dimension
 properties_one = Dict{String, Any}("name" => "plus_one")
 properties_two = Dict{String, Any}("name" => "plus_two")
@@ -213,16 +211,14 @@ output_flat = XOutput(;)
 ````
 
 ````@example outdims
-ds = mapCube(one_to_many, yax_test,
-    indims = indims_one,
-    outdims = (outdims_one, outdims_two, outdims_flat));
+ds = xmap(one_to_many, yax_test⊘:time, output = (output_one, output_two, output_flat));
 nothing # hide
 ````
 
 let's see the second output
 
 ````@example outdims
-ds[2]
+ds[2][:,1,1,1].data
 ````
 
 #### Many InDims to many OutDims
@@ -251,12 +247,17 @@ f2mix(xin_xyt, xin_xy) = xin_xyt - xin_xy
 ````@example outdims
 output_time = XOutput(yax_test.time)
 output_flat = XOutput()
-output = (output_time,output_time,output_flat)
 ````
 
 ````@example outdims
-ds = xmap(many_to_many, yax_test⊘:time, yax_2d, yax_test⊘:time,output = output);
-compute_to_zarr(Dataset(many_to_many_two=ds[2]),"test_mm.zarr",overwrite=true)
+r1, r2, r3 = xmap(many_to_many, yax_test⊘:time, yax_2d, yax_test⊘:time,
+    output = (output_time, output_time, output_flat), inplace=true);
+nothing # hide
+````
+
+````@example outdims
+dsout = Dataset(many_to_many_two=r2)
+compute_to_zarr(dsout, "test_mm.zarr", overwrite=true)
 nothing # hide
 ````
 

docs/src/api.md

@@ -10,12 +10,12 @@ end
 ```
 
 ```@autodocs
-Modules = [YAXArrays, YAXArrays.Cubes, YAXArrays.DAT, YAXArrays.Datasets,YAXArrays.YAXTools]
+Modules = [YAXArrays, YAXArrays.Cubes, YAXArrays.DAT, YAXArrays.Datasets, YAXArrays.YAXTools, YAXArrays.Xmap]
 Private = false
 ```
 
 ## Internal API
 ```@autodocs
-Modules = [YAXArrays, YAXArrays.Cubes, YAXArrays.DAT,YAXArrays.Datasets,YAXArrays.YAXTools]
+Modules = [YAXArrays, YAXArrays.Cubes, YAXArrays.DAT, YAXArrays.Datasets, YAXArrays.YAXTools, YAXArrays.Xmap]
 Public = false
 ```