Metadata-Version: 2.1
Name: vbz_h5py_plugin
Version: 1.0.0
Summary: Oxford Nanopore Technologies VBZ HDF plugin for h5py
Keywords: nanopore,h5py,vbz,pod5,fast5
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE.md

# VBZ-H5Py-Plugin

This module provides a plugin to H5Py for the VBZ (de)compression library.

## VBZ Compression

VBZ compression is a compression algorithm developed by Oxford Nanopore to reduce
file size and improve read/write performance when handling raw data in POD5/Fast5 files.
Previously, the default compression was GZIP and comparing to GZIP we see a
compression improvement of >30% and a CPU performance improvement of >10X for
compression and >5X for decompression. Further details of the implementation and
benchmarks can be found here: [Nanoporetech/vbz_compression](https://github.com/nanoporetech/vbz_compression)

# Usage

Simply import the module to register the vbz plugin with `h5py`.

``` python
import vbz_h5py_plugin
```
