Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto Apto para principiantes
#714 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
80/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
cli, documentation

Línea de trabajo

La guía se creará en doc/guides/b2nd_to_zarr.md. Comience examinando la guía existente doc/guides/parquet_to_blosc2.rst para ver su estructura y estilo. Revise la salida de ayuda y el código fuente de la herramienta CLI b2nd-to-zarr para comprender sus opciones. Escriba la guía con las secciones especificadas, incluyendo fragmentos ejecutables de shell y Python. Finalmente, agregue la nueva guía a doc/guides/index.rst en la sección 'Command line tools'.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
Python
Estrellas
211
Forks
63
Merge medio
1 d 9 min
PR fusionados (30 d)
7

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Blosc/python-blosc2

Todos los issues de Blosc/python-blosc2

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.