Welcome to the h5py_wrapper

This is the documentation of the h5py_wrapper.

Introduction

API reference

API reference

Supported data types

Supported data types

The wrapper stores the original data types of values of the dictionary in the produced hdf5 file. The following data types are supported:

  • float

  • int

  • str

  • tuple

  • numpy.array

  • numpy.int64 and numpy.float64

  • list

  • bool

  • quantities.Quantity (see https://pypi.python.org/pypi/quantities)

  • Lists, tuples and numpy.arrays up to arbitrary depths if all dimensions are uniform, e.g.

    l = numpy.ones((3,3,3))
    
  • Lists and tuples are required to contain the contain equal data types across one dimension. For instance, this raises an error

    l = [[1,2], 'a']
    
  • Lists, tuples and numpy.arrays with unequal dimensions with maximal depth 1.

    l = [[1,2], [1]]
    

Conversion from old releases

Conversion from old release versions

Release version 1.0.1 introduced some changes to the file format (see Release notes).

Conversion script to convert files from a previous
release version to the current version.

Usage: convert_h5file [-h|--help] [<files>...] [--save-backup] [-v|--verbose] [--release=<version>]

Options:
    <files>  List of files to be converted, can be a file pattern
    --save-backup  save backup version of file in old file format [default: False].
    --release=<version>   release version used to create the file to be converted [default: 0.0.1]
    -v, --verbose  print informative output to screen
    -h, --help     print this text

Release Notes

Indices and tables