Skip to main content

h5py compatible client lib for HDF REST API

Project description

Python client library for HDF5 REST interface


This repository contains library, test, and examples of h5pyd - a Python package for the HDF REST interface.

The library is provides a high-level interface to the REST specification that is generally easier to use than invoking http calls directly.

The package is based on the popular h5py package and aims to be source compatible with the h5py high level interface.



Via pip:

pip install h5pyd

From a release tarball or Git checkout:

python install

By default the examples look for a local instance of h5serv. See the for instructions on installing and running h5serv.

These tests are also to designed to work with HSDS (see Install HSDS locally, or set environment variables (see next section) to point to an existing HSDS instance.


Setup the following environment variables that inform h5pyd which endpoint and username to use:

  • HS_ENDPOINT - “” for h5serv installed locally or appropriate remote endpoint
  • HS_USERNAME - “test_user1” or your preferred username
  • HS_PASSWORD - password for above username - “test” for test_user1 with local h5serv install
  • TEST2_USERNAME - “test_user2” or your preffered username
  • TEST2_PASSWORD - password for above username - “test” for test_user2 with local h5serv install
  • H5PYD_TEST_FOLDER - server folder that will be used for generated files. Use: “” for local h5serv install. For HSDS, posix-style paths are also supported, e.g.: /home/bob/h5pyd_test. For HSDS use hstouch command to create the folder before running the test, e.g.: $ hstouch /home/bob/h5pyd_test/

Run: $python to execute the test suite.


Just remove the install directory and all contents to uninstall.

Reporting bugs (and general feedback)

Create new issues at for any problems you find.

For general questions/feedback, please use the Kita forum (

Project details

Download files

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

Files for h5pyd, version 0.8.4
Filename, size File type Python version Upload date Hashes
Filename, size h5pyd-0.8.4.tar.gz (109.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page