Skip to content

silx-kit/hdf5plugin

Repository files navigation

hdf5plugin

hdf5plugin provides HDF5 compression filters (namely: Blosc, Blosc2, BitShuffle, BZip2, FciDecomp, LZ4, Sperr, SZ, SZ3, Zfp, ZStd) and makes them usable from h5py.

See documentation.

Installation

To install, run:

pip install hdf5plugin [--user]

or, with conda (https://anaconda.org/conda-forge/hdf5plugin):

conda install -c conda-forge hdf5plugin

To install from source and recompile the HDF5 plugins, run:

pip install hdf5plugin --no-binary hdf5plugin [--user]

Installing from source can achieve better performances by enabling AVX2 and OpenMP if available.

For more details, see the installation documentation.

How-to use

To use it, just use import hdf5plugin and supported compression filters are available from h5py.

For details, see Usage documentation.

License

The source code of hdf5plugin itself is licensed under the MIT license.

Embedded HDF5 compression filters are licensed under different open-source licenses: see the license documentation.