vcti-tree-exporter-hdf5 2.0.0

HDF5 exporter plugin for vcti-tree-exporter: writes a vcti tree to an .h5 file (groups, datasets, attributes).

HDF5 Tree Exporter

HDF5 exporter plugin for vcti-tree-exporter: writes a vcti tree to an .h5 file (groups, datasets, attributes).

HdfExporter serializes any vcti-tree tree whose node payloads are vcti-datanode DataNodes to a single HDF5 file. It satisfies the vcti.tree.exporter.core.Exporter protocol and ships a get_exporter_descriptor() factory, so a consumer registers it in a catalog and resolves it by id ("hdf5") or by attribute lookup.

Installation

pip install vcti-tree-exporter-hdf5

This pulls in vcti-tree-exporter (the protocol/catalog) and h5py.

Tree → HDF5 mapping

Tree node	HDF5 object
internal node (has children)	HDF5 group
data leaf (node.load() yields an array)	HDF5 dataset (plain or, for a structured array, compound)
metadata-only leaf (no data, no children)	HDF5 group with attributes
a node's node.name	the group/dataset name (falls back to node_<index>)
a node's node.attributes	HDF5 attributes on the group/dataset

A node's structural name comes from node.name (the vcti-datanode intrinsic), and its free-form node.attributes are written verbatim — intrinsic identity lives in its own namespace, so nothing needs filtering. NumPy Unicode (U<n>) fields inside a compound dtype are stored as h5py variable-length UTF-8 strings (h5py has no fixed-width Unicode in compound types). Attribute values are coerced for h5py (bytes decoded, numpy scalars via .item()); anything h5py can't store natively falls back to its str().

Usage

from pathlib import Path
from vcti.tree.exporter.core import build_registry, get_exporter
from vcti.tree.exporter.hdf5 import get_exporter_descriptor

registry = build_registry([get_exporter_descriptor()])   # plus any other format plugins
get_exporter(registry, "hdf5").export(tree, Path("model.h5"), overwrite=True)

Or use the exporter directly:

from vcti.tree.exporter.hdf5 import HdfExporter
HdfExporter().export(tree, Path("model.h5"))

Dependencies

• vcti-tree-exporter — the Exporter protocol and the ExporterDescriptor catalog.
• vcti-tree / vcti-datanode — the tree and payload types.
• h5py — the HDF5 backend.
• numpy.