Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[GUIDE] Walkthrough for `b2nd-to-zarr` CLI tool

Aperta Adatta ai principianti
#714 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
80/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
cli, documentation

Direzione di ricerca

La guida sarà creata in doc/guides/b2nd_to_zarr.md. Inizia esaminando la guida esistente doc/guides/parquet_to_blosc2.rst per struttura e stile. Rivedi l'output di aiuto e il codice sorgente dello strumento CLI b2nd-to-zarr per comprenderne le opzioni. Scrivi la guida con le sezioni specificate, includendo frammenti eseguibili di shell e Python. Infine, aggiungi la nuova guida a doc/guides/index.rst nella sezione 'Command line tools'.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation sustain-2026

b2nd_to_zarr is a robust CLI tool supporting Zarr v2 and v3, sharding (--sharded, --shards), custom chunk/codec mapping, memory buffer control (--buffer-size), and data integrity verification (--verify, --full-verify).

While parquet-to-blosc2 has a dedicated walkthrough guide in doc/guides/parquet_to_blosc2.rst, b2nd-to-zarr currently has no guide in doc/guides/ and is only mentioned in a single line within the installation docs.

Suggested Work

Create a new Markdown guide at doc/guides/b2nd_to_zarr.md (and add it to doc/guides/index.rst under Command line tools).

Cover the following steps with runnable shell and Python snippets:

  1. Prerequisites & Installation: Installing the [zarr] optional extra (pip install "blosc2[zarr]").
  2. Step 1 — Create a sample .b2nd array: A small Python snippet to generate a sample multidimensional array.
  3. Step 2 — Basic export to Zarr v3: Converting the file using b2nd-to-zarr sample.b2nd sample.zarr.
  4. Step 3 — Custom chunk layout & memory buffer: Overriding chunk shapes (--chunks) and controlling memory footprint with --buffer-size.
  5. Step 4 — Zarr v3 Sharding: Using --sharded to map Blosc2 chunks to Zarr shards and Blosc2 blocks to inner Zarr chunks.
  6. Step 5 — Codec and filter selection: Explicitly specifying codecs (--codec zstd, --clevel 5, --shuffle bitshuffle).
  7. Step 6 — Integrity verification: Checking data consistency with --verify and --full-verify.
  8. Cross-link with doc/guides/parquet_to_blosc2.rst and the Zarr source reference docs.
Lingua principale
Python
Stelle
211
Fork
63
Merge medio
1g 9m
PR unite (30g)
7

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Blosc/python-blosc2

Tutte le issue di Blosc/python-blosc2

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.