sequince.utils.hdf5
===================

.. py:module:: sequince.utils.hdf5

.. autoapi-nested-parse::

   HDF5 storage and logical-schema helpers for Sequince.



Attributes
----------

.. autoapisummary::

   sequince.utils.hdf5.SCHEMA_VERSION
   sequince.utils.hdf5.KIND_KEY
   sequince.utils.hdf5.SCHEMA_KEY
   sequince.utils.hdf5.VERSION_KEY


Functions
---------

.. autoapisummary::

   sequince.utils.hdf5.schema_header
   sequince.utils.hdf5.validate_schema
   sequince.utils.hdf5.nested
   sequince.utils.hdf5.recursively_save_to_h5_file
   sequince.utils.hdf5.load_from_h5_file


Module Contents
---------------

.. py:data:: SCHEMA_VERSION
   :value: 1


.. py:data:: KIND_KEY
   :value: '_sequince_kind'


.. py:data:: SCHEMA_KEY
   :value: '_sequince_schema_version'


.. py:data:: VERSION_KEY
   :value: '_sequince_version'


.. py:function:: schema_header(kind, *, include_version = True)

   Build the common logical header for a Sequince HDF5 payload.


.. py:function:: validate_schema(payload, *, kinds, required, optional = frozenset())

   Validate the common header and fields of a logical HDF5 payload.


.. py:function:: nested(payload)

   Remove root-only producer information from a nested domain payload.


.. py:function:: recursively_save_to_h5_file(h5_file_or_group, path, dictionary)

   Save a portable mapping below an open HDF5 file or group.


.. py:function:: load_from_h5_file(h5_file_or_group, path)

   Load a portable mapping below an open HDF5 file or group.