From 3bd5f827153b8891d75932171849f3c4959afa32 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Fri, 6 Sep 2024 05:22:25 +0000 Subject: [PATCH] build based on b105af9 --- dev/.documenter-siteinfo.json | 2 +- dev/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index c64c780..b30dd6f 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-06T00:26:39","documenter_version":"1.7.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-06T05:22:22","documenter_version":"1.7.0"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index 3d18b00..4e1bc47 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · Kerchunk.jl

Kerchunk

Documentation for Kerchunk.

Kerchunk._get_file_bytesFunction
_get_file_bytes(store::ReferenceStore, reference)

By hook or by crook, this function will return the bytes for the given reference. The reference could be a base64 encoded binary string, a path to a file, or a subrange of a file.

source
Kerchunk.apply_templatesMethod
apply_templates(store::ReferenceStore, source::String)

This function applies the templates stored in store to the source string, and returns the resolved string.

It uses Mustache.jl under the hood, but all {{template}} values are set to not URI-encode characters.

source
Kerchunk.materializeMethod
materialize(path, store::ReferenceStore)

Materialize a Zarr directory from a Kerchunk catalog. This actually downloads and writes the files to the given path, and you can open that with any Zarr reader.

source
Kerchunk.readbytesMethod
readbytes(path, start::Integer, stop::Integer)::Vector{UInt8}

Read bytes from a file at a given range.

source
Kerchunk.resolve_uriMethod
resolve_uri(store::ReferenceStore, source::String)

This function resolves a string which may or may not have templating to a URI.

source
+Home · Kerchunk.jl

Kerchunk

Documentation for Kerchunk.

Kerchunk._get_file_bytesFunction
_get_file_bytes(store::ReferenceStore, reference)

By hook or by crook, this function will return the bytes for the given reference. The reference could be a base64 encoded binary string, a path to a file, or a subrange of a file.

source
Kerchunk.apply_templatesMethod
apply_templates(store::ReferenceStore, source::String)

This function applies the templates stored in store to the source string, and returns the resolved string.

It uses Mustache.jl under the hood, but all {{template}} values are set to not URI-encode characters.

source
Kerchunk.materializeMethod
materialize(path, store::ReferenceStore)

Materialize a Zarr directory from a Kerchunk catalog. This actually downloads and writes the files to the given path, and you can open that with any Zarr reader.

source
Kerchunk.readbytesMethod
readbytes(path, start::Integer, stop::Integer)::Vector{UInt8}

Read bytes from a file at a given range.

source
Kerchunk.resolve_uriMethod
resolve_uri(store::ReferenceStore, source::String)

This function resolves a string which may or may not have templating to a URI.

source