1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
hdf5plugin
==========
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7257761.svg
:target: https://doi.org/10.5281/zenodo.7257761
*hdf5plugin* provides `HDF5 compression filters <https://github.com/HDFGroup/hdf5_plugins/blob/master/docs/RegisteredFilterPlugins.md#list-of-filters-registered-with-the-hdf-group>`_ (namely: Blosc, Blosc2, BitShuffle, BZip2, FciDecomp, LZ4, Sperr, SZ, SZ3, Zfp, ZStd) and makes them usable from `h5py <https://www.h5py.org>`_.
See `documentation <http://www.silx.org/doc/hdf5plugin/latest/>`_.
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 <http://www.silx.org/doc/hdf5plugin/latest/install.html>`_.
How-to use
----------
To use it, just use ``import hdf5plugin`` and supported compression filters are available from `h5py <https://www.h5py.org>`_.
For details, see `Usage documentation <http://www.silx.org/doc/hdf5plugin/latest/usage.html>`_.
License
-------
The source code of *hdf5plugin* itself is licensed under the `MIT license <LICENSE>`_.
Embedded HDF5 compression filters are licensed under different open-source licenses:
see the `license documentation <http://www.silx.org/doc/hdf5plugin/latest/information.html#license>`_.
|
