Skip to content

Repository files navigation

tszip

LicensePyPI versionSupported Python VersionsDocs BuildTestscodecov

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:

importtskitimporttszipts=tskit.load("data.trees")
tszip.compress(ts, "data.trees.tsz") # write compressed archive# load handles .tsz archives and plain .trees filesrestored=tszip.load("data.trees.tsz")
print(restored.equals(ts)) # True

About

Gzip-like compression for tskit tree sequences

Topics

Resources

Code of conduct

Stars

5 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages