Overview

Packages
Package	Description
ch.systemsx.cisd.base.mdarray	This package provides an implementation of multi-dimensional numerical arrays in Java.
ch.systemsx.cisd.hdf5	Main package that contains the JHDF5 reader and writer.
ch.systemsx.cisd.hdf5.h5ar	This package contains the JHDF5 archiver.
ch.systemsx.cisd.hdf5.io	This package contains classes to access an HDF5 file like an Operating System file.
ncsa.hdf.hdf5lib.exceptions

HDF5 is an efficient, well-documented, non-proprietary binary data format and library developed and maintained by the HDF Group. JHDF5 is a high-level API in Java for reading and writing HDF5 files, building on the libraries provided by the HDF Group.

Classes to get started

In order to get started with the API, see the HDF5Factory class.

For simple standard use, have a look at IHDF5SimpleWriter interface for read-write access and the IHDF5SimpleReader interface for read-only access.

If you need to perform advanced operations, see the IHDF5Writer interface for read-write access and the IHDF5Reader interface for read-only access.

Examples

A simple use case is writing a float[] to an HDF5 file and reading it again:

    IHDF5SimpleWriter writer = HDF5Factory.open("myfile.h5");
    float[] mydata = new float[1000];
    ...<fill mydata>>...
    writer.write("mydata", f);
    writer.close()
    ...
    IHDF5SimpleReader reader = HDF5Factory.openForReading("myfile.h5");
    float[] mydata = reader.readFloatArray("mydata");
    ...<use mydata>...
    reader.close();

For a working minimal program, see this example.

JHDF5 14.12

Classes to get started

Examples

Other example programs: