Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
binary-ensemble
binary-ensemble

Getting started

  • Installation
  • Quickstart

Tutorials

  • Working with .bendl files
  • Plain BEN & XBEN streams

Quick Help

  • Overview
  • End-to-end workflow
  • API cookbook
  • Examples gallery
  • Anti-patterns
  • Compress a GerryChain run
  • Read and iterate an ensemble
  • Analyze an ensemble with NumPy and pandas
  • Subsample a large ensemble
  • Convert between formats
  • Shrink a bundle for sharing
  • Custom assets and appending
  • Troubleshooting
  • Error reference

Concepts

  • Overview
    • Vocabulary
    • The data contract
    • JSONL input schema
    • Formats: BEN vs XBEN vs BENDL
    • Encoding variants
    • Why reordering shrinks files
    • Graph ordering deep dive
    • Performance guide
    • The API map
    • Python and CLI parity
    • Limitations and invariants
    • Compatibility and stability
    • Release and versioning

API reference

  • Overview
    • binary_ensemble.bundle
    • binary_ensemble.stream
    • binary_ensemble.codec
    • binary_ensemble.graph

Project

  • Changelog
  • format stability
  • Rust crate source
  • GitHub
Back to top
Copyright © 2025, Peter Rock
Made with Sphinx and @pradyunsg's Furo