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

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.
wrapper.core.Group.create_from_yaml(...[, ...])	creates groups, datasets and attributes defined in a yaml file.

Standard attributes

convention.StandardAttribute(name, *, ...[, ...])	StandardAttribute class for the standardized attributes
convention.StandardAttribute.get(parent)	Read the attribute from parent
convention.StandardAttribute.set(parent, value)	Write value to attribute of parent

Standard names and tables

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