Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
asinghvi17 committed Sep 11, 2024
1 parent 6c1f1eb commit ea000c4
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ This still relies on an experimental branch of Zarr.jl to read most Kerchunk fil

```julia
]
add Kerchunk Zarr#as/filters ZarrDatasets#as/dataset_from_store
add Kerchunk Zarr#as/filters https://github.com/asinghvi17/Rasters.jl#as/makie_and_cf
```

(clean up by running `]free Zarr ZarrDatasets Rasters`)

## Quick start

Kerchunk.jl is simply a storage backend to [`Zarr.jl`](https://github.com/JuliaIO/Zarr.jl). Zarr does integrate with the more fully featured packages [`Rasters.jl`](https://github.com/rafaqz/Rasters.jl) and [`YAXArrays.jl`](https://github.com/JuliaDataCubes/YAXArrays.jl), which are the packages you will want to use to interact with Kerchunk data.

```julia
using Kerchunk, Zarr

Expand All @@ -32,9 +36,10 @@ Rasters.RasterStack(
source = Rasters.Zarrsource(),
lazy = true, # need to include this
) # source must be explicit

```

It's most useful to open Kerchunk datasets as either RasterStacks or YAXArrays datasets, since both of those packages have great dimensionality support

## Background

[`kerchunk`](https://fsspec.github.io/kerchunk/) is a Python package that generates the reference catalogs.
Expand Down

0 comments on commit ea000c4

Please sign in to comment.