API reference

This page provides an overview of h5rdmtoolbox’s most important API classes and functions. For more details and examples, refer to the relevant chapters in the main part of the documentation.

Core Classes

The main wrapper classes that provide the enhanced HDF5 interface.

wrapper.core.File([name, mode, attrs])	Main wrapper around h5py.File.
wrapper.core.Dataset(_id)	Wrapper around the h5py.Dataset.
wrapper.core.Group(_id)	Inherited Group of the package h5py.

Conventions

Conventions allow you to define and enforce standardized attributes for your HDF5 files.

convention.core.Convention(*, name, contact)	Convention class
convention.core.use(convention_or_name)	Enable a convention.
convention.StandardAttribute(name, *, ...[, ...])	StandardAttribute class for the standardized attributes

Attributes

Attribute management for HDF5 objects.

wrapper.h5attr.Attribute(value, *[, ...])

Helper class for quick assignment of RDF attributes to the HDF5 file.

Database

Query HDF5 files directly or via MongoDB.

database.FileDB(filename)	A database interface for a single HDF5 file
database.FilesDB(filenames)	A database interface for multiple HDF5 files.

Repository

Upload and manage HDF5 files in online repositories.

repository.upload_file(repo, filename, **kwargs)

Upload a file to the repository.

Layout

Validate HDF5 file structure.

layout.Layout([description])

A layout is a collection of specifications that can be applied to an HDF5 file or group.

Linked Data

Work with RDF metadata in HDF5 files.

ld.shacl.validate_hdf(*[, hdf_data, ...])	Validate an HDF5 file against SHACL shapes.
ld.get_ld(hdf_filename[, structural, ...])	Return the HDF file content as an RDF graph.

Utilities

General utility functions.