Debian Codegraph @

doc/index.rst

raw
1 hdf5plugin
2 ==========
3
4 *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>`_.
5
6
7 * Supported operating systems: Linux, Windows, macOS.
8 * Supported versions of Python: >= 3.8
9 * Supported architectures: All.
10 Specific optimizations are available for *x86* family, *arm64* and *ppc64le*.
11
12 *hdf5plugin* provides a generic way to enable the use of the provided HDF5 compression filters with `h5py` that can be installed via `pip` or `conda`.
13
14 Alternatives to install HDF5 compression filters are: system-wide installation on Linux or other conda packages: `blosc-hdf5-plugin <https://anaconda.org/conda-forge/blosc-hdf5-plugin>`_, `hdf5-lz4 <https://anaconda.org/nsls2forge/hdf5-lz4>`_.
15
16 :doc:`install`
17 How-to install *hdf5plugin*
18
19 :doc:`usage`
20 How-to use *hdf5plugin*
21
22 :doc:`information`
23 Releases, changelog, repository, license
24
25 :doc:`contribute`
26 How-to contribute to *hdf5plugin*
27
28 .. toctree::
29 :hidden:
30
31 install.rst
32 usage.rst
33 information.rst
34 contribute.rst
35 changelog.rst
36
37 :ref:`genindex`