Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 1.61 KB

index.rst

File metadata and controls

52 lines (39 loc) · 1.61 KB

Welcome to h5preserve's documentation!

:pyh5preserve is a wrapper around h5py and hdf5, providing easier serialisation of native python types. Its design is inspired by Camel, and follows its philosophy.

Why use h5preserve?

The purpose of :pyh5preserve is to provide a simple serialisation library to hdf5 files. Hence :pyh5preserve has support for complex numerical data, multidimensional arrays etc., which other serialisation formats may not represent as effectively. :pyh5preserve makes it easy to split out the interaction with hdf5 files from the main logic of your code. Since :pyh5preserve is designed to hide the underlying hdf5 file, large files where memory usage is a concern do not work well with :pyh5preserve. In this case, :pyh5preserve provides easy access to the underlying h5py objects, or you may want to look at using pytables, which provides a more database-like interface to hdf5 files.

Why the name?

The name comes from the "h5" label associated with hdf5, and the idea of preserving or pickling data.

Contents:

Quickstart Installation Usage Reference Contributing

Indices and tables

  • genindex
  • modindex
  • search