diff --git a/docs/package.json b/docs/package.json index 904caf08..5e224ff1 100644 --- a/docs/package.json +++ b/docs/package.json @@ -5,10 +5,13 @@ "docs:preview": "vitepress preview build/.documenter" }, "devDependencies": { - "markdown-it": "^14.0.0", "markdown-it-mathjax3": "^4.3.2", - "vitepress-plugin-tabs": "^0.5.0", + "rollup-plugin-delete": "^2.0.0", "vitepress": "^1.3.4", - "vitest": "^1.3.0" + "vitepress-plugin-tabs": "^0.5.0" + }, + "dependencies": { + "markdown-it": "^14.1.0", + "markdown-it-footnote": "^4.0.0" } -} +} \ No newline at end of file diff --git a/docs/src/index.md b/docs/src/index.md index e653fe1e..44526041 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -27,10 +27,60 @@ features: link: /UserGuide/read - title: Interoperability details: Well integrated with Julia's ecosystem, i.e., distributed operations are native. And plotting with Makie.jl is well supported. + link: /tutorials/plottingmaps - title: Named dimensions and GroupBy(in memory) details: Apply operations over named dimensions, select values by labels and integers as well as efficient split-apply-combine operations with groupby via DimensionalData.jl. link: /UserGuide/group - title: Efficiency details: Efficient mapslices(x) and mapCube operations on huge multiple arrays, optimized for high-latency data access (object storage, compressed datasets). link: /UserGuide/compute -``` \ No newline at end of file + +--- +``` + +## How to Install YAXArrays.jl? + +Since `YAXArrays.jl` is registered in the Julia General registry, you can simply run the following +command in the Julia REPL: + +```julia +julia> using Pkg +julia> Pkg.add("YAXArrays.jl") +# or +julia> ] # ']' should be pressed +pkg> add YAXArrays +``` + +If you want to use the latest unreleased version, you can run the following command: + +```julia +pkg> add YAXArrays#master +``` + +## Want interoperability? + +Install the following package(s) for: + +::: code-group + +```julia [ .tif ] +using Pkg +Pkg.add("ArchGDAL") +``` + +```julia [ .netcdf ] +using Pkg +Pkg.add("NetCDF") +``` + +```julia [ .zarr ] +using Pkg +Pkg.add("Zarr") +``` + +```julia [ plotting ] +using Pkg +Pkg.add(["GLMakie", "GeoMakie", "AlgebraOfGraphics", "DimensionalData"]) +``` + +::: \ No newline at end of file