Python wrapper for the C-Blosc2 library

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for blosc from gravatar.com blosc Avatar for falted from gravatar.com falted Avatar for ivilata from gravatar.com ivilata

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: BSD License (BSD-3-Clause)

Author: Blosc Development Team

Maintainer: Blosc Development Team

Requires: Python <4, >=3.10

Classifiers

Project description

A Python wrapper for the extremely fast Blosc2 compression library

Author:

The Blosc development team

Contact:

blosc@blosc.org

Github:

https://github.com/Blosc/python-blosc2

Actions:

actions

PyPi:

version

NumFOCUS:

numfocus

Code of Conduct:

Contributor Covenant

What it is

C-Blosc2 is the new major version of C-Blosc, and is backward compatible with both the C-Blosc1 API and its in-memory format. Python-Blosc2 is a Python package that wraps C-Blosc2, the newest version of the Blosc compressor.

Currently Python-Blosc2 already reproduces the API of Python-Blosc, so it can be used as a drop-in replacement. However, there are a few exceptions for a full compatibility.

In addition, Python-Blosc2 aims to leverage the full C-Blosc2 functionality to support super-chunks (SChunk), multi-dimensional arrays (NDArray), metadata, serialization and other bells and whistles introduced in C-Blosc2.

Note: Python-Blosc2 is meant to be backward compatible with Python-Blosc data. That means that it can read data generated with Python-Blosc, but the opposite is not true (i.e. there is no forward compatibility).

SChunk: a 64-bit compressed store

A SChunk is a simple data container that handles setting, expanding and getting data and metadata. Contrarily to chunks, a super-chunk can update and resize the data that it contains, supports user metadata, and it does not have the 2 GB storage limitation.

Additionally, you can convert a SChunk into a contiguous, serialized buffer (aka cframe) and vice-versa; as a bonus, the serialization/deserialization process also works with NumPy arrays and PyTorch/TensorFlow tensors at a blazing speed:

Compression speed for different codecs

Decompression speed for different codecs

while reaching excellent compression ratios:

Compression ratio for different codecs

Also, if you are a Mac M1/M2 owner, make you a favor and use its native arm64 arch (yes, we are distributing Mac arm64 wheels too; you are welcome ;-):

Compression speed for different codecs on Apple M1

Decompression speed for different codecs on Apple M1

Read more about SChunk features in our blog entry at: https://www.blosc.org/posts/python-blosc2-improvements

NDArray: an N-Dimensional store

One of the latest and more exciting additions in Python-Blosc2 is the NDArray object. It can write and read n-dimensional datasets in an extremely efficient way thanks to a n-dim 2-level partitioning, allowing to slice and dice arbitrary large and compressed data in a more fine-grained way:

https://github.com/Blosc/python-blosc2/blob/main/images/b2nd-2level-parts.png?raw=true

To wet you appetite, here it is how the NDArray object performs on getting slices orthogonal to the different axis of a 4-dim dataset:

https://github.com/Blosc/python-blosc2/blob/main/images/Read-Partial-Slices-B2ND.png?raw=true

We have blogged about this: https://www.blosc.org/posts/blosc2-ndim-intro

We also have a ~2 min explanatory video on why slicing in a pineapple-style (aka double partition) is useful:

Slicing a dataset in pineapple-style

Installing

Blosc is now offering Python wheels for the main OS (Win, Mac and Linux) and platforms. You can install binary packages from PyPi using pip:

pip install blosc2

Documentation

The documentation is here:

https://blosc.org/python-blosc2/python-blosc2.html

Also, some examples are available on:

https://github.com/Blosc/python-blosc2/tree/main/examples

Building from sources

python-blosc2 comes with the C-Blosc2 sources with it and can be built in-place:

git clone https://github.com/Blosc/python-blosc2/
cd python-blosc2
git submodule update --init --recursive
python -m pip install -r requirements-build.txt
python setup.py build_ext --inplace

That’s all. You can proceed with testing section now.

Testing

After compiling, you can quickly check that the package is sane by running the tests:

python -m pip install -r requirements-tests.txt
python -m pytest  (add -v for verbose mode)

Benchmarking

