search

ome / ome2024-ngff-challenge

Project planning and material repository for the 2024 challenge to generate 1 PB of OME-Zarr data
https://pypi.org/project/ome2024-ngff-challenge/
BSD 3-Clause "New" or "Revised" License
11 stars 8 forks source link

Updates to the README for release #36

Closed joshmoore closed 3 weeks ago

joshmoore commented 3 weeks ago

Preparing for a higher-versioned release so we can announce to the list. Last call for suggestions, requests, etc.

will-moore commented 3 weeks ago

One thing missing from the README is the default shard shape and potential issues..

E.g. Under "Optimizing chunks and shards":

Zarr v3 supports shards, which are files that contain multiple chunks. The shape of a shard must be a multiple of the chunk size in every dimension. There is not yet a single heuristic for determining the chunk and shard sizes that will work for all data. The default shard shape chosen by resave is the full shape of the image array. In order to limit the size of a shard, if the shard exceeds 100,000,000 pixels then you must specify the shard-shape. You can specify the shard shape, using --output-shards, which will be used for all pyramid resolutions. This may cause issues if the chunk shape changes for lower resolutions (to match the smaller image shape). In this case, you should also specify the chunk-shape to be used for all resolutions:

Feel free to reword as you wish...

joshmoore commented 3 weeks ago

Great, thanks. Moving forward with 1.0.0 to get the announcement out. Hold on to your boots.