Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.16 KB

README.md

File metadata and controls

37 lines (28 loc) · 1.16 KB
Pco logo: a pico-scale, compressed version of the Pyramid of Khafre in the palm of your hand

pypi.org

Pcodec Python API

Pcodec is a codec for numerical sequences. Example usage:

>>> from pcodec import standalone, ChunkConfig
>>> import numpy as np
>>> 
>>> np.random.seed(0)
>>> nums = np.random.normal(size=1000000)
>>> 
>>> # compress
>>> compressed = standalone.simple_compress(nums, ChunkConfig())
>>> print(f'compressed to {len(compressed)} bytes')
compressed to 6946258 bytes
>>> 
>>> # decompress
>>> recovered = standalone.simple_decompress(compressed)
>>> 
>>> np.testing.assert_array_equal(recovered, nums)

For pcodec's uses, design, and benchmarks, see the main repo.

At the moment, we don't have sphinx + a website set up, so run help(pcodec) (or whatever module name) in Python to read pcodec's documentation.