Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

[DOC] Container Architecture & Chunking Sizing Guide (Decision Matrix)

Offen
  • Stimmt etwas nicht?
#722 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 2 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
70/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
markdown, python
Bereich
documentation

Rechercherichtung

The guide will be a new Markdown file at doc/getting_started/choosing_containers_and_chunking.md. Start by reading the existing doc/getting_started/index.rst to understand the documentation structure and the linked issue #651 for terminology. Review the project's README and the main documentation to understand the different container types (NDArray, CTable, etc.) and their use cases. The guide should include a decision matrix table and chunking guidelines. Done looks like a complete Markdown file that is linked from the index.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation sustain-2026

New contributors and users face two key architectural questions when getting started:

  1. Which container should I choose? (NDArray vs CTable vs SChunk vs TreeStore vs DictStore vs BatchArray).
  2. How do I choose chunk and block shapes? (Balancing compression ratio, CPU cache locality, slicing granularity, and storage overhead).

While issue #651 addresses a terminology glossary, there is no practical decision matrix or chunking rules-of-thumb guide in the documentation.

Suggested Work

Create a Markdown guide at doc/getting_started/choosing_containers_and_chunking.md (and link it from doc/getting_started/index.rst).

The guide should feature:

  1. Container Decision Matrix: A structured table comparing:
    • Data Geometry (multidimensional, tabular/relational, key-value, hierarchical tree)
    • Read/write mutability and append performance
    • Query capabilities (expression evaluation, SQL/where filtering, coordinate slicing)
    • On-disk layout (.b2nd, .b2frame, .b2z, .b2d)
  2. Chunking vs. Blocking Rules of Thumb:
    • Clear explanation of the two-level chunking hierarchy: chunks represent disk/network transfer units (typically 1 MB – 64 MB), whereas blocks represent CPU cache units (typically 64 KB – 1 MB to fit L2/L3 caches).
    • Practical guidelines for 1D, 2D, and 3D data geometries.
    • Trade-offs: large chunks (better compression) vs. small chunks (faster random slicing).
Vorherrschende Sprache
Python
Sterne
212
Forks
66
Ø Merge
2 T. 3 Std.
Gemergte PRs (30 T.)
10

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Blosc/python-blosc2

Alle Issues in Blosc/python-blosc2

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.