Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#714 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
80/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
python
Domaine
cli, documentation

Piste de recherche

Le guide sera créé à l'emplacement doc/guides/b2nd_to_zarr.md. Commencez par examiner le guide existant doc/guides/parquet_to_blosc2.rst pour sa structure et son style. Consultez la sortie d'aide et le code source de l'outil CLI b2nd-to-zarr pour comprendre ses options. Rédigez le guide avec les sections spécifiées, en incluant des extraits exécutables en shell et Python. Enfin, ajoutez le nouveau guide dans doc/guides/index.rst sous la section 'Command line tools'.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.
Langage dominant
Python
Étoiles
212
Forks
66
Merge moyen
1 j 21 h
PR mergées (30 j)
10

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de Blosc/python-blosc2

Toutes les issues de Blosc/python-blosc2

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.