Metadata-Version: 2.4
Name: binary-ensemble
Version: 0.3.0
Requires-Dist: myst-nb>=1.3.0 ; extra == 'docs'
Requires-Dist: myst-parser>=4.0.1 ; extra == 'docs'
Requires-Dist: nbconvert>=7.16.6 ; extra == 'docs'
Requires-Dist: recommonmark>=0.7.1 ; extra == 'docs'
Requires-Dist: sphinx>=8.2.3 ; extra == 'docs'
Requires-Dist: sphinx-autoapi>=3.6.1 ; extra == 'docs'
Requires-Dist: sphinx-copybutton>=0.5.2 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme>=3.0.2 ; extra == 'docs'
Provides-Extra: docs
Summary: Python bindings for the Binary Ensemble Package.
Requires-Python: >=3.11
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

# Py-BEN

BEN (short for Binary-Ensemble) is a compression algorithm designed for efficient storage and access
of ensembles of districting plans, and was designed to work primarily as a companion to the
GerrySuite collection of packages (GerryChain, GerryTools, FRCW) and to also be compatible with
other ensemble generators (e.g. ForestRecom, Sequential Monte Carlo [SMC]).

This is a package containing some Python bindings for the for the
[Binary-Ensemble](https://crates.io/crates/binary-ensemble) Rust library. In particular, this
package provides some easy tools for compressing and decompressing ensembles of districting plans,
as well as some utilities for working with ensembles stored in the BEN and XBEN formats.

