API reference

This page provides an auto-generated summary of h5rdmtoolbox’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

Base wrapper class

h5rdmtoolbox.wrapper.core.File([name, mode, ...])	Main wrapper around h5py.File.
h5rdmtoolbox.wrapper.core.Dataset(_id)	Wrapper around the h5py.Dataset.
h5rdmtoolbox.wrapper.core.Group(_id)	Inherited Group of the package h5py.
h5rdmtoolbox.wrapper.core.Group.create_from_yaml(...)	creates groups, datasets and attributes defined in a yaml file.

Conventions

Layouts

h5rdmtoolbox.layout.core.LayoutSpecification(...)	Specification for a layout
h5rdmtoolbox.layout.core.Layout()	A layout is a collection of specifications that can be applied to an HDF5 file or group.

Standard attributes

h5rdmtoolbox.convention.StandardAttribute(...)	StandardAttribute class for the standardized attributes
h5rdmtoolbox.convention.StandardAttribute.get(parent)	Read the attribute from parent
h5rdmtoolbox.convention.StandardAttribute.set(...)	Write value to attribute of parent

Standard names and tables

h5rdmtoolbox.convention.standard_names.name.StandardName(name)	Standard Name class
h5rdmtoolbox.convention.standard_names.table.StandardNameTable(...)	Standard Name Table (SNT) class
h5rdmtoolbox.convention.standard_names.table.StandardNameTable.from_web(url)	Create a StandardNameTable from an online resource.
h5rdmtoolbox.convention.standard_names.table.StandardNameTable.from_yaml(...)	Initialize a StandardNameTable from a YAML file
h5rdmtoolbox.convention.standard_names.table.StandardNameTable.from_xml(...)	Create a StandardNameTable from an xml file
h5rdmtoolbox.convention.standard_names.table.StandardNameTable.from_zenodo(...)	Download a standard name table from Zenodo based on its DOI.