Welcome to hdf5pickle’s documentation!¶
Create easily interfaceable representations of Python objects in HDF5 files. The aim of this module is to provide both
- convenient Python object persistence
- compatibility with non-Python applications
Point 2 is useful, for example, if results from numerical calculations should be easily transferable for example to a non-Python visualization program. For example, if program state is serialized to a HDF5 file, it can easily be examined with for example Octave.
Example¶
>>> import numpy as np
>>> import hdf5pickle
>>> class A(object):
... def __init__(self):
... self.x = 100.0
... self.y = np.ones((1000000))
... self.z = [{'a': None}, A]
...
... def __str__(self):
... return 'x=%s, y=%s, z=%s' % (self.x, self.y, self.z)
>>> hdf5pickle.dump(A(), 'a.hdf5')
>>> print(hdf5pickle.load('a.hdf5'))
x=100.0, y=[ 1. 1. 1. ..., 1. 1. 1.], z=[{'a': None}, <class '__main__.A'>]
Functions¶
| dump | |
| load |