From 8d823a3cb2f41c0a89964978a0def34f81fd5073 Mon Sep 17 00:00:00 2001 From: Alan Liddell Date: Thu, 26 Oct 2023 11:43:57 -0400 Subject: [PATCH] Update src/README.md. --- src/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/README.md b/src/README.md index 7a9fba97..b1a7067c 100644 --- a/src/README.md +++ b/src/README.md @@ -26,6 +26,13 @@ Implements abstract methods for writer allocation and metadata. Specifically, `ZarrV2` allocates one writer of type `ChunkWriter` for each multiscale level-of-detail and writes metadata in the format specified by the [Zarr V2 spec](https://zarr.readthedocs.io/en/stable/spec/v2.html). +### The `ZarrV3` class + +Subclass of the `Zarr` class. +Implements abstract methods for writer allocation and metadata. +Specifically, `ZarrV3` allocates one writer of type `ShardWriter` for each multiscale level-of-detail +and writes metadata in the format specified by the [Zarr V3 spec](https://zarr-specs.readthedocs.io/en/latest/specs.html). + ### The `Writer` class An abstract class that writes frames to the filesystem or other storage layer. @@ -36,6 +43,15 @@ The `Writer` handles chunking, chunk compression, and writing. Subclass of the `Writer` class. Implements abstract methods relating to writing and flushing chunk buffers. +Chunk buffers, whether raw or compressed, are written to individual chunk files. + +### The `ShardWriter` class + +Subclass of the `Writer` class. +Implements abstract methods relating to writing, sharding, and flushing chunk buffers. +Chunk buffers, whether raw or compressed, are concatenated into shards, which are written out to individual shard files. + + ### The `BloscCompressionParams` struct