If curious, you may want to run a small benchmark that compares a plain NumPy array copy against compression through different compressors in your Blosc build:

PYTHONPATH=. python bench/pack_compress.py

License

The software is licenses under a 3-Clause BSD license. A copy of the python-blosc2 license can be found in LICENSE.txt.

Mailing list

Discussion about this module is welcome in the Blosc list:

blosc@googlegroups.com

https://groups.google.es/group/blosc

Twitter

Please follow @Blosc2 to get informed about the latest developments.

Citing Blosc

You can cite our work on the different libraries under the Blosc umbrella as:

@ONLINE{blosc,
  author = {{Blosc Development Team}},
  title = "{A fast, compressed and persistent data store library}",
  year = {2009-2023},
  note = {https://blosc.org}
}

Enjoy!

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for blosc from gravatar.com blosc Avatar for falted from gravatar.com falted Avatar for ivilata from gravatar.com ivilata

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: BSD License (BSD-3-Clause)

Author: Blosc Development Team

Maintainer: Blosc Development Team

Requires: Python <4, >=3.10

Classifiers

Release history Release notifications | RSS feed

This version

2.6.2

2.6.1

2.6.0

2.5.1

2.5.0 yanked

Reason this release was yanked:

Introduced a dependency on blosc2-private.h

2.4.0

2.3.2

2.3.1

2.3.0 yanked

Reason this release was yanked:

Not working because AVX512

2.2.9

2.2.8

2.2.7

2.2.6

2.2.5

2.2.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.1

2.1.0

2.0.0

0.6.6

0.6.5

0.6.4

0.6.3

0.6.2

0.6.1

0.5.2

0.5.1

0.4.1

0.4.0

0.3.2

0.3.1

0.3.0

0.2.0

0.1.10

0.1.9

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

blosc2-2.6.2.tar.gz (5.1 MB view hashes)

Uploaded Source

Built Distributions

blosc2-2.6.2-cp312-cp312-win_amd64.whl (2.3 MB view hashes)

Uploaded CPython 3.12 Windows x86-64

blosc2-2.6.2-cp312-cp312-win32.whl (1.9 MB view hashes)

Uploaded CPython 3.12 Windows x86

blosc2-2.6.2-cp312-cp312-musllinux_1_1_x86_64.whl (4.5 MB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.1+ x86-64

blosc2-2.6.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.4 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

blosc2-2.6.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (4.2 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ ARM64

blosc2-2.6.2-cp312-cp312-macosx_11_0_arm64.whl (3.5 MB view hashes)

Uploaded CPython 3.12 macOS 11.0+ ARM64

blosc2-2.6.2-cp312-cp312-macosx_10_9_x86_64.whl (4.4 MB view hashes)

Uploaded CPython 3.12 macOS 10.9+ x86-64

blosc2-2.6.2-cp311-cp311-win_amd64.whl (2.3 MB view hashes)

Uploaded CPython 3.11 Windows x86-64

blosc2-2.6.2-cp311-cp311-win32.whl (2.0 MB view hashes)

Uploaded CPython 3.11 Windows x86

blosc2-2.6.2-cp311-cp311-musllinux_1_1_x86_64.whl (4.5 MB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ x86-64

blosc2-2.6.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.4 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

blosc2-2.6.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (4.2 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ ARM64

blosc2-2.6.2-cp311-cp311-macosx_11_0_arm64.whl (3.5 MB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

blosc2-2.6.2-cp311-cp311-macosx_10_9_x86_64.whl (4.4 MB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

blosc2-2.6.2-cp310-cp310-win_amd64.whl (2.3 MB view hashes)

Uploaded CPython 3.10 Windows x86-64

blosc2-2.6.2-cp310-cp310-win32.whl (2.0 MB view hashes)

Uploaded CPython 3.10 Windows x86

blosc2-2.6.2-cp310-cp310-musllinux_1_1_x86_64.whl (4.5 MB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ x86-64

blosc2-2.6.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.4 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

blosc2-2.6.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (4.2 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ ARM64

blosc2-2.6.2-cp310-cp310-macosx_11_0_arm64.whl (3.5 MB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

blosc2-2.6.2-cp310-cp310-macosx_10_9_x86_64.whl (4.4 MB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page