Skip to main content

Hdf5 validator package

Project description

H5 Validator - Validation tool for testing Fast5 files against the schema

ont_h5_validator is a simple tool for validating the structure of fast5 files against the file schema maintained by Oxford Nanopore Technologies

It provides:

  • Command line validation tools for validating fast5 files

  • Json format data schemas specifying the fast5 standard

NB The h5_validator is intended as a tool to validate the output of the latest MinKNOW-core. The schemas are currently intended to be restrictive and therefore additional fields (for example those added by albacore or guppy) will not be expected in the schema and flagged as invalid.

Getting Started

The ont_h5_validator is available on PyPI and can be installed via pip:

pip install ont-h5-validator

Alternatively it is available on github where it can be built from source:

git clone
cd ont_h5_validator
python install


ont_h5_validator is a pure python project and should run on most python versions and operating systems.

It requires:

Interface - Console Scripts

The ont_h5_validator provides a console script for validating fast5 files against a JSON schema. This script is added during installation of this project and can be called from the command line or from within python.


This script expects:

    schema <(path) json schema file (see note-1)>
    filename <(path) fast5 file>
    [optional] -v, --verbose <(bool) show additional verbose output; default=False>
    [optional] --debug <(bool) include additional debug logging; default=False>

note-1: if the schema file is not found on the path specified the script will additionally look in the default directory h5_validator/schemas/

example usage:

h5_validate multi_read_fast5.yaml /data/multi_read.fast5 -v

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ont-h5-validator-2.0.1.tar.gz (10.8 kB view hashes)

Uploaded Source

Built Distributions

ont_h5_validator-2.0.1-py3.4.egg (19.2 kB view hashes)

Uploaded Source

ont_h5_validator-2.0.1-py2.py3-none-any.whl (13.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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