Project information

Releases

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

For the history of modifications, see the Changelog.

Project resources

Source repository
Issue tracker
Continuous integration: hdf5plugin is continuously tested on all three major operating systems:
- Linux, MacOS, Windows: GitHub Actions
- Windows: AppVeyor
Weekly builds

hdf5plugin can be cited with its Zenodo DOI.

Presentations

Presentation at the European HDF Users Group (HUG) Meeting 2022:
- Presentation material (Notebook), Video
Presentation at the European HDF Users Group (HUG) Summer 2021:
- Presentation material (Notebook), Video

HDF5 filters and compression libraries

HDF5 compression filters and compression libraries sources were obtained from:

LZ4 plugin (commit d48f960) using LZ4.
bitshuffle plugin (v0.5.1) using LZ4 and ZStd.
bzip2 plugin (from PyTables v3.8.0) using BZip2 (v1.0.8).
hdf5-blosc plugin (v1.0.0) using c-blosc (v1.21.5), LZ4, Snappy, ZLib and ZStd.
hdf5-blosc2 plugin (from PyTables v3.8.0) using c-blosc2 (v2.10.2), LZ4, ZLib and ZStd.
FCIDECOMP plugin (v1.0.2) using CharLS (1.x branch, commit 25160a4).
SZ plugin (commit c25805c12b3) using SZ, ZLib and ZStd.
SZ3 plugin (commit 4bbe9df7e4bcb) using SZ3 and ZStd.
HDF5-ZFP plugin (v1.1.1) using zfp (v1.0.0).
HDF5Plugin-Zstandard (commit d5afdb5) using ZStd.

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

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:

bitshuffle: See src/bitshuffle/LICENSE
blosc: See src/hdf5-blosc/LICENSES/, src/c-blosc/LICENSES/ and src/snappy/COPYING
blosc2: See src/PyTables/LICENSE.txt and src/c-blosc2/LICENSES/
bzip2: See src/PyTables/LICENSE.txt and src/bzip2/LICENSE
lz4: See src/LZ4/COPYING, src/LZ4/LICENSE and src/c-blosc/LICENSES/LZ4.txt
FCIDECOMP: See src/fcidecomp/LICENSE and src/charls/src/License.txt
SZ: See src/SZ/copyright-and-BSD-license.txt
SZ3: See src/SZ3/copyright-and-BSD-license.txt
zfp: See src/H5Z-ZFP/LICENSE and src/zfp/LICENSE
zstd: See src/HDF5Plugin-Zstandard/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: src/hdf5/COPYING.