Project information

Releases

Source code and pre-built binaries (aka Python wheels) for Windows, MacOS and ManyLinux are available at the following places:

• Wheels and source code on PyPi

• Packages on conda-forge

For the history of modifications, see the Changelog.

Project resources

• Source repository

• Issue tracker

hdf5plugin can be cited with its DOI: 10.5281/zenodo.7257761.

Presentations

• Presentation at the European HDF Users Group (HUG) Meeting 2023:

  • Presentation material (Notebook), Video EuHUG2023

  • Benchmark: script, display notebook

  • HDF5 compressed chunk direct read example (Notebook)

• Presentation at the European HDF Users Group (HUG) Meeting 2022:

  • Presentation material (Notebook), Video EuHUG2022

• Presentation at the European HDF Users Group (HUG) Summer 2021:

  • Presentation material (Notebook), Video EuHUG2021

HDF5 filters and compression libraries

HDF5 compression filters and compression libraries sources were obtained from:

• LZ4 plugin (commit 5573db8) using LZ4.

• bitshuffle plugin (v0.5.2) using LZ4 and ZStd.

• bzip2 plugin (from PyTables v3.10.2) using BZip2 (v1.0.8).

• hdf5-blosc plugin (v1.0.1) using c-blosc (v1.21.6), LZ4, Snappy, ZLib and ZStd.

• hdf5-blosc2 plugin (commit e4d0f58) using c-blosc2 (v3.1.4), LZ4, ZFP, ZLib and ZStd.

• FCIDECOMP plugin (v2.1.1) using CharLS (v2.1.0).

• SZ plugin (commit 308bd06) using SZ, ZLib and ZStd.

• H5Z-SPERR plugin (v0.2.3) using SPERR (v0.8.5).

• SZ3 plugin (commit 4bbe9df7e4bcb) using SZ3 and ZStd.

• HDF5-ZFP plugin (v1.1.1) using ZFP.

• ZStd plugin (commit 5573db8) using ZStd.

Sources of compression libraries shared accross multiple filters were obtained from:

• LZ4 v1.10.0

• Snappy v1.2.2

• ZFP v1.0.1

• ZStd v1.5.7

• ZLib v1.3.1

When compiled with Intel IPP, the LZ4 compression library is replaced with LZ4 v1.9.3 patched with a patch from Intel IPP 2021.7.0.

License

The source code of hdf5plugin itself is licensed under the MIT license. Use it at your own risk. See LICENSE.

The source code of the embedded HDF5 filter plugin libraries is licensed under different open-source licenses. Please read the different licenses:

• HDF5 compression filters:

  • bitshuffle: lib/bitshuffle/LICENSE

  • blosc: lib/hdf5-blosc/LICENSES/, lib/c-blosc/LICENSES/

  • blosc2: lib/PyTables/LICENSE.txt and lib/c-blosc2/LICENSES/

  • bzip2: lib/PyTables/LICENSE.txt and lib/bzip2/LICENSE

  • lz4: lib/LZ4/COPYING, lib/LZ4/LICENSE

  • FCIDECOMP: lib/fcidecomp/LICENSE and lib/charls/LICENSE.md

  • SPERR: lib/H5Z-SPERR/LICENSE and lib/SPERR/LICENSE

  • SZ: lib/SZ/copyright-and-BSD-license.txt

  • SZ3: lib/SZ3/copyright-and-BSD-license.txt

  • zfp: lib/H5Z-ZFP/LICENSE

  • zstd: lib/HDF5Plugin-Zstandard/LICENSE

• Shared compression libraries:

  • LZ4: lib/lz4-clib/LICENSE

  • Snappy: lib/snappy/COPYING

  • ZFP: lib/zfp/LICENSE

  • ZLib: lib/c-blosc/internal-complibs/zlib-1.3.1/LICENSE

  • ZStd: lib/zstd/LICENSE

The HDF5 v1.10.5 headers (and Windows .lib file) used to build the filters are stored for convenience in the repository. The license is available here: lib/hdf5/COPYING.