tszip 0.3.1

Compression utilities for tree sequences

tszip

Gzip-like compression for tskit tree sequences. Compression is lossless for supported tskit tree sequences.

Please see the documentation (latest) for more details and installation instructions.

Installation

Install from PyPI or conda-forge:

python -m pip install tszip
# or
conda install -c conda-forge tszip

Quickstart

CLI usage:

# Compress a .trees file to a .tsz archive
tszip data.trees

# Decompress back to .trees
tsunzip data.trees.tsz

Along with the CLI, tszip can be used directly from Python:

import tskit
import tszip

ts = tskit.load("data.trees")
tszip.compress(ts, "data.trees.tsz")  # write compressed archive

# load handles .tsz archives and plain .trees files
restored = tszip.load("data.trees.tsz")
print(restored.equals(ts))  # True