Skip to content

Commit

Permalink
Update src/README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
aliddell committed Oct 26, 2023
1 parent 736201f commit 8d823a3
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

Expand Down

0 comments on commit 8d823a3

Please sign in to comment.