Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở Phù hợp với người mới
#714 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
80/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Hướng dẫn sẽ được tạo tại doc/guides/b2nd_to_zarr.md. Bắt đầu bằng cách kiểm tra hướng dẫn hiện có doc/guides/parquet_to_blosc2.rst về cấu trúc và phong cách. Xem xét đầu ra trợ giúp và mã nguồn của công cụ CLI b2nd-to-zarr để hiểu các tùy chọn của nó. Viết hướng dẫn với các phần được chỉ định, bao gồm các đoạn mã shell và Python có thể chạy được. Cuối cùng, thêm hướng dẫn mới vào doc/guides/index.rst trong phần 'Command line tools'.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
Python
Star
211
Fork
63
Merge trung bình
1 ngày 9 phút
Pull request đã merge (30 ngày)
7

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Blosc/python-blosc2

Tất cả issue của Blosc/python-blosc2

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.