[Documentation]: Add tutorial for S3 streaming

hdmf-dev / hdmf-zarr

Zarr I/O backend for HDMF

https://hdmf-zarr.readthedocs.io/

Other

7 stars 7 forks source link

[Documentation]: Add tutorial for S3 streaming #140

Open oruebel opened 9 months ago

oruebel commented 9 months ago

What would you like changed or added to the documentation and why?

See https://github.com/hdmf-dev/hdmf-zarr/pull/138

Add a tutorial for streaming NWB data from S3

Do you have any interest in helping write or edit the documentation?

Yes.

Code of Conduct

[X] I agree to follow this project's Code of Conduct
[X] Have you checked the Contributing document?
[X] Have you ensured this change was not already requested?

oruebel commented 9 months ago

https://github.com/hdmf-dev/hdmf-zarr/pull/142/ added consolidation of metadata. We should mention this here why this is important for S3 and also mention how a user can generate/update consolidated metadata for a Zarr file via zarr.consolidate_metadata(store, metadata_key='.zmetadata')