Skip to main content
2025 Python Packaging Survey is now live!  Take the survey now

HDF5 Plugins for windows,MacOS and linux

Project description

This module provides HDF5 plugins and sets the HDF5_PLUGIN_PATH to the appropriate value according to the version of python used.

The module is mainly intended for use under windows but shared libraries for MacOS and manylinux are also provided.

The LZ4 plugin sources were obtained from https://github.com/nexusformat/HDF5-External-Filter-Plugins

The bitshuffle plugin sources were obtained from https://github.com/kiyo-masui/bitshuffle

Known issues

Under MacOS and linux, the bitshuffle plugin is limited to decompression (i.e. it can be used to read bitshuffle compressed data).

Installation

To install, just run:

pip install hdf5plugin

To install locally, run:

pip install hdf5plugin --user

Dependencies

No additional dependencies.

Documentation

To use it, just ‘’import hdf5plugin’’ before importing h5py or PyTables.

License

This code is licensed under the MIT license. Use it at your own risk.

The source code of the libraries is licensed under MIT (bitshuffle) and BSD like licenses (LZ4).

Please read the LICENSE_H5bshuf and LICENSE_H5Zlz4 respectively for details.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